help.module 3.14 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4
/**
Dries's avatar
 
Dries committed
5
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
6
 */
Dries's avatar
 
Dries committed
7 8 9 10 11 12 13 14 15 16
function help_menu() {
  $items = array();
  $items[] = array('path' => 'admin/help/glossary', 'title' => t('glossary'),
    'callback' => 'help_glossary',
    'access' => user_access('access administration pages'));
  $items[] = array('path' => 'admin/help', 'title' => t('help'),
    'callback' => 'help_page',
    'access' => user_access('access administration pages'),
    'weight' => 9);
  return $items;
Dries's avatar
 
Dries committed
17 18
}

Dries's avatar
Dries committed
19 20 21
/**
 * Menu callback; prints a page listing a glossary of Drupal terminology.
 */
Dries's avatar
 
Dries committed
22
function help_glossary() {
Dries's avatar
Dries committed
23
  $output = t("
Dries's avatar
 
Dries committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
  <h3>Glossary</h3><dl>
  <dt>Block</dt><dd>A small box containing information or content placed in the left-hand or right-hand sidebar of a web page.</dd>
  <dt>Comment</dt><dd>A note attached to a node. Usually intended to clarify, explain, criticize, or express an opinion on the original material.</dd>
  <dt>Moderation</dt><dd>The activity of making sure a post to a Drupal site fits in with what is expected for that Drupal site.<dl>
  <dt>Approved</dt><dd>A moderated post which has been accepted by the moderators for publication. (See published).</dd>
  <dt>Waiting</dt><dd>A moderated post which is still being voted on to be accepted for publication. (See published.)</dd>
  <dt>Moderators</dt><dd>The group of Drupal users that reviews posts before they are published. These users have the \"access submission queue\" permission. (See Published).</dd></dl></dd>
  <dt>Node</dt><dd>The basic data unit in Drupal. Everything is a node or an extention of a node.</dd>
  <dt>Public</dt><dd>See published.</dd>
  <dt>Published</dt><dd>A node that is viewable by everyone. (See unpublished.)</dd>
  <dt>Role</dt><dd>A classification users are placed into for the purpose of setting users' permissions.</dd>
  <dt>Taxonomy</dt><dd>A division of a collection of things into ordered, classified groups. (See <a href=\"%taxonomy\">taxonomy help</a>.)</dd>
  <dt>Unpublished</dt><dd>A node that is only viewable by administrators and moderators.</dd>
  <dt>User</dt><dd>A person who has an account at your Drupal site, and is logged in with that account.</dd>
  <dt>Visitor</dt><dd>A person who does not have an account at your Drupal site or a person who has an account at your Drupal site but is <u>not</u> logged in with that account. Also termed \"anonymous user\".</dd>
Dries's avatar
Dries committed
39
  </dl>", array('%taxonomy' => url('admin/taxonomy/help')));
Dries's avatar
 
Dries committed
40

Dries's avatar
Dries committed
41
  print theme('page', $output);
Dries's avatar
 
Dries committed
42 43
}

Dries's avatar
Dries committed
44 45 46 47
/**
 * Implementation of hook_help().
 */
function help_help($section) {
Dries's avatar
 
Dries committed
48
  switch ($section) {
Dries's avatar
 
Dries committed
49
    case 'admin/modules#description':
Dries's avatar
 
Dries committed
50
      return t('Manages displaying online help.');
Dries's avatar
 
Dries committed
51
  }
Dries's avatar
 
Dries committed
52
}
Dries's avatar
 
Dries committed
53

Dries's avatar
Dries committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
/**
 * Menu callback; prints a page listing general help for all modules.
 */
function help_page() {
  foreach (module_list() as $name) {
    if (module_hook($name, 'help')) {
      $temp = module_invoke($name, 'help', "admin/help#$name");
      if (!empty($temp)) {
        $links[] = l($name, "admin/help#$name");
        $output .= "<h2><a id=\"$name\">". ucfirst($name) .' module</a></h2>';
        $output .= $temp;
      }
    }
  }
  $output = '<small>'. implode(' &middot; ', $links) .'</small><hr />'. $output;
  print theme('page', $output);
Dries's avatar
 
Dries committed
70 71
}

Dries's avatar
 
Dries committed
72
?>