help.module in Drupal 5
Same filename and directory in other branches
Manages displaying online help.
File
modules/help/help.moduleView source
<?php
/**
* @file
* Manages displaying online help.
*/
/**
* Implementation of hook_menu().
*/
function help_menu($may_cache) {
$items = array();
if ($may_cache) {
$admin_access = user_access('access administration pages');
$items[] = array(
'path' => 'admin/help',
'title' => t('Help'),
'callback' => 'help_main',
'access' => $admin_access,
'weight' => 9,
);
foreach (module_implements('help', TRUE) as $module) {
$items[] = array(
'path' => 'admin/help/' . $module,
'title' => t($module),
'callback' => 'help_page',
'type' => MENU_CALLBACK,
'access' => $admin_access,
);
}
}
return $items;
}
/**
* Menu callback; prints a page listing a glossary of Drupal terminology.
*/
function help_main() {
// Add CSS
drupal_add_css(drupal_get_path('module', 'help') . '/help.css', 'module', 'all', FALSE);
$output = t('
<h2>Help topics</h2>
<p>Help is available on the following items:</p>
!help_pages
<h2>Glossary of Drupal terminology</h2>
<dl>
<dt>Block</dt><dd>A small box containing information or content placed in a region of a web page (e.g. in a sidebar, below or above the content, or in any other region the current theme allows).</dd>
<dt>Comment</dt><dd>Text attached to a post intended to clarify, explain, criticize, or express an opinion on the original post.</dd>
<dt>Node</dt><dd>The basic unit of content in Drupal, often referred to as a "post". All content that can be created using the "create content" menu is a node. Keep in mind that comments, blocks, and users are <em>not</em> nodes.</dd>
<dt>Published</dt><dd>A post that is viewable by every visitor of the site, regardless of whether he is logged in (see also "Unpublished").</dd>
<dt>Role</dt><dd>A classification users are placed into for the purpose of setting users\' permissions. A user receives the combined permissions of all roles to which he or she is subscribed.</dd>
<dt>Taxonomy</dt><dd>A categorization system that allows the building of complex hierarchial or relational structures and tagging of content (see <a href="@taxonomy">taxonomy help</a>).</dd>
<dt>Unpublished</dt><dd>A post 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 currently 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 <em>not</em> currently logged in with that account. A visitor is also called an "anonymous user".</dd>
</dl>', array(
'!help_pages' => help_links_as_list(),
'@taxonomy' => url('admin/help/taxonomy'),
));
return $output;
}
function help_links_as_list() {
$module_info = module_rebuild_cache();
$modules = array();
foreach (module_implements('help', TRUE) as $module) {
if (module_invoke($module, 'help', "admin/help#{$module}")) {
$modules[] = $module;
}
}
sort($modules);
// Output pretty four-column list
$break = ceil(count($modules) / 4);
$output = '<div class="clear-block"><div class="help-items"><ul>';
foreach ($modules as $i => $module) {
$output .= '<li>' . l($module_info[$module]->info['name'], 'admin/help/' . $module) . '</li>';
if (($i + 1) % $break == 0) {
$output .= '</ul></div><div class="help-items' . ($i + 1 == $break * 3 ? ' help-items-last' : '') . '"><ul>';
}
}
$output .= '</ul></div></div>';
return $output;
}
/**
* Implementation of hook_help().
*/
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. Additionally, you will find a glossary of basic Drupal terminology to help get you started.</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>\n<ul>\n<li>The module's help text, displayed on the <a href=\"@help\">help page</a> and through the module's individual help link.</li>\n<li>More elaborate help text on sites a module defines.</li>\n<li>The help for a distributed authorization module (if applicable).</li>\n</ul>\n", array(
'@help' => url('admin/help'),
));
$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;
}
}
/**
* Menu callback; prints a page listing general help for all modules.
*/
function help_page() {
$name = arg(2);
$output = '';
if (module_hook($name, 'help')) {
$module = _module_parse_info_file(drupal_get_path('module', $name) . '/' . $name . '.info');
drupal_set_title($module['name']);
$temp = module_invoke($name, 'help', "admin/help#{$name}");
if (empty($temp)) {
$output .= t("No help is available for module %module.", array(
'%module' => $module['name'],
));
}
else {
$output .= $temp;
}
// Only print list of administration pages if the module in question has
// any such pages associated to it.
$admin_tasks = system_get_module_admin_tasks($name);
if (!empty($admin_tasks)) {
ksort($admin_tasks);
$output .= theme('item_list', $admin_tasks, t('@module administration pages', array(
'@module' => $module['name'],
)));
}
}
return $output;
}