Index: core.php
===================================================================
RCS file: /cvs/drupal-contrib/contributions/docs/developer/hooks/core.php,v
retrieving revision 1.121
diff -u -r1.121 core.php
--- core.php	28 Dec 2006 02:26:19 -0000	1.121
+++ core.php	5 Jan 2007 21:27:54 -0000
@@ -561,14 +561,22 @@
  * This hook enables modules to add links to many parts of Drupal. Links
  * may be added in nodes or in the navigation block, for example.
  * 
- * The return array should be a keyed array of link entries.  Each
- * link entry is an array with parameters matching the parameters to the
- * l() function.  At minimum, each entry should include title (which will 
- * be displayed as the text of the link) and href (the path to which the link
- * will point).  Other common parameters include attributes (an array of 
- * additional HTML attributes for the <a> element), query (additional 
- * GET query parameters), and fragment (the name of an anchor within 
- * a page to link to).
+ * The returned array should be a keyed array of link entries. Each link can
+ * be in one of two formats.
+ *
+ * The first format will use the l() function to render the link:
+ *   - href: Required. The URL of the link.
+ *   - title: Required. The name of the link.
+ *   - attributes: Optional. See l() for usage.
+ *   - html: Optional. See l() for usage.
+ *   - query: Optional. See l() for usage.
+ *   - fragment: Optional. See l() for usage.
+ *
+ * The second format can be used for non-links. Leaving out the href index will
+ * select this format:
+ *   - title: Required. The text or HTML code to display.
+ *   - html: Optional. If not set to true, check_plain() will be run on the title
+ *   before it is displayed.
  *
  * @param $type
  *   An identifier declaring what kind of link is being requested.
@@ -592,7 +600,7 @@
         if (book_access('create', $node)) {
           $links['book_add_child'] = array(
             'title' => t('add child page'),
-            'href' => "node/add/book/parent/$node->nid"
+            'href' => "node/add/book/parent/$node->nid",
           );
         }
         if (user_access('see printer-friendly version')) {
@@ -613,6 +621,15 @@
       'attributes' => array('title' => t('go to another page')),
     );
 
+    // Example of a link that's not an anchor
+    if ($type == 'video') {
+      if (variable_get('video_playcounter', 1) && user_access('view play counter')) {
+        $links['play_counter'] = array(
+          'title' => format_plural($node->play_counter, '1 play', '@count plays'),
+        );
+      }
+    }
+
     return $links;
   }