You are here

README.txt in Administration menu 5.3

Same filename and directory in other branches
  1. 8.3 README.txt
  2. 5 README.txt
  3. 5.2 README.txt
  4. 6.3 README.txt
  5. 6 README.txt
-- SUMMARY --

The Drupal administration menu module displays the entire administrative
menu tree (and most local tasks) in a drop-down menu, providing administrators
one- or two-click access to most pages. Other modules may also add menu
links to administration menu using hook_admin_menu().

For a full description of the module, visit the project page:
  http://drupal.org/project/admin_menu

To submit bug reports and feature suggestions, or to track changes:
  http://drupal.org/project/issues/admin_menu


-- REQUIREMENTS --

None.


-- INSTALLATION --

* Install as usual, see http://drupal.org/node/70151 for further information.


-- CONFIGURATION --

* Configure user permissions in Administer >> User management >> Access control
  >> admin_menu module:

  - access administration menu

    Users in roles with the "access administration menu" permission will see
    the administration menu at the top of each page.

  - display drupal links

    Users in roles with the "display drupal links" permission will receive
    links to Drupal.org issue queues for all enabled contributed modules. The
    issue queue links appear under the administration menu icon.)

  Note that the menu items displayed in the administration Menu depend on the
  actual permissions of the viewing user. For example, the "User management"
  menu item is not displayed to a user who is not a member of a role with the
  "administer access control" and "administer users" permissions.

* Customize the menu settings in Administer >> Site configuration >>
  Administration menu.

* To prevent administrative menu items from appearing twice, you may hide the
  "Navigation" menu block, or move the "Administer" menu items into a separate
  menu.


-- CUSTOMIZATION --

* To override the default administration menu icon, you may:

  1) Disable it via CSS in your theme:

     body #admin-menu-icon { display: none; }

  2) Alter the image by overriding the theme function:

     Copy the entire theme_admin_menu_icon() function into your template.php,
     rename it to phptemplate_admin_menu_icon() or THEMENAME_admin_menu_icon(),
     and customize the output according to your needs.

  Please bear in mind that admin_menu's output is cached. You need to clear your
  site's cache (probably best using Devel module, or by manually truncating the
  cache_menu database table) to see any changes of your theme override function.

* To override the font size, add the following line to your theme's stylesheet:

  body #admin-menu { font-size: 10px; }


-- TROUBLESHOOTING --

* If the menu does not display, check the following:

  - Are the "access administration menu" and "access administration pages"
    permissions enabled for the appropriate roles?

  - Does your theme output the $closure variable?

* If the menu is rendered behind a Flash movie object, add this property to your
  Flash object(s):

  <param name="wmode" value="transparent" />

  See http://drupal.org/node/195386 for further information.


-- FAQ --

Q: Content management >> Create content items are not displayed, although the
   user has been granted access to create content. Why?

A: This issue is caused by the circumstance that no other administrative menu
   item below Content management is visible for the user. Because of that,
   Drupal does not render this menu grouping item at all, and admin_menu is
   therefore not able to add the items below Create content.

   If you grant just one other permission for that user role, for example
   'administer taxonomy', the whole Content management item should show up.

Q: When the administration menu module is enabled, blank space is added to the
   bottom of my theme. Why?

A: This is caused by a long list of links to module issue queues at Drupal.org.
   Just go to Administer >> User management >> Access control >> admin_menu and
   disable the permission "display drupal links" for your or all roles.
   Since uid 1 always has all permissions, this link list cannot be disabled
   for uid 1.


Q: After upgrading to 5.x-2.x, admin_menu disappeared. Why?

A: This should not happen. If it did, visit
   http://<yoursitename>/admin/build/menu to re-generate your menu.


Q: Can I configure the administration menu module to display another menu (like
   the Navigation menu, for instance)?

A: No. As the name implies, administration menu module is for administrative
   menu links only. However, you can copy and paste the contents of
   admin_menu.css into your theme's stylesheet and replace #admin-menu with any
   other menu block id (#block-menu-1, for example).


Q: Sometimes, the user counter displays a lot of anonymous users, but no spike
   of users or requests appear in Google Analytics or other tracking tools.

A: If your site was concurrently spidered by search-engine robots, it may have
   a significant number of anonymous users for a short time. Most web tracking
   tools like Google Analytics automatically filter out these requests.

Q: After upgrading, admin_menu disappeared. Why?

A: Prior to release 5.x-1.2, Drupal Administration Menu was output in a block.
   Since 5.x-1.2, it is output via hook_footer(). Some custom themes may not
   (yet) output $closure, so admin_menu could no longer be displayed. If you
   decided to move the 'administer' tree into a new menu and disabled that menu
   block, a site could become (temporarily) unmaintainable. Either way, you
   should fix your theme by adding the following code in front of the closing
   HTML (</html>) tag:
<code>
   <?php echo $closure; ?>
</code>

Q: After upgrading, the menu item 'administer' is no longer removed. Why?

A: Prior to release 5.x-1.2, Drupal Administration Menu was output via
   hook_block(), which allowed to alter the global menu array. Since 5.x-1.2, it
   is output via hook_footer() and thus no longer able to alter the menu. As
   long as there will be no built-in solution in an upcoming release, you may
   perform the following steps as a workaround:
   - Create a new menu.
   - Edit the menu item 'administer' and select the new menu as parent.

Q: I enabled "Aggregate and compress CSS files", but I found admin_menu.css is
   still there, is it normal?

A: Yes, this is the intended behavior. Since admin_menu is only visible for
   logged-on administrative users, it would not make sense to load its
   stylesheet for all, including anonymous users.

Q: Why are sub-menus not visible in Opera?

A: In the Opera browser preferences under "web pages" there is an option to fit
   to width. By disabling this option, sub-menus in the administration menu
   should appear.


Q: How can the administration menu be hidden on certain pages?

A: You can suppress it by simply calling the following function in PHP:

     module_invoke('admin_menu', 'suppress');

   However, this needs to happen as early as possible in the page request, so
   placing it in the theming layer (resp. a page template file) is too late.
   Ideally, the function is called in hook_init() in a custom module.  If you do
   not have a custom module, placing it into some conditional code at the top of
   template.php may work out, too.


-- CONTACT --

Current maintainers:
* Daniel F. Kudwien (sun) - dev@unleashedmind.com
* Stefan M. Kudwien (smk-ka) - dev@unleashedmind.com

This project has been sponsored by:
* UNLEASHED MIND
  Specialized in consulting and planning of Drupal powered sites, UNLEASHED
  MIND offers installation, development, theming, customization, and hosting
  to get you started. Visit http://www.unleashedmind.com for more information.

* Lullabot
  Friendly Drupal experts providing professional consulting & education
  services. Visit http://www.lullabot.com for more information.

* Acquia
  Commercially Supported Drupal. Visit http://acquia.com for more information.

File

README.txt
View source
  1. -- SUMMARY --
  2. The Drupal administration menu module displays the entire administrative
  3. menu tree (and most local tasks) in a drop-down menu, providing administrators
  4. one- or two-click access to most pages. Other modules may also add menu
  5. links to administration menu using hook_admin_menu().
  6. For a full description of the module, visit the project page:
  7. http://drupal.org/project/admin_menu
  8. To submit bug reports and feature suggestions, or to track changes:
  9. http://drupal.org/project/issues/admin_menu
  10. -- REQUIREMENTS --
  11. None.
  12. -- INSTALLATION --
  13. * Install as usual, see http://drupal.org/node/70151 for further information.
  14. -- CONFIGURATION --
  15. * Configure user permissions in Administer >> User management >> Access control
  16. >> admin_menu module:
  17. - access administration menu
  18. Users in roles with the "access administration menu" permission will see
  19. the administration menu at the top of each page.
  20. - display drupal links
  21. Users in roles with the "display drupal links" permission will receive
  22. links to Drupal.org issue queues for all enabled contributed modules. The
  23. issue queue links appear under the administration menu icon.)
  24. Note that the menu items displayed in the administration Menu depend on the
  25. actual permissions of the viewing user. For example, the "User management"
  26. menu item is not displayed to a user who is not a member of a role with the
  27. "administer access control" and "administer users" permissions.
  28. * Customize the menu settings in Administer >> Site configuration >>
  29. Administration menu.
  30. * To prevent administrative menu items from appearing twice, you may hide the
  31. "Navigation" menu block, or move the "Administer" menu items into a separate
  32. menu.
  33. -- CUSTOMIZATION --
  34. * To override the default administration menu icon, you may:
  35. 1) Disable it via CSS in your theme:
  36. body #admin-menu-icon { display: none; }
  37. 2) Alter the image by overriding the theme function:
  38. Copy the entire theme_admin_menu_icon() function into your template.php,
  39. rename it to phptemplate_admin_menu_icon() or THEMENAME_admin_menu_icon(),
  40. and customize the output according to your needs.
  41. Please bear in mind that admin_menu's output is cached. You need to clear your
  42. site's cache (probably best using Devel module, or by manually truncating the
  43. cache_menu database table) to see any changes of your theme override function.
  44. * To override the font size, add the following line to your theme's stylesheet:
  45. body #admin-menu { font-size: 10px; }
  46. -- TROUBLESHOOTING --
  47. * If the menu does not display, check the following:
  48. - Are the "access administration menu" and "access administration pages"
  49. permissions enabled for the appropriate roles?
  50. - Does your theme output the $closure variable?
  51. * If the menu is rendered behind a Flash movie object, add this property to your
  52. Flash object(s):
  53. See http://drupal.org/node/195386 for further information.
  54. -- FAQ --
  55. Q: Content management >> Create content items are not displayed, although the
  56. user has been granted access to create content. Why?
  57. A: This issue is caused by the circumstance that no other administrative menu
  58. item below Content management is visible for the user. Because of that,
  59. Drupal does not render this menu grouping item at all, and admin_menu is
  60. therefore not able to add the items below Create content.
  61. If you grant just one other permission for that user role, for example
  62. 'administer taxonomy', the whole Content management item should show up.
  63. Q: When the administration menu module is enabled, blank space is added to the
  64. bottom of my theme. Why?
  65. A: This is caused by a long list of links to module issue queues at Drupal.org.
  66. Just go to Administer >> User management >> Access control >> admin_menu and
  67. disable the permission "display drupal links" for your or all roles.
  68. Since uid 1 always has all permissions, this link list cannot be disabled
  69. for uid 1.
  70. Q: After upgrading to 5.x-2.x, admin_menu disappeared. Why?
  71. A: This should not happen. If it did, visit
  72. http:///admin/build/menu to re-generate your menu.
  73. Q: Can I configure the administration menu module to display another menu (like
  74. the Navigation menu, for instance)?
  75. A: No. As the name implies, administration menu module is for administrative
  76. menu links only. However, you can copy and paste the contents of
  77. admin_menu.css into your theme's stylesheet and replace #admin-menu with any
  78. other menu block id (#block-menu-1, for example).
  79. Q: Sometimes, the user counter displays a lot of anonymous users, but no spike
  80. of users or requests appear in Google Analytics or other tracking tools.
  81. A: If your site was concurrently spidered by search-engine robots, it may have
  82. a significant number of anonymous users for a short time. Most web tracking
  83. tools like Google Analytics automatically filter out these requests.
  84. Q: After upgrading, admin_menu disappeared. Why?
  85. A: Prior to release 5.x-1.2, Drupal Administration Menu was output in a block.
  86. Since 5.x-1.2, it is output via hook_footer(). Some custom themes may not
  87. (yet) output $closure, so admin_menu could no longer be displayed. If you
  88. decided to move the 'administer' tree into a new menu and disabled that menu
  89. block, a site could become (temporarily) unmaintainable. Either way, you
  90. should fix your theme by adding the following code in front of the closing
  91. HTML () tag:
  92. Q: After upgrading, the menu item 'administer' is no longer removed. Why?
  93. A: Prior to release 5.x-1.2, Drupal Administration Menu was output via
  94. hook_block(), which allowed to alter the global menu array. Since 5.x-1.2, it
  95. is output via hook_footer() and thus no longer able to alter the menu. As
  96. long as there will be no built-in solution in an upcoming release, you may
  97. perform the following steps as a workaround:
  98. - Create a new menu.
  99. - Edit the menu item 'administer' and select the new menu as parent.
  100. Q: I enabled "Aggregate and compress CSS files", but I found admin_menu.css is
  101. still there, is it normal?
  102. A: Yes, this is the intended behavior. Since admin_menu is only visible for
  103. logged-on administrative users, it would not make sense to load its
  104. stylesheet for all, including anonymous users.
  105. Q: Why are sub-menus not visible in Opera?
  106. A: In the Opera browser preferences under "web pages" there is an option to fit
  107. to width. By disabling this option, sub-menus in the administration menu
  108. should appear.
  109. Q: How can the administration menu be hidden on certain pages?
  110. A: You can suppress it by simply calling the following function in PHP:
  111. module_invoke('admin_menu', 'suppress');
  112. However, this needs to happen as early as possible in the page request, so
  113. placing it in the theming layer (resp. a page template file) is too late.
  114. Ideally, the function is called in hook_init() in a custom module. If you do
  115. not have a custom module, placing it into some conditional code at the top of
  116. template.php may work out, too.
  117. -- CONTACT --
  118. Current maintainers:
  119. * Daniel F. Kudwien (sun) - dev@unleashedmind.com
  120. * Stefan M. Kudwien (smk-ka) - dev@unleashedmind.com
  121. This project has been sponsored by:
  122. * UNLEASHED MIND
  123. Specialized in consulting and planning of Drupal powered sites, UNLEASHED
  124. MIND offers installation, development, theming, customization, and hosting
  125. to get you started. Visit http://www.unleashedmind.com for more information.
  126. * Lullabot
  127. Friendly Drupal experts providing professional consulting & education
  128. services. Visit http://www.lullabot.com for more information.
  129. * Acquia
  130. Commercially Supported Drupal. Visit http://acquia.com for more information.