diff options
Diffstat (limited to 'modules/book/book-navigation.tpl.php')
| -rw-r--r-- | modules/book/book-navigation.tpl.php | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/modules/book/book-navigation.tpl.php b/modules/book/book-navigation.tpl.php index 5d8e9aa7f..7a6b34c75 100644 --- a/modules/book/book-navigation.tpl.php +++ b/modules/book/book-navigation.tpl.php @@ -2,14 +2,15 @@ /** * @file - * Default theme implementation to navigate books. Presented under nodes that - * are a part of book outlines. + * Default theme implementation to navigate books. + * + * Presented under nodes that are a part of book outlines. * * Available variables: - * - $tree: The immediate children of the current node rendered as an - * unordered list. - * - $current_depth: Depth of the current node within the book outline. - * Provided for context. + * - $tree: The immediate children of the current node rendered as an unordered + * list. + * - $current_depth: Depth of the current node within the book outline. Provided + * for context. * - $prev_url: URL to the previous node. * - $prev_title: Title of the previous node. * - $parent_url: URL to the parent node. @@ -19,14 +20,16 @@ * - $next_title: Title of the next node. * - $has_links: Flags TRUE whenever the previous, parent or next data has a * value. - * - $book_id: The book ID of the current outline being viewed. Same as the - * node ID containing the entire outline. Provided for context. - * - $book_url: The book/node URL of the current outline being viewed. - * Provided as an option. Not used by default. + * - $book_id: The book ID of the current outline being viewed. Same as the node + * ID containing the entire outline. Provided for context. + * - $book_url: The book/node URL of the current outline being viewed. Provided + * as an option. Not used by default. * - $book_title: The book/node title of the current outline being viewed. * Provided as an option. Not used by default. * * @see template_preprocess_book_navigation() + * + * @ingroup themeable */ ?> <?php if ($tree || $has_links): ?> |