summaryrefslogtreecommitdiff
path: root/modules/help.module
blob: a29a58feb500e96a09acba4342268e374872c5b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<?php
// $Id$

/**
 * Implementation of hook_link().
 */
function help_link($type) {
  if ($type == 'system') {
    menu('admin/help/glossary', t('glossary'), user_access('access administration pages') ? 'help_glossary' : MENU_DENIED, 8);
    menu('admin/help', t('help'), user_access('access administration pages') ? 'help_page' : MENU_DENIED, 9);
  }
}

/**
 * Menu callback; prints a page listing a glossary of Drupal terminology.
 */
function help_glossary() {
  $output = t("
  <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>
  </dl>", array('%taxonomy' => url('admin/taxonomy/help')));

  print theme('page', $output);
}

/**
 * Implementation of hook_help().
 */
function help_help($section) {
  switch ($section) {
    case 'admin/system/modules#description':
      $output = t('Manages displaying online help.');
      break;
  }
  return $output;
}

/**
 * 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);
}

?>