- Patch #529316 by jhodgdon: fixed and improved hook_help() documentation.

1 files changed, 27 insertions, 30 deletions

diff --git a/modules/help/help.api.php b/modules/help/help.api.php
index 7c7f05cf8..cc555fdd4 100644
--- a/modules/help/help.api.php
+++ b/modules/help/help.api.php
@@ -15,49 +15,46 @@
  * Provide online user help.
  *
  * By implementing hook_help(), a module can make documentation
- * available to the engine or to other modules. All user help should be
- * returned using this hook; developer help should be provided with
- * Doxygen/api.module comments.
+ * available to the user for the module as a whole, or for specific paths.
+ * Help for developers should usually be provided via function
+ * header comments in the code, or in special API example files.
+ *
+ * For a detailed usage example, see page_example.module.
  *
  * @param $path
- *   A Drupal menu router path the help is being requested for, e.g.
- *   admin/node or user/edit. If the router path includes a % wildcard,
- *   then this will appear in the path - for example all node pages will
- *   have the path node/% or node/%/view.
- *   Also recognizes special descriptors after a "#" sign. Some examples:
+ *   The router menu path, as defined in hook_menu(), for the help that
+ *   is being requested; e.g., 'admin/node' or 'user/edit'. If the router path
+ *   includes a % wildcard, then this will appear in $path; for example,
+ *   node pages would have $path equal to 'node/%' or 'node/%/view'. Your hook
+ *   implementation may also be called with special descriptors after a 
+ *   "#" sign. Some examples:
  *   - admin/help#modulename
- *     The module's help text, displayed on the admin/help page and through
- *     the module's individual help link.
+ *     The main module help text, displayed on the admin/help/modulename
+ *     page and linked to from the admin/help page.
  *   - user/help#modulename
  *     The help for a distributed authorization module (if applicable).
  * @param $arg
- *   An array that corresponds to the return of the arg() function - if a module
- *   needs to provide help for a page with additional parameters after the
- *   Drupal path or help for a specific value for a wildcard in the path, then
- *   the values in this array can be referenced. For example you could provide
- *   help for user/1 by looking for the path user/% and $arg[1] == '1'. This
- *   array should always be used rather than directly invoking arg(). Note that
- *   depending on which module is invoking hook_help, $arg may contain only,
- *   empty strings. Regardless, $arg[0] to $arg[11] will always be set.
+ *   An array that corresponds to the return value of the arg() function, for
+ *   modules that want to provide help that is specific to certain values
+ *   of wildcards in $path. For example, you could provide help for the path
+ *   'user/1' by looking for the path 'user/%' and $arg[1] == '1'. This
+ *   array should always be used rather than directly invoking arg(), because
+ *   your hook implementation may be called for other purposes besides building
+ *   the current page's help. Note that depending on which module is invoking
+ *   hook_help, $arg may contain only empty strings. Regardless, $arg[0] to 
+ *   $arg[11] will always be set.
  * @return
- *   A localized string containing the help text. Every web link, l(), or
- *   url() must be replaced with %something and put into the final t()
- *   call:
- *   $output .= 'A role defines a group of users that have certain
- *     privileges as defined in %permission.';
- *   $output = t($output, array('%permission' => l(t('user permissions'),
- *     'admin/config/people/permissions')));
- *
- * For a detailed usage example, see page_example.module.
+ *   A localized string containing the help text.
  */
 function hook_help($path, $arg) {
   switch ($path) {
+    // Main module help for the block module
     case 'admin/help#block':
-      return '<p>' . t('Blocks are boxes of content that may be rendered into certain regions of your web pages, for example, into sidebars. Blocks are usually generated automatically by modules (e.g., Recent Forum Topics), but administrators can also define custom blocks.') . '</p>';
+      return '<p>' . t('Blocks are boxes of content rendered into an area, or region, of a web page. The default theme Garland, for example, implements the regions "left sidebar", "right sidebar", "content", "header", and "footer", and a block may appear in any one of these areas. The <a href="@blocks">blocks administration page</a> provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions.', array('@blocks' => url('admin/structure/block'))) . '</p>';
 
+    // Help for another path in the block module
     case 'admin/structure/block':
-      return t('<p>Blocks are boxes of content that may be rendered into certain regions of your web pages, for example, into sidebars. They are usually generated automatically by modules, but administrators can create blocks manually.</p>
-<p>You can configure the behavior of each block (for example, specifying on which pages and for what users it will appear) by clicking the "configure" link for each block.</p>');
+      return '<p>' . t('This page provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions. Since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis. Remember that your changes will not be saved until you click the <em>Save blocks</em> button at the bottom of the page.') . '</p>';
   }
 }