Help and documentation

Same name in other branches
  1. 10 core/modules/tour/tour.api.php \help_docs
  2. 11.x core/modules/tour/tour.api.php \help_docs

Documenting modules, themes, and install profiles

Help Topics

Modules, themes, and install profiles can have a subdirectory help_topics that contains one or more Help Topics, to provide help to administrative users. These are shown on the main admin/help page. See Help Topic Standards for more information.

hook_help

Modules can implement hook_help() to provide a module overview (shown on the main admin/help page). This hook implementation can also provide help text that is shown in the Help block at the top of administrative pages. See the hook_help() documentation and Help text standards for more information.

Tours

Modules can provide tours of administrative pages by creating tour config files and placing them in their config/optional subdirectory. See Tour API overview for more information. The contributed Tour UI module can also be used to create tour config files.

File

core/modules/help_topics/help_topics.api.php, line 8

Classes

Title File name Summary
HelpTopicPluginManager core/modules/help_topics/src/HelpTopicPluginManager.php Provides the default help_topic manager.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.