PHPXRef 0.7 : Drupal 6 (yi-drupal) : /sites/all/modules/admin/README.txt source

[Summary view] [Print] [Text view]
   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 <body> tag:
  20  
  21     <?php if (!empty($admin)) print $admin; ?>
  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
PHP Cross Reference of Drupal 6 (yi-drupal)

/sites/all/modules/admin/ -> README.txt (source)
