Last updated 2 December 2016. Created on 29 March 2015.
Edited by loopduplicate, volkswagenchick, gisle. Log in to edit this page.

The contributed Advanced help module is an adjunct to Drupal's built-in Help system. It provides a framework that allows module and theme developers to integrate help texts in a Drupal site, as well as exposing help to site administrators through the administrative interface.

These help texts are stored in ordinary .html-files that lives in the file system (as opposed to the core Help system embedding it in strings that are part of the project's code). These files are distributed from the project Drupal.org repo in the same package as the module or theme, and placed in a subdirectory named help in the project or theme directory. This means that the help texts can be easily kept in sync with the project they provide help texts for, but also that read access to these files are not managed by any content access restrictions imposed by Drupal.

The help texts can be marked up with standard HTML, but are rendered within your site's Drupal theming structure.

If the module or theme author does not make use of the full Advanced help framework, but if there is a README.md or README.txt in the package, the content of that file will be shown instead.

The help texts may appear in a popup or not as the module prefers. By taking away access to view the popups, a site can hide popups from users.

The help texts can be placed in a hierarchy, allowing for top down navigation of help.

The hierarchy is tied into Drupal's search system. If this is enabled, all help texts are fully indexed. This means that the entire contents of the advanced help set of pages can be searched for keywords.

Using the module

By itself, this module doesn't do much. The Advanced help assists other modules and themes in showing help texts. Nothing will show up until you enable at least one other module that makes use of the advanced help framework or comes with a file named README.md or README.txt. However, it comes with a small companion demo module named Advanced help example to demonstrate how it works. For more extensive example of use of the project's features, see the Views project.

Looking for support? Visit the Drupal.org forums, or join #drupal-support in IRC.