You are here

Home » API reference » Admin 6

README.txt in Admin 6

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 7.2 README.txt
DESCRIPTION
===========

The admin module provides UI improvements to the standard Drupal admin
interface. It implements some of the ideas being explored for
usability improvements in Drupal 7.


INSTALLATION
============

1. Install & enable the module.

2. If you do not have an admin theme selected, admin will provide its
   admin theme as the default.

3. To make use of the admin header within your theme, you must add the
   following line to your theme's page.tpl.php file immediately
   following the <body> tag:

   <?php if (!empty($admin)) print $admin; ?>

4. Admin makes 2 different permissions available. In addition to using
   these permissions to enable/disable admin features for different
   roles, specific themes can specify their compatibility (see
   'Theme compatibility' below).

   'admin inline': Grant users access to inline contextual links for
     editing nodes, views, blocks, etc.

   'admin menu': Grant users access to the admin header/menu.


GRAPHICS
========

The icons used by the admin module were designed by Young Hahn and
AJ Ashton specifically for use with Drupal's admin interface.
The iconset is available for use under a dual GPL/BSD license,
meaning you may choose the license which is most appropriate for
your project.


THEME COMPATIBILITY
===================

A theme can specify its compatibility with different features
provided by the admin module in its .info file. If no compatibility
flag is set, admin assumes the theme is compatible with all of its
features.

To disable the admin menu when using your theme:

  admin[admin menu] = 0

To disable the admin inline links when using your theme:

  admin[admin inline] = 0


API & HOOKS
===========

There is a small API included in admin for adding inline links to
various objects. The hooks are parallel to hook_link() and
hook_link_alter(), except that they are used for admin inline links
only. The admin-edit, admin-delete, and admin-configure classes
are available for rendering links with icons (more to come).

- hook_admin_link($type, $object)

  Should return a $links array suitable for theming by theme_links().

- hook_admin_link_alter(&$links, $type, $object)

  A typical drupal_alter() hook that takes the links array, as well
  as object type and object as parameters.


CONTRIBUTORS
============
Young Hahn young@developmentseed.org
AJ Ashton aj@developmentseed.org

File

README.txt
View source 
  1. DESCRIPTION

  2. ===========

  3. 

  4. The admin module provides UI improvements to the standard Drupal admin

  5. interface. It implements some of the ideas being explored for

  6. usability improvements in Drupal 7.

  7. 

  8. 

  9. INSTALLATION

  10. ============

  11. 

  12. 1. Install & enable the module.

  13. 

  14. 2. If you do not have an admin theme selected, admin will provide its

  15.    admin theme as the default.

  16. 

  17. 3. To make use of the admin header within your theme, you must add the

  18.    following line to your theme's page.tpl.php file immediately

  19.    following the  tag:

  20. 

  21.    

  22. 

  23. 4. Admin makes 2 different permissions available. In addition to using

  24.    these permissions to enable/disable admin features for different

  25.    roles, specific themes can specify their compatibility (see

  26.    'Theme compatibility' below).

  27. 

  28.    'admin inline': Grant users access to inline contextual links for

  29.      editing nodes, views, blocks, etc.

  30. 

  31.    'admin menu': Grant users access to the admin header/menu.

  32. 

  33. 

  34. GRAPHICS

  35. ========

  36. 

  37. The icons used by the admin module were designed by Young Hahn and

  38. AJ Ashton specifically for use with Drupal's admin interface.

  39. The iconset is available for use under a dual GPL/BSD license,

  40. meaning you may choose the license which is most appropriate for

  41. your project.

  42. 

  43. 

  44. THEME COMPATIBILITY

  45. ===================

  46. 

  47. A theme can specify its compatibility with different features

  48. provided by the admin module in its .info file. If no compatibility

  49. flag is set, admin assumes the theme is compatible with all of its

  50. features.

  51. 

  52. To disable the admin menu when using your theme:

  53. 

  54.   admin[admin menu] = 0

  55. 

  56. To disable the admin inline links when using your theme:

  57. 

  58.   admin[admin inline] = 0

  59. 

  60. 

  61. API & HOOKS

  62. ===========

  63. 

  64. There is a small API included in admin for adding inline links to

  65. various objects. The hooks are parallel to hook_link() and

  66. hook_link_alter(), except that they are used for admin inline links

  67. only. The admin-edit, admin-delete, and admin-configure classes

  68. are available for rendering links with icons (more to come).

  69. 

  70. - hook_admin_link($type, $object)

  71. 

  72.   Should return a $links array suitable for theming by theme_links().

  73. 

  74. - hook_admin_link_alter(&$links, $type, $object)

  75. 

  76.   A typical drupal_alter() hook that takes the links array, as well

  77.   as object type and object as parameters.

  78. 

  79. 

  80. CONTRIBUTORS

  81. ============

  82. Young Hahn young@developmentseed.org

  83. AJ Ashton aj@developmentseed.org