help.module in Drupal 6

Manages displaying online help.

File

modules/help/help.module

<?php

/**
 * @file
 * Manages displaying online help.
 */

/**
 * Implementation of hook_menu().
 */
function help_menu() {
  $items['admin/help'] = array(
    'title' => 'Help',
    'page callback' => 'help_main',
    'access arguments' => array(
      'access administration pages',
    ),
    'weight' => 9,
    'file' => 'help.admin.inc',
  );
  foreach (module_implements('help', TRUE) as $module) {
    $items['admin/help/' . $module] = array(
      'title' => $module,
      'page callback' => 'help_page',
      'page arguments' => array(
        2,
      ),
      'access arguments' => array(
        'access administration pages',
      ),
      'type' => MENU_CALLBACK,
      'file' => 'help.admin.inc',
    );
  }
  return $items;
}

/**
 * Implementation of hook_help().
 */
function help_help($path, $arg) {
  switch ($path) {
    case 'admin/help':
      $output = '<p>' . t('This guide provides context sensitive help on the use and configuration of <a href="@drupal">Drupal</a> and its modules, and is a supplement to the more extensive online <a href="@handbook">Drupal handbook</a>. The online handbook may contain more up-to-date information, is annotated with helpful user-contributed comments, and serves as the definitive reference point for all Drupal documentation.', array(
        '@drupal' => 'http://drupal.org',
        '@handbook' => 'http://drupal.org/handbook',
      )) . '</p>';
      return $output;
    case 'admin/help#help':
      $output = '<p>' . t('The help module provides context sensitive help on the use and configuration of <a href="@drupal">Drupal</a> and its modules, and is a supplement to the more extensive online <a href="@handbook">Drupal handbook</a>. The online handbook may contain more up-to-date information, is annotated with helpful user-contributed comments, and serves as the definitive reference point for all Drupal documentation.', array(
        '@drupal' => 'http://drupal.org',
        '@handbook' => 'http://drupal.org/handbook',
      )) . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@help">Help module</a>.', array(
        '@help' => 'http://drupal.org/handbook/modules/help/',
      )) . '</p>';
      return $output;
  }
}

Functions

Name	Description
help_help	Implementation of hook_help().
help_menu	Implementation of hook_menu().