README.txt 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Installation
  6. * Configuration
  7. * Customization
  8. * Troubleshooting
  9. * FAQ
  10. * Maintainers
  11. INTRODUCTION
  12. ------------
  13. The Administration menu module displays the entire administrative menu tree (and
  14. most local tasks) in a drop-down menu, providing administrators one- or
  15. two-click access to most pages. Other modules may also add menu links to the
  16. menu using hook_admin_menu_output_alter().
  17. For a full description of the project visit the project page:
  18. http://drupal.org/project/admin_menu
  19. To submit bug reports and feature suggestions, or to track changes:
  20. http://drupal.org/project/issues/admin_menu
  21. REQUIREMENTS
  22. ------------
  23. No special requirements
  24. INSTALLATION
  25. ------------
  26. Install as you would normally install a contributed Drupal. See:
  27. https://drupal.org/documentation/install/modules-themes/modules-7 for further
  28. information.
  29. * You likely want to disable Toolbar module, since its output clashes with
  30. Administration menu.
  31. CONFIGURATION
  32. -------------
  33. * Configure user permissions in Administration » People » Permissions:
  34. - Use the administration pages and help (System module)
  35. The top-level administration categories require this permission to be
  36. accessible. The administration menu will be empty unless this permission is
  37. granted.
  38. - Access administration menu
  39. Users in roles with the "Access administration menu" permission will see
  40. the administration menu at the top of each page.
  41. - Display Drupal links
  42. Users in roles with the "Display drupal links" permission will receive
  43. links to drupal.org issue queues for all enabled contributed modules. The
  44. issue queue links appear under the administration menu icon.
  45. Note that the menu items displayed in the administration menu depend on the
  46. actual permissions of the viewing user. For example, the "People" menu item
  47. is not displayed to a user who is not a member of a role with the
  48. "Administer users" permission.
  49. * Customize the menu settings in Administration » Configuration and modules »
  50. Administration » Administration menu.
  51. * To prevent administrative menu items from appearing twice, you may hide the
  52. "Management" menu block.
  53. CUSTOMIZATION
  54. -------------
  55. * To override the default administration menu icon, you may:
  56. 1) Disable it via CSS in your theme:
  57. body #admin-menu-icon { display: none; }
  58. 2) Alter the image by overriding the theme function:
  59. Copy the entire theme_admin_menu_icon() function into your template.php,
  60. rename it to phptemplate_admin_menu_icon() or THEMENAME_admin_menu_icon(),
  61. and customize the output according to your needs.
  62. Remember that the output of the administration menu is cached. To see changes
  63. from your theme override function, you must clear your site cache (via
  64. the "Flush all caches" link on the menu).
  65. * To override the font size, add the following line to your theme's stylesheet:
  66. body #admin-menu { font-size: 10px; }
  67. TROUBLESHOOTING
  68. -------------
  69. * If the menu does not display, check the following:
  70. - Are the "Access administration menu" and "Use the administration pages and
  71. help" permissions enabled for the appropriate roles?
  72. - Does html.tpl.php of your theme output the $page_bottom variable?
  73. * If the menu is rendered behind a Flash movie object, add this property to your
  74. Flash object(s):
  75. <param name="wmode" value="transparent" />
  76. See http://drupal.org/node/195386 for further information.
  77. FAQ
  78. ---
  79. Q: When the administration menu module is enabled, blank space is added to the
  80. bottom of my theme. Why?
  81. A: This is caused by a long list of links to module issue queues at Drupal.org.
  82. Use Administer >> User management >> Permissions to disable the "display
  83. drupal links" permission for all appropriate roles. Note that since UID 1
  84. automatically receives all permissions, the list of issue queue links cannot
  85. be disabled for UID 1.
  86. Q: After upgrading to 6.x-1.x, the menu disappeared. Why?
  87. A: You may need to regenerate your menu. Visit
  88. http://example.com/admin/build/modules to regenerate your menu (substitute
  89. your site name for example.com).
  90. Q: Can I configure the administration menu module to display another menu (like
  91. the Navigation menu, for instance)?
  92. A: No. As the name implies, administration menu module is for administrative
  93. menu links only. However, you can copy and paste the contents of
  94. admin_menu.css into your theme's stylesheet and replace #admin-menu with any
  95. other menu block id (#block-menu-1, for example).
  96. Q: Sometimes, the user counter displays a lot of anonymous users, but no spike
  97. of users or requests appear in Google Analytics or other tracking tools.
  98. A: If your site was concurrently spidered by search-engine robots, it may have
  99. a significant number of anonymous users for a short time. Most web tracking
  100. tools like Google Analytics automatically filter out these requests.
  101. Q: I enabled "Aggregate and compress CSS files", but admin_menu.css is still
  102. there. Is this normal?
  103. A: Yes, this is the intended behavior. the administration menu module only
  104. loads its stylesheet as needed (i.e., on page requests by logged-on,
  105. administrative users).
  106. Q: Why are sub-menus not visible in Opera?
  107. A: In the Opera browser preferences under "web pages" there is an option to fit
  108. to width. By disabling this option, sub-menus in the administration menu
  109. should appear.
  110. Q: How can the administration menu be hidden on certain pages?
  111. A: You can suppress it by simply calling the following function in PHP:
  112. module_invoke('admin_menu', 'suppress');
  113. However, this needs to happen as early as possible in the page request, so
  114. placing it in the theming layer (resp. a page template file) is too late.
  115. Ideally, the function is called in hook_init() in a custom module. If you
  116. do not have a custom module, placing it into some conditional code at the
  117. top of template.php may work out, too.
  118. Q: What does the "Administration Development Tools" module do?
  119. A: The Administration Development Tools adds a jQuery Debugger which allows
  120. a developer to debug and inspect arbitrary data/variables in Firebug's
  121. console, and also to access them again in the global window object
  122. (optionally using a named identifier, e.g. window.debug.myValue).
  123. Chainable via jQuery. Especially useful for re-accessing and debugging
  124. selected data via Firebug's console.
  125. MAINTAINERS
  126. -----------
  127. Current maintainers:
  128. * Daniel F. Kudwien (sun) - http://drupal.org/user/54136
  129. * Peter Wolanin (pwolanin) - http://drupal.org/user/49851
  130. * Stefan M. Kudwien (smk-ka) - http://drupal.org/user/48898
  131. * Dave Reid (Dave Reid) - http://drupal.org/user/53892
  132. * Truls S. Yggeseth (truls1502) - http://drupal.org/user/325866
  133. * Sebastian Siemssen (fubhy) - https://www.drupal.org/user/761344
  134. Major rewrite for Drupal 6 by Peter Wolanin (pwolanin).
  135. This project has been sponsored by:
  136. * UNLEASHED MIND
  137. Specialized in consulting and planning of Drupal powered sites, UNLEASHED
  138. MIND offers installation, development, theming, customization, and hosting
  139. to get you started. Visit http://www.unleashedmind.com for more information.
  140. * Lullabot
  141. Friendly Drupal experts providing professional consulting & education
  142. services. Visit http://www.lullabot.com for more information.
  143. * Acquia
  144. Commercially Supported Drupal. Visit http://acquia.com for more information.