What It Does

With Inline Help, you can:

• Define helpful descriptions per field via GUI
• Display guidance below or beside form elements
• Add tooltips to labels using Joomla’s built-in tooltip classes
• Link to external documentation or tutorials
• Improve onboarding and reduce support requests

It turns your component’s backend into a friendly, guided experience.

How to Use It in JCB

• Open any Admin View or Field entity
• Locate the “Description” or “Tooltip” field
• Add your help text:
  • Basic HTML is supported (e.g. <a>, <strong>, <em>)
  • Markdown is rendered when supported
  • Use language strings for multilingual support
• This content is rendered automatically in the generated Joomla form XML and displayed in edit or config screens.

Examples

📝 Basic Description
This field controls how long an item remains active before auto-expiring.

🔗 With External Link
Need help? Click here to learn more.

💬 Tooltip Only
For tooltips (hover over label), use the “Tooltip” field instead of the main description.

Where It Appears

• Admin View edit forms
• Site View forms (frontend editable forms)
• Configuration panels (config.xml)
• Custom Admin Views if tied to fields
• Joomla fieldset intros and section headers

Best Practices

• Use short, actionable sentences
• Add context-specific examples
• Avoid technical jargon unless your users are developers
• Keep tooltips concise — use full descriptions for more complex guidance
• Prefer language constants for future translatability

Versioning and Reuse

Inline help is stored as part of the field/view metadata, so it:

• Round-trips through compiles
• Can be reused via shared field types
• Can be updated centrally if managed in a repository

Summary

Inline Help Descriptions in JCB allow you to attach explanatory text, tooltips, or hints to individual fields, sections, or entire views. This makes your component easier to use, more intuitive, and self-documenting — especially for clients or collaborators unfamiliar with Joomla’s backend.