Das System der erweiterten Hilfe ist ein modulares System, das erweiterte Hilfemöglichkeiten für Drupal und seine Module bereitstellt. Obwohl die erweiterte Hilfe selbst keine allgemeine Hilfe bereitstellt, stellt es ein mächtiges und einfaches Rahmenwerk zur Verfügung, das Module verwenden können, um ihre eigene Hilfe bereitzustellen.
Module die die erweiterte Hilfe verwenden sollten ein Unterverzeichnis 'help' innerhalb des Modulverzeichnisses bereitstellen. Die Datei MODULENAME.help.ini muss in diesem Unterverzeichnis platziert werden, formatiert entsprechend dem nachfolgenden Beispiel:
[buses] title = "How buses are tied into the system" file = buses [TOPIC_ID] title = "Title of topic". file = filename of topic, without the .html extension. weight = How important the topic is on the index page. parent = The optional topic parent to use in the breadcrumb, either topic or module%topic.
Alle Themen werden durch das Modul, das die Hilfe bereitstellt, und die Themen-ID adressiert. Um Links einzubetten muss das folgende Format verwendet werden:
$output .= theme('advanced_help_topic', $module, $topic);
Innerhalb der Hilfedatei können andere Hilfethemen durch Verwendung des Formats <a href="topic:module/topic"> verlinkt werden. Dieses Format stellt sicher, dass der Popup-Status konsistent bleibt, wenn zwischen Links umgeschaltet wird.
Mit <a href="path:example.jpg"> können Elemente innerhalb des Hilfe-Verzeichnisses referenziert werden wie z.B. Bilder, die im Hilfetext eingebettet werden sollen.
Mit <a href="base_url:admin/settings/site-configuration"> kann jeder normale Pfad der Website referenziert werden.
Wenn das Modul Search aktiviert ist, werden die Inhalte des Hilfesystems von Cron indexiert. Wenn neue Module aktiviert werden und der Hilfetext sofort indexiert werden soll, muss "Verwalten -> Berichte -> Statusreport" aufgerufen und der Link "Cron von hand starten" aufgerufen werden.
Beispiel: Nicht anklicken!
Siehe: ini file format
Hinweis: In älteren Versionen der erweiterten Hilfe war es nicht erforderlich &'s wrapped around the topic:, path:, and base_url: links. Dies wird momentan noch unterstützt, wird in einer zukünftigen Version aber möglicherweise entfernt. Durch das Hinzufügen der &'s sind diese Token jetzt nicht auf href=""- and src=""-Paramater begrenzt.