admin_menu/README.txt

   1 /* $Id: README.txt,v 1.20.2.8 2009/01/16 20:39:26 sun Exp $ */
   2
   3 -- SUMMARY --
   4
   5 The Drupal administration menu module displays the entire administrative
   6 menu tree (and most local tasks) in a drop-down menu, providing administrators
   7 one- or two-click access to most pages. Other modules may also add menu
   8 links to administration menu using hook_admin_menu().
   9
  10 For a full description of the module, visit the project page:
  11   http://drupal.org/project/admin_menu
  12
  13 To submit bug reports and feature suggestions, or to track changes:
  14   http://drupal.org/project/issues/admin_menu
  15
  16
  17 -- REQUIREMENTS --
  18
  19 None.
  20
  21
  22 -- INSTALLATION --
  23
  24 * Install as usual, see http://drupal.org/node/70151 for further information.
  25
  26
  27 -- CONFIGURATION --
  28
  29 * Configure user permissions in Administer >> User management >> Permissions >>
  30   admin_menu module:
  31
  32   - access administration menu
  33
  34     Users in roles with the "access administration menu" permission will see
  35     the administration menu at the top of each page.
  36
  37   - display drupal links
  38
  39     Users in roles with the "display drupal links" permission will receive
  40     links to Drupal.org issue queues for all enabled contributed modules. The
  41     issue queue links appear under the administration menu icon.)
  42
  43   Note that the menu items displayed in the administration Menu depend on the
  44   actual permissions of the viewing user. For example, the "User management"
  45   menu item is not displayed to a user who is not a member of a role with the
  46   "administer permissions" and "administer users" permissions.
  47
  48 * Customize the menu settings in Administer >> Site configuration >>
  49   Administration menu.
  50
  51 * To prevent administrative menu items from appearing twice, you may hide the
  52   "Navigation" menu block, or move the "Administer" menu items into a separate
  53   menu.
  54
  55
  56 -- CUSTOMIZATION --
  57
  58 * To override the default administration menu icon, you may:
  59
  60   1) Disable it via CSS in your theme:
  61
  62      body #admin-menu-icon { display: none; }
  63
  64   2) Alter the image by overriding the theme function:
  65
  66      Copy the entire theme_admin_menu_icon() function into your template.php,
  67      rename it to phptemplate_admin_menu_icon() or THEMENAME_admin_menu_icon(),
  68      and customize the output according to your needs.
  69
  70   Remember that the output of the administration menu is cached. To see changes
  71   from your theme override function, you must clear your site cache (via
  72   the "Flush all caches" link on the menu).
  73
  74 * To override the font size, add the following line to your theme's stylesheet:
  75
  76   body #admin-menu { font-size: 10px; }
  77
  78
  79 -- TROUBLESHOOTING --
  80
  81 * If the menu does not display, check the following:
  82
  83   - Are the "access administration menu" and "access administration pages"
  84     permissions enabled for the appropriate roles?
  85
  86   - Does your theme output the $closure variable?
  87
  88 * If the menu is rendered behind a Flash movie object, add this property to your
  89   Flash object(s):
  90
  91   <param name="wmode" value="transparent" />
  92
  93   See http://drupal.org/node/195386 for further information.
  94
  95
  96 -- FAQ --
  97
  98 Q: When the administration menu module is enabled, blank space is added to the
  99    bottom of my theme. Why?
 100
 101 A: This is caused by a long list of links to module issue queues at Drupal.org.
 102    Use Administer >> User management >> Permissions to disable the "display
 103    drupal links" permission for all appropriate roles. Note that since UID 1
 104    automatically receives all permissions, the list of issue queue links cannot
 105    be disabled for UID 1.
 106
 107
 108 Q: After upgrading to 6.x-1.x, the menu disappeared. Why?
 109
 110 A: You may need to regenerate your menu. Visit
 111    http://example.com/admin/build/modules to regenerate your menu (substitute
 112    your site name for example.com).
 113
 114
 115 Q: Can I configure the administration menu module to display another menu (like
 116    the Navigation menu, for instance)?
 117
 118 A: No. As the name implies, administration menu module is for administrative
 119    menu links only. However, you can copy and paste the contents of
 120    admin_menu.css into your theme's stylesheet and replace #admin-menu with any
 121    other menu block id (#block-menu-1, for example).
 122
 123
 124 Q: Sometimes, the user counter displays a lot of anonymous users, but no spike
 125    of users or requests appear in Google Analytics or other tracking tools.
 126
 127 A: If your site was concurrently spidered by search-engine robots, it may have
 128    a significant number of anonymous users for a short time. Most web tracking
 129    tools like Google Analytics automatically filter out these requests.
 130
 131
 132 Q: I enabled "Aggregate and compress CSS files", but admin_menu.css is still
 133    there. Is this normal?
 134
 135 A: Yes, this is the intended behavior. the administration menu module only loads
 136    its stylesheet as needed (i.e., on page requests by logged-on, administrative
 137    users).
 138
 139
 140 Q: Why are sub-menus not visible in Opera?
 141
 142 A: In the Opera browser preferences under "web pages" there is an option to fit
 143    to width. By disabling this option, sub-menus in the administration menu
 144    should appear.
 145
 146
 147 Q: How can the administration menu be hidden on certain pages?
 148
 149 A: You can suppress it by simply calling the following function in PHP:
 150
 151      module_invoke('admin_menu', 'suppress');
 152
 153    However, this needs to happen as early as possible in the page request, so
 154    placing it in the theming layer (resp. a page template file) is too late.
 155    Ideally, the function is called in hook_init() in a custom module.  If you do
 156    not have a custom module, placing it into some conditional code at the top of
 157    template.php may work out, too.
 158
 159
 160 -- CONTACT --
 161
 162 Current maintainers:
 163 * Daniel F. Kudwien (sun) - http://drupal.org/user/54136
 164 * Peter Wolanin (pwolanin) - http://drupal.org/user/49851
 165 * Stefan M. Kudwien (smk-ka) - http://drupal.org/user/48898
 166 * Dave Reid (Dave Reid) - http://drupal.org/user/53892
 167
 168 Major rewrite for Drupal 6 by Peter Wolanin (pwolanin).
 169
 170 This project has been sponsored by:
 171 * UNLEASHED MIND
 172   Specialized in consulting and planning of Drupal powered sites, UNLEASHED
 173   MIND offers installation, development, theming, customization, and hosting
 174   to get you started. Visit http://www.unleashedmind.com for more information.
 175
 176 * Lullabot
 177   Friendly Drupal experts providing professional consulting & education
 178   services. Visit http://www.lullabot.com for more information.
 179
 180 * Acquia
 181   Commercially Supported Drupal. Visit http://acquia.com for more information.
 182