Joomla
Hilfetext für eigene Module
Standardmäßig wird bei der Zuordnung der Module, im Register "Modul" der Titel und die Beschreibung zum Modul angezeigt. Diese Daten werden aus der XML-Datei zum Modul, im konkreten Beispiel (mod_workshops) ist dies die Datei: mod_workshops.xml
<description>MOD_WORKSHOPS_XML_DESCRIPTION</description>
In der zugehörigen Sprachdatei zum Modul kann für den Platzhalter: MOD_WORKSHOPS_XML_DESCRIPTION ein beliebiger, auch in html formatierter längerer Text eingetragen werden.
Darüber hinaus wird oben rechts der Hilfe-Button [? Hilfe] angezeigt. Dieser zeigt standardmäßig die allgemeine Hilfe zur Modulzuordnung an. Leider nur auf Englisch. Aktuell und auch in absehbarer Zeit steht kein deutscher Helptext-Server für den Joomla-Core zur Verfügung.
eigenen Hilfetext anzeigen
Dazu muss in der XML-Datei der Tag "help" eingetragen werden.
<help key="JHELP_EXTENSIONS_MODULE_MANAGER_WORKSHOPS" url="MOD_WORKSHOPS_HELP_URL"/>
Die Sprachdatei zum Modul, hier de-DE.workshops.ini muss einen Eintrag für den oben eingetragenen Platzhalter "MOD_WORKSHOPS_HELP_URL" enthalten. Ein direkter Eintrag unter url="http://..." funktioniert nicht!
MOD_WORKSHOPS_HELP_URL="http://joomla.major-online.de/index.php?option=com_help&task=help&extension=mod_workshops&screen=info&lang=de"