You are here

function admin_menu_help in Administration menu 5.2

Same name and namespace in other branches
  1. 8.3 admin_menu.module \admin_menu_help()
  2. 5.3 admin_menu.module \admin_menu_help()
  3. 5 admin_menu.module \admin_menu_help()
  4. 6.3 admin_menu.module \admin_menu_help()
  5. 6 admin_menu.module \admin_menu_help()
  6. 7.3 admin_menu.module \admin_menu_help()

Implementation of hook_help().

File

./admin_menu.module, line 16
Renders a menu tree for administrative purposes as dropdown menu at the top of the window.

Code

function admin_menu_help($section) {
  switch ($section) {
    case 'admin/modules#description':
      return t('Renders the administer menu tree as dropdown menu at the top of the window.');
    case 'admin/settings/admin_menu':
      return t('The Administration Menu will appear at the top of the page for users who have been given the "access administration menu" permission.  Customize appearance of the dropdown menu here.');
    case 'admin/help#admin_menu':
      return t(<<<EOT
<p>Drupal Administration Menu renders all administrative menu items below 'administer'
in a clean, attractive and purely CSS-based menu at the top of your website.  It contains
not only regular menu items - local tasks are also included, giving you extremely fast
access to any administrative resource and function your Drupal installation provides.</p>
<p>The menu also can display the number of anonymous and authenticated users,
<a href="http://drupal.org/project/devel">Devel module</a> links, and items generated by
other modules.</p>
<p>The <a href="!settings">settings page</a> is where administrators can choose
whether or not to allow the module to shift the page contents down to accommodate
the menu.  Depending on the design/layout of your theme, this may cause problems with
the appearance of the page.  Changing the '%margin-setting' setting may fix this
issue.</p>
<p>Please bear in mind that the displayed menu items in Drupal Administration Menu depend on the actual permissions of a user.  For example, if a user does not have the permission "@permission-access" and "@permission-users", the whole "@user-management" menu item will not be displayed.</p>
EOT
, array(
        '!settings' => url('admin/settings/admin_menu'),
        '%margin-setting' => t('Apply margin-top to page body'),
        '@permission-access' => 'administer access control',
        '@permission-users' => 'administer users',
        '@user-management' => 'User management',
      ));
  }
}