You are here

function help_help in Drupal 4

Same name and namespace in other branches
  1. 8 core/modules/help/help.module \help_help()
  2. 5 modules/help/help.module \help_help()
  3. 6 modules/help/help.module \help_help()
  4. 7 modules/help/help.module \help_help()
  5. 9 core/modules/help/help.module \help_help()

Implementation of hook_help().

File

modules/help.module, line 92
Manages displaying online help.

Code

function help_help($section) {
  switch ($section) {
    case 'admin/help':
      $output = t('<p>This guide explains what the various modules in <a href="%Drupal">Drupal</a> do and how to configure them.</p>
<p>It is not a substitute for the <a href="%handbook">Drupal handbook</a> available online and should be used in conjunction with it. The online reference handbook might be more up-to-date and has helpful user-contributed comments. It is your definitive reference point for all Drupal documentation.</p>
', array(
        '%Drupal' => 'http://drupal.org',
        '%handbook' => 'http://drupal.org/handbook',
      ));
      return $output;
    case 'admin/help#help':
      $output = '<p>' . t('The help module displays context sensitive help information. Users can learn how to use modules and accomplish tasks quicker with less errors by clicking on links in provided by the help module.') . '</p>';
      $output .= t('<p>Modules can make documentation available to other modules with this module. All user help should be presented using this module.  Some examples of help: </p>
<ul>
<li>The name of a module (unused, but there).</li>
<li>The description found on the admin/system/modules page.</li>
<li>The module\'s help text, displayed on the admin/help page and through the module\'s individual help link.</li>
<li>The help for a distributed authorization module (if applicable).</li>
<li>The description of a post type (if applicable).</li>
</ul>
');
      $output .= '<p>' . t('You can not administer the help system.') . '</p>';
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="%help">Help page</a>.', array(
        '%help' => 'http://drupal.org/handbook/modules/help/',
      )) . '</p>';
      return $output;
    case 'admin/modules#description':
      return t('Manages the display of online help.');
  }
}