book-navigation.tpl.php

  1. 7.x drupal/modules/book/book-navigation.tpl.php
  2. 6.x drupal/modules/book/book-navigation.tpl.php

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.
  • $prev_url: URL to the previous node.
  • $prev_title: Title of the previous node.
  • $parent_url: URL to the parent node.
  • $parent_title: Title of the parent node. Not printed by default. Provided as an option.
  • $next_url: URL to the next node.
  • $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_title: The book/node title of the current outline being viewed. Provided as an option. Not used by default.

See also

template_preprocess_book_navigation()

1 theme call to book-navigation.tpl.php
book_node_view in drupal/modules/book/book.module
Implements hook_node_view().
2 string references to the theme hook from book-navigation.tpl.php

Note: this list is generated by looking for the string for this theme hook, so it may include some references that are not actually using this theme hook.

book_node_view in drupal/modules/book/book.module
Implements hook_node_view().
book_theme in drupal/modules/book/book.module
Implements hook_theme().

File

drupal/modules/book/book-navigation.tpl.php
View source
  1. <?php
  2. /**
  3. * @file
  4. * Default theme implementation to navigate books.
  5. *
  6. * Presented under nodes that are a part of book outlines.
  7. *
  8. * Available variables:
  9. * - $tree: The immediate children of the current node rendered as an unordered
  10. * list.
  11. * - $current_depth: Depth of the current node within the book outline. Provided
  12. * for context.
  13. * - $prev_url: URL to the previous node.
  14. * - $prev_title: Title of the previous node.
  15. * - $parent_url: URL to the parent node.
  16. * - $parent_title: Title of the parent node. Not printed by default. Provided
  17. * as an option.
  18. * - $next_url: URL to the next node.
  19. * - $next_title: Title of the next node.
  20. * - $has_links: Flags TRUE whenever the previous, parent or next data has a
  21. * value.
  22. * - $book_id: The book ID of the current outline being viewed. Same as the node
  23. * ID containing the entire outline. Provided for context.
  24. * - $book_url: The book/node URL of the current outline being viewed. Provided
  25. * as an option. Not used by default.
  26. * - $book_title: The book/node title of the current outline being viewed.
  27. * Provided as an option. Not used by default.
  28. *
  29. * @see template_preprocess_book_navigation()
  30. *
  31. * @ingroup themeable
  32. */
  33. ?>
  34. <?php if ($tree || $has_links): ?>
  35. <div id="book-navigation-<?php print $book_id; ?>" class="book-navigation">
  36. <?php print $tree; ?>
  37. <?php if ($has_links): ?>
  38. <div class="page-links clearfix">
  39. <?php if ($prev_url): ?>
  40. <a href="<?php print $prev_url; ?>" class="page-previous" title="<?php print t('Go to previous page'); ?>"><?php print t('‹ ') . $prev_title; ?></a>
  41. <?php endif; ?>
  42. <?php if ($parent_url): ?>
  43. <a href="<?php print $parent_url; ?>" class="page-up" title="<?php print t('Go to parent page'); ?>"><?php print t('up'); ?></a>
  44. <?php endif; ?>
  45. <?php if ($next_url): ?>
  46. <a href="<?php print $next_url; ?>" class="page-next" title="<?php print t('Go to next page'); ?>"><?php print $next_title . t(' ›'); ?></a>
  47. <?php endif; ?>
  48. </div>
  49. <?php endif; ?>
  50. </div>
  51. <?php endif; ?>

Related topics