Help

The Help screen is the built-in JEM help center inside the Joomla administrator. It opens local help pages installed with the JEM package and links to the online JEM documentation, support forum, downloads, contribution information, credits, and license information.

The Help screen is useful for quick backend reference. For the most current and expanded documentation, use the online manual links shown inside the help pages.

Where to Find This Screen

Open the Joomla administrator and go to ComponentsJEMHelp. The screen is also available from the JEM control panel.

Many JEM backend screens also include a toolbar Help button. Those buttons open the help page or online documentation related to the current screen.

How the Help Screen Is Organized

The Help screen has a search field, quick links, a list of available help screens, and an iframe that displays the selected help page.

AreaPurpose
Search Filters local help pages by matching text in the installed help files.
Quick links Open Introduction, Documentation map, Get Help, Contribute, Credits, and License.
Screen Help Lists installed local help pages by title.
Help frame Displays the selected local help file without leaving the JEM Help screen.

Local Help Files

JEM includes local HTML help files under administrator/components/com_jem/help. The Help screen detects the active Joomla administrator language and looks for matching help files.

  • If help files exist for the current administrator language, JEM uses them.
  • If no matching help folder exists, JEM falls back to English (en-GB).
  • The local table of contents is built from the titles of installed help files.
  • The search field filters local help files by their text content.
Local help files are packaged with JEM. They may be shorter than the online documentation, especially after new features are added.

Quick Links

The top of the Help screen contains quick links for common support and documentation areas.

LinkUse it for
Home Opens the JEM introduction and quickstart help page.
Documentation map Shows a local overview that links backend, frontend, module, and plugin topics to the online manual.
Get Help Links to the JEM forum and downloads area.
Contribute Explains ways to help the JEM project, such as reporting issues, translating, testing, or contributing code.
Credits Shows contributor and project credit information.
License Opens the GNU GPL license information.

Documentation Map

The local documentation map is a bridge between the installed help pages and the online manual. It lists the main JEM areas and links them to documentation sections.

  • Backend: control panel, events, venues, categories, settings, import/export, housekeeping, CSS manager, and update check.
  • Frontend: event lists, event detail pages, calendars, categories, venues, maps, search, submit forms, and user-area views.
  • Modules: Basic, Wide, Calendar, Teaser, Banner, Jubilee, Venues Map, and Types modules.
  • Plugins: Finder, Mailer, Comments, Content, Embed, List Events, and Quick Icon plugins.
If a local help page is brief, open the linked online manual page for the expanded documentation.

Search Help

The search field filters the local help table of contents. It searches the text inside installed help files and shows only matching help pages.

  1. Open the JEM Help screen.
  2. Enter a word or phrase in the search field.
  3. Submit the search.
  4. Select a matching help page from the filtered list.
  5. Use Clear to restore the full help list.
The search only filters local installed help files. It does not search the online documentation site.

Images in Help Pages

Some local help pages include screenshots. JEM can display these images in a modal viewer when the help page sends an image-open action to the parent Help screen.

  • Click an image in a supported help page to enlarge it.
  • Close the modal with the close button or by clicking outside the image.
  • If the image does not open, check browser console errors and file paths.

When to Use Online Documentation Instead

The online documentation should be used when you need the newest information, expanded examples, or links to related project notes.

  • Use online documentation for current JEM 5.0.0 feature details.
  • Use online documentation for upgrade and update paths.
  • Use online documentation for longer backend, frontend, module, plugin, language, and layout guides.
  • Use the forum when the documentation does not answer a site-specific problem.

Recommended Workflow

  1. Use the Help screen for quick local reference while working in the JEM backend.
  2. Open the Documentation map when you need to find the correct manual section.
  3. Use toolbar Help buttons from specific JEM screens for context-sensitive help.
  4. Use the online manual for the latest expanded documentation.
  5. Use the forum or issue tracker only after checking the relevant documentation page.

Troubleshooting

The Help screen opens in English

  • Check whether local help files exist for the active administrator language.
  • If no matching language folder exists, JEM falls back to en-GB.
  • Use the online documentation or language project if a translated help page is missing.

Search does not find a topic

  • Try a shorter search term.
  • Remember that search only covers installed local help files.
  • Use the Documentation map or online manual for broader search coverage.

A help page is missing or outdated

  • Check the online documentation for the current page.
  • Update JEM if the installed package is old.
  • Report documentation gaps through the normal JEM project channels.

Images do not display

  • Check that the image file exists under the JEM help images folder.
  • Check file permissions and browser console errors.
  • Clear Joomla cache and browser cache if paths were recently changed.

Related Project Notes

  • #1552 is relevant to improving the update and upgrade documentation linked from the help system.
  • #2186 is relevant because the Help and documentation map now reference newer backend areas such as Statistics.

Related Documentation