book.module

• Drupal 5
• Drupal 6
• Drupal 7

• View documentation
• View source

Version

1.454.2.5 (checked in on 2008/07/03 at 06:38:46 by dries)

Description

Allows users to structure the pages of a site in a hierarchy or outline.

Functions

Name	Description
book_block	Implementation of hook_block().
book_build_active_trail	Build an active trail to show in the breadcrumb.
book_children	Format the menu links for the child pages of the current page.
book_export_traverse	Traverse the book tree to build printable or exportable output.
book_form_alter	Implementation of hook_form_alter(). Adds the book fieldset to the node form. See alsobook_pick_book_submit()
book_form_node_delete_confirm_alter	Form altering function for the confirm form for a single node deletion.
book_get_books	Returns an array of all books.
book_get_flat_menu	Get the book menu tree for a page, and return it as a linear array.
book_help	Implementation of hook_help().
book_init	Implementation of hook_init(). Add's the book module's CSS.
book_link	Implementation of hook_link().
book_link_load	Like menu_link_load(), but adds additional data from the {book} table.
book_menu	Implementation of hook_menu().
book_menu_name	Generate the corresponding menu name from a book ID.
book_menu_subtree_data	Get the data representing a subtree of the book hierarchy.
book_next	Fetches the menu link for the next page of the book.
book_nodeapi	Implementation of hook_nodeapi().
book_node_export	Generates printer-friendly HTML for a node. See alsobook_export_traverse()
book_node_type	Implementation of hook_node_type().
book_perm	Implementation of hook_perm().
book_prev	Fetches the menu link for the previous page of the book.
book_theme	Implementation of hook_theme()
book_toc	Returns an array of book pages in table of contents order.
book_type_is_allowed	Determine if a given node type is in the list of types allowed for books.
book_update_bid	Update the bid for a page and its children when it is moved to a new book.
template_preprocess_book_export_html	Process variables for book-export-html.tpl.php.
template_preprocess_book_navigation	Process variables for book-navigation.tpl.php.
template_preprocess_book_node_export_html	Process variables for book-node-export-html.tpl.php.
theme_book_title_link	Generate the HTML output for a link to a book title when used as a block title.
_book_add_form_elements	Build the common elements of the book form for the node and outline forms.
_book_flatten_menu	Recursive helper function for book_get_flat_menu().
_book_link_defaults	Return an array with default values for a book link.
_book_outline_access	Menu item access callback - determine if the outline tab is accessible.
_book_outline_remove_access	Menu item access callback - determine if the user can remove nodes from the outline.
_book_parent_depth_limit	Find the depth limit for items in the parent select.
_book_parent_select	Build the parent selection form element for the node form or outline tab
_book_toc_recurse	A recursive helper function for book_toc().
_book_update_outline	Common helper function to handles additions and updates to the book outline.