Help system/de

This Article Needs Your Help

This document describes the help system as implemented in Joomla 2.5 onwards. The help system in previous versions of Joomla was not the same and was considerably less versatile. In particular, help servers were restricted to being Joomla instances. The help system in Joomla 1.5 and earlier versions is documented elsewhere.

After a brief introduction to the Joomla help system, this document begins by describing how the help system works, which is something of general interest although written primarily for the benefit of site integrators who must customise Joomla installations. It then proceeds to describe how to set up your own help server, which is something that will be of interest to translators wanting to localise help screens and to third-party developers wanting to provide integrated help from their extensions. Finally, a more detailed description of how to add help support to Joomla extensions is aimed at developers.

Introduction to the Joomla help system

Das Joomla! Hilfesystem bietet angemeldeten Benutzern kontextsensitive Informationen in der Administration. Hilfeinformationen werden über den Hilfe-Button oben rechts der Werkzeugleiste in nahezu allen Seiten aufgerufen (Anmerkung: Der Button kann an anderer Stelle angezeigt werden, wenn kein Joomla!-Core-Template verwendet wird). Nach Klick auf den Hilfe-Button wird ein Fenster mit Informationen zu der aktuellen Seite geöffnet.

A typical toolbar with a help button looks like this:

In addition, by clicking on the Help -> Joomla Help menu item, a list of help topics will be displayed. Clicking on any of these topic titles will bring up relevant information on the same page.

The help system can access information stored locally as part of the Joomla installation, or from a remote help server. It is fully multi-lingual and can be localised using one of the official translations, or by providing your own help information using a separately hosted help server. Third-party extension developers can integrate help information for components that they supply, either from the local component file structure, or from a remote help server. Furthermore, site integrators can override any or all help screens to fully customise a particular Joomla installation.

• Read more about how the help system works.
• Read more about setting up your own help server.
• Read more about using local help files.
• Read more about translating and localising help screens.
• Read more about how the administrator help area works.
• Read more about adding help support to Joomla extensions.

See also

• Format of the helpsites XML file.
• Substitution codes for use in help screen URLs.
• Table of help screens for Joomla 1.5
• Table of help screens for Joomla 2.5
• Table of help screens for Joomla 3.x
• Using chunks in Joomla help screens