cms/drupal/modules/help/help.module
changeset 541 e756a8c72c3d
equal deleted inserted replaced
540:07239de796bb 541:e756a8c72c3d
       
     1 <?php
       
     2 
       
     3 /**
       
     4  * @file
       
     5  * Manages displaying online help.
       
     6  */
       
     7 
       
     8 /**
       
     9  * Implements hook_menu().
       
    10  */
       
    11 function help_menu() {
       
    12   $items['admin/help'] = array(
       
    13     'title' => 'Help',
       
    14     'description' => 'Reference for usage, configuration, and modules.',
       
    15     'page callback' => 'help_main',
       
    16     'access arguments' => array('access administration pages'),
       
    17     'weight' => 9,
       
    18     'file' => 'help.admin.inc',
       
    19   );
       
    20 
       
    21   foreach (module_implements('help', TRUE) as $module) {
       
    22     $items['admin/help/' . $module] = array(
       
    23       'title' => $module,
       
    24       'page callback' => 'help_page',
       
    25       'page arguments' => array(2),
       
    26       'access arguments' => array('access administration pages'),
       
    27       'type' => MENU_VISIBLE_IN_BREADCRUMB,
       
    28       'file' => 'help.admin.inc',
       
    29     );
       
    30   }
       
    31 
       
    32   return $items;
       
    33 }
       
    34 
       
    35 /**
       
    36  * Implements hook_help().
       
    37  */
       
    38 function help_help($path, $arg) {
       
    39   switch ($path) {
       
    40     case 'admin/help':
       
    41       $output = '<p>' . t('Follow these steps to set up and start using your website:') . '</p>';
       
    42       $output .= '<ol>';
       
    43       $output .= '<li>' . t('<strong>Configure your website</strong> Once logged in, visit the <a href="@admin">administration section</a>, where you can <a href="@config">customize and configure</a> all aspects of your website.', array('@admin' => url('admin'), '@config' => url('admin/config'))) . '</li>';
       
    44       $output .= '<li>' . t('<strong>Enable additional functionality</strong> Next, visit the <a href="@modules">module list</a> and enable features which suit your specific needs. You can find additional modules in the <a href="@download_modules">Drupal modules download section</a>.', array('@modules' => url('admin/modules'), '@download_modules' => 'http://drupal.org/project/modules')) . '</li>';
       
    45       $output .= '<li>' . t('<strong>Customize your website design</strong> To change the "look and feel" of your website, visit the <a href="@themes">themes section</a>. You may choose from one of the included themes or download additional themes from the <a href="@download_themes">Drupal themes download section</a>.', array('@themes' => url('admin/appearance'), '@download_themes' => 'http://drupal.org/project/themes')) . '</li>';
       
    46       $output .= '<li>' . t('<strong>Start posting content</strong> Finally, you can <a href="@content">add new content</a> for your website.', array('@content' => url('node/add'))) . '</li>';
       
    47       $output .= '</ol>';
       
    48       $output .= '<p>' . t('For more information, refer to the specific topics listed in the next section or to the <a href="@handbook">online Drupal handbooks</a>. You may also post at the <a href="@forum">Drupal forum</a> or view the wide range of <a href="@support">other support options</a> available.', array('@help' => url('admin/help'), '@handbook' => 'http://drupal.org/documentation', '@forum' => 'http://drupal.org/forum', '@support' => 'http://drupal.org/support')) . '</p>';
       
    49       return $output;
       
    50     case 'admin/help#help':
       
    51       $output = '';
       
    52       $output .= '<h3>' . t('About') . '</h3>';
       
    53       $output .= '<p>' . t('The Help module provides <a href="@help-page">Help reference pages</a> and context-sensitive advice to guide you through the use and configuration of modules. It is a starting point for the online <a href="@handbook">Drupal handbooks</a>. The handbooks contain more extensive and up-to-date information, are annotated with user-contributed comments, and serve as the definitive reference point for all Drupal documentation. For more information, see the online handbook entry for the <a href="@help">Help module</a>.', array('@help' => 'http://drupal.org/documentation/modules/help/', '@handbook' => 'http://drupal.org/documentation', '@help-page' => url('admin/help'))) . '</p>';
       
    54       $output .= '<h3>' . t('Uses') . '</h3>';
       
    55       $output .= '<dl>';
       
    56       $output .= '<dt>' . t('Providing a help reference') . '</dt>';
       
    57       $output .= '<dd>' . t('The Help module displays explanations for using each module listed on the main <a href="@help">Help reference page</a>.', array('@help' => url('admin/help'))) . '</dd>';
       
    58       $output .= '<dt>' . t('Providing context-sensitive help') . '</dt>';
       
    59       $output .= '<dd>' . t('The Help module displays context-sensitive advice and explanations on various pages.') . '</dd>';
       
    60       $output .= '</dl>';
       
    61       return $output;
       
    62   }
       
    63 }