Help topics
Help is available on the following items:
!help_pages
Glossary of Drupal terminology
- Block
- 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).
- Comment
- Text attached to a post intended to clarify, explain, criticize, or express an opinion on the original post.
- Node
- 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 not nodes.
- Published
- A post that is viewable by every visitor of the site, regardless of whether he is logged in (see also "Unpublished").
- Role
- 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.
- Taxonomy
- A categorization system that allows the building of complex hierarchical or relational structures and tagging of content (see taxonomy help).
- Unpublished
- A post that is only viewable by administrators and moderators.
- User
- A person who has an account at your Drupal site, and is currently logged in with that account.
- Visitor
- 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 not currently logged in with that account. A visitor is also called an "anonymous user".
', array('!help_pages' => help_links_as_list(), '@taxonomy' => url('admin/help/taxonomy')));
return $output;
}
/**
* Menu callback; prints a page listing general help for a module.
*/
function help_page($name) {
$output = '';
if (module_hook($name, 'help')) {
$module = drupal_parse_info_file(drupal_get_path('module', $name) .'/'. $name .'.info');
drupal_set_title($module['name']);
$temp = module_invoke($name, 'help', "admin/help#$name", drupal_help_arg());
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;
}
function help_links_as_list() {
$empty_arg = drupal_help_arg();
$module_info = module_rebuild_cache();
$modules = array();
foreach (module_implements('help', TRUE) as $module) {
if (module_invoke($module, 'help', "admin/help#$module", $empty_arg)) {
$modules[] = $module;
}
}
sort($modules);
// Output pretty four-column list
$count = count($modules);
$break = ceil($count / 4);
$output = '';
foreach ($modules as $i => $module) {
$output .= '- '. l($module_info[$module]->info['name'], 'admin/help/'. $module) .'
';
if (($i + 1) % $break == 0 && ($i + 1) != $count) {
$output .= '