';
if ($tree = book_tree($node->nid)) {
$output .= '
'. $tree .'
';
}
if ($prev = book_prev($node)) {
$links .= '
';
$links .= l(t('previous'), 'node/'. $prev->nid, array('title' => t('View the previous page.')));
$links .= '
';
$titles .= '
'. check_plain($prev->title) .'
';
}
else {
$links .= '
'; // Make an empty div to fill the space.
}
if ($next = book_next($node)) {
$links .= '
';
$links .= l(t('next'), 'node/'. $next->nid, array('title' => t('View the next page.')));
$links .= '
';
$titles .= '
'. check_plain($next->title) .'
';
}
else {
$links .= '
'; // Make an empty div to fill the space.
}
if ($node->parent) {
$links .= '
';
$links .= l(t('up'), 'node/'. $node->parent, array('title' => t('View this page\'s parent section.')));
$links .= '
';
}
$output .= '
';
$output .= '
'. $links .'
';
$output .= '
'. $titles .'
';
$output .= '
';
$output .= '
* elements corresponding to depth 0 and depth 1. This is intended to
* support WYSIWYG output - e.g., level 3 sections always look like
* level 3 sections, no matter their depth relative to the node
* selected to be exported as printer-friendly HTML.
*
* DocBook XML and OPML outputs do not attempt to embed a node to its
* absolute level in the parent book.
* For DocBook output, the exported node will be a document fragment
* unless the node is a level 0 node (book), specifically
*
* - a for level 1 elements,
* - a
*
*
* For OPML output, the exported node will be the top level element
* in the OPML outline.
*
* @param type
* - a string encoding the type of output requested.
* The following types are supported:
* 1) HTML (printer friendly output)
* 2) DocBook XML
* 3) OPML (Outline Processor Markup Language) outlines
* @param nid
* - an integer representing the node id (nid) of the node to export
*
*/
function book_export($type = 'html', $nid = FALSE) {
$type = drupal_strtolower($type);
$node = node_load($nid);
if ($node) {
$depth = _book_get_depth($nid);
switch ($type) {
case 'docbook':
if (user_access('export books')) {
$xml = "\n";
$xml .= "\n";
$xml .= book_recurse($nid, $depth, 'book_node_visitor_xml_pre', 'book_node_visitor_xml_post');
drupal_set_header('Content-Type: text/xml; charset=utf-8');
print $xml;
}
else {
drupal_access_denied();
}
break;
case 'html':
if (user_access('see printer-friendly version')) {
for ($i = 1; $i < $depth; $i++) {
$output .= "
\n";
}
$output .= book_recurse($nid, $depth, 'book_node_visitor_html_pre', 'book_node_visitor_html_post');
for ($i = 1; $i < $depth; $i++) {
$output .= "
\n";
}
print theme('book_export_html', check_plain($node->title), $output);
}
else {
drupal_access_denied();
}
break;
case 'opml':
if (user_access('export books')) {
$output .= book_recurse($nid, $depth, 'book_node_visitor_opml_pre', 'book_node_visitor_opml_post');
$opml = "\n";
$opml .= "
\n";
$opml .= "\n". check_plain($node->title) ."\n";
$opml .= "\n\n". $output . "\n\n\n";
drupal_set_header('Content-Type: text/xml; charset=utf-8');
print $opml;
}
else {
drupal_access_denied();
}
break;
default:
drupal_not_found();
}
}
else {
drupal_not_found();
}
}
/**
* How the book's HTML export should be themed
*
* @ingroup themeable
*/
function theme_book_export_html($title, $content) {
global $base_url;
$html = "\n";
$html .= '';
$html .= "\n
". $title ."\n";
$html .= '
';
$html .= '
' . "\n";
$html .= "\n";
$html .= "\n\n". $content . "\n\n\n";
return $html;
}
/**
* Given a node, this function returns the depth of the node in its hierarchy.
* A root node has depth 1, and children of a node of depth n have depth (n+1).
*
* @param node
* - the node whose depth to compute.
* @return
* - the depth of the given node in its hierarchy. Returns 0 if the node
* does not exist or is not part of a book hierarchy.
*/
function _book_get_depth($nid) {
$depth = 0;
if ($nid) {
while ($nid) {
$result = db_query(db_rewrite_sql('SELECT b.parent FROM {book} b WHERE b.nid = %d'), $nid);
$obj = db_fetch_object($result);
$parent = $obj->parent;
if ($nid == $parent->parent) {
$nid = 0;
}
else {
$nid = $parent;
}
$depth++;
}
return $depth;
}
else {
return 0;
}
}
/**
* Traverses the book tree. Applies the $visit_pre() callback to each
* node, is called recursively for each child of the node (in weight,
* title order). Finally appends the output of the $visit_post()
* callback to the output before returning the generated output.
*
* @param nid
* - the node id (nid) of the root node of the book hierarchy.
* @param depth
* - the depth of the given node in the book hierarchy.
* @param visit_pre
* - a function callback to be called upon visiting a node in the tree
* @param visit_post
* - a function callback to be called after visiting a node in the tree,
* but before recursively visiting children.
* @return
* - the output generated in visiting each node
*/
function book_recurse($nid = 0, $depth = 1, $visit_pre, $visit_post) {
$result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.status = 1 AND n.nid = %d AND n.moderate = 0 ORDER BY b.weight, n.title'), $nid);
while ($page = db_fetch_object($result)) {
// Load the node:
$node = node_load($page->nid);
if ($node) {
if (function_exists($visit_pre)) {
$output .= call_user_func($visit_pre, $node, $depth, $nid);
}
else {
$output .= book_node_visitor_html_pre($node, $depth, $nid);
}
$children = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.status = 1 AND b.parent = %d AND n.moderate = 0 ORDER BY b.weight, n.title'), $node->nid);
while ($childpage = db_fetch_object($children)) {
$childnode = node_load($childpage->nid);
if ($childnode->nid != $node->nid) {
$output .= book_recurse($childnode->nid, $depth+1, $visit_pre, $visit_post);
}
}
if (function_exists($visit_post)) {
$output .= call_user_func($visit_post, $node, $depth);
}
else { # default
$output .= book_node_visitor_html_post($node, $depth);
}
}
}
return $output;
}
/**
* Generates printer-friendly HTML for a node. This function
* is a 'pre-node' visitor function for book_recurse().
*
* @param $node
* - the node to generate output for.
* @param $depth
* - the depth of the given node in the hierarchy. This
* is used only for generating output.
* @param $nid
* - the node id (nid) of the given node. This
* is used only for generating output.
* @return
* - the HTML generated for the given node.
*/
function book_node_visitor_html_pre($node, $depth, $nid) {
// Output the content:
if (node_hook($node, 'content')) {
$node = node_invoke($node, 'content');
}
// Allow modules to change $node->body before viewing.
node_invoke_nodeapi($node, 'print', $node->body, false);
$output .= "
nid ."\" class=\"section-$depth\">\n";
$output .= "
". check_plain($node->title) ."
\n";
if ($node->body) {
$output .= $node->body;
}
return $output;
}
/**
* Finishes up generation of printer-friendly HTML after visiting a
* node. This function is a 'post-node' visitor function for
* book_recurse().
*/
function book_node_visitor_html_post($node, $depth) {
return "\n";
}
/**
* Generates XML for a given node. This function is a 'pre-node'
* visitor function for book_recurse(). The generated XML is valid
* DocBook, but each node's HTML content is wrapped in a CDATA
* section, and put inside a
element. The node body
* has an md5-hash applied; the value of this is stored as node
* metadata to allow importing code to determine if contents have
* changed. The weight of a node is also stored as metadata to
* allow the node to be properly re-imported.
*
* @param $node
* - the node to generate output for.
* @param $depth
* - the depth of the given node in the hierarchy. This
* is currently not used.
* @param $nid
* - the node id (nid) of the given node. This
* is used only for generating output (e.g., id attribute)
* @return
* - the generated XML for the given node.
*/
function book_node_visitor_xml_pre($node, $depth, $nid) {
// Output the content:
if (node_hook($node, 'content')) {
$node = node_invoke($node, 'content');
}
// Allow modules to change $node->body before viewing.
node_invoke_nodeapi($node, 'export_xml', $node->body, false);
$releaseinfo = "\n";
$releaseinfo .= "md5-hash:" . md5($node->body) . "\n";
$releaseinfo .= "weight:". $node->weight . "\n";
$releaseinfo .= "depth:". $depth . "\n";
$releaseinfo .= "\n";
$title = "". check_plain($node->title) ."\n";
// wrap the node body in a CDATA declaration
$content = "";
$content .= "body) {
$content .= $node->body;
}
$content .= "]]>";
$content .= "\n";
if ($depth == 1) {
$output .= "\n";
$output .= $title;
$output .= "\n$releaseinfo\n";
$output .= "\n";
$output .= "Preface\n";
$output .= $content;
$output .= "\n";
}
else if ($depth == 2) {
$output .= "nid ."\">\n";
$output .= "\n$releaseinfo\n";
$output .= $title;
$output .= $content;
}
else {
$output .= "nid ."\">\n";
$output .= "\n$releaseinfo\n";
$output .= $title;
$output .= $content;
}
return $output;
}
/**
* Completes the XML generation for the node. This function is a
* 'post-node' visitor function for book_recurse().
*/
function book_node_visitor_xml_post($node, $depth) {
if ($depth == 1) {
return "\n";
}
else if ($depth == 2) {
return "\n";
}
else {
return "\n";
}
}
/**
* Generates OPML for a node. This function is a 'pre-node' visitor
* function for book_recurse().
*
* @param $node
* - the node to generate output for.
* @param $depth
* - the depth of the given node in the hierarchy. This is used only
* for generating output.
* @param $nid
* - the node id (nid) of the given node. This is used only for
* generating output.
* @return
* - the OPML generated for the given node.
*/
function book_node_visitor_opml_pre($node, $depth, $nid) {
// Output the content:
if (node_hook($node, 'content')) {
$node = node_invoke($node, 'content');
}
$output .= "nid ."\"\n";
$text = check_plain($node->title);
$output .= "text=\"$text\">\n";
return $output;
}
/**
* Finishes up generation of OPML after visiting a node. This function
* is a 'post-node' visitor function for book_recurse().
*/
function book_node_visitor_opml_post($node, $depth) {
return "\n";
}
/**
* Creates a row for the 'admin' view of a book. Each row represents a page in the book, in the tree representing the book
*/
function book_admin_edit_line($node, $depth = 0) {
$form['#tree'] = TRUE;
$form[$node->nid]['title'] = array('#type' => 'textfield', '#default_value' => $node->title, '#size' => 60, '#maxlength' => 255);
$form[$node->nid]['weight'] = array('#type' => 'weight', '#default_value' => $node->weight, '#delta' => 15);
$form['depth'] = array('#value' => $depth);
$form['nid'] = array('#value' => $node->nid);
return drupal_get_form('book_admin_edit_line', $form);
}
function theme_book_admin_edit_line($form) {
$nid = $form['nid']['#value'];
return array(
''. form_render($form[$nid]['title']) .'
', form_render($form[$nid]['weight']), l(t('view'), 'node/'. $nid), l(t('edit'), 'node/'. $nid .'/edit'), l(t('delete'), 'node/'.$nid.'/delete')
);
}
function book_admin_edit_book($nid, $depth = 1) {
$result = db_query(db_rewrite_sql('SELECT n.nid, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE b.parent = %d ORDER BY b.weight, n.title'), $nid);
$rows = array();
while ($node = db_fetch_object($result)) {
$node = node_load($node->nid);
$rows[] = book_admin_edit_line($node, $depth);
$rows = array_merge($rows, book_admin_edit_book($node->nid, $depth + 1));
}
return $rows;
}
/**
* Display an administrative view of the hierarchy of a book.
*/
function book_admin_edit($nid, $depth = 0) {
$node = node_load($nid);
if ($node->nid) {
drupal_set_title(check_plain($node->title));
$header = array(t('Title'), t('Weight'), array('data' => t('Operations'), 'colspan' => '3'));
$rows[] = book_admin_edit_line($node);
$rows = array_merge($rows, book_admin_edit_book($nid));
$form['save'] = array('#type' => 'submit', '#value' => t('Save book pages'));
return theme('table', $header, $rows) . $form;
}
else {
drupal_not_found();
}
}
/**
* Saves the changes to a book made by an administrator in the book admin view.
*/
function book_admin_save($nid, $edit = array()) {
if ($nid) {
$book = node_load($nid);
foreach ($edit as $nid => $value) {
// Check to see whether the title needs updating:
$node = db_fetch_object(db_query('SELECT title, vid FROM {node} WHERE nid = %d', $nid));
if ($node->title != $value['title']) {
db_query("UPDATE {node} SET title = '%s' WHERE nid = %d", $value['title'], $nid);
db_query("UPDATE {book} SET title = '%s' WHERE vid = %d", $value['title'], $node->vid);
}
// Check to see whether the weight needs updating:
$node = db_fetch_object(db_query('SELECT b.vid, b.weight FROM {book} b INNER JOIN {node} n ON n.vid = b.vid WHERE n.nid = %d', $nid));
if ($node->weight != $value['weight']) {
db_query('UPDATE {book} SET weight = %d WHERE vid = %d', $value['weight'], $node->vid);
}
}
$message = t('The book %title has been updated.', array('%title' => theme('placeholder', $book->title)));
watchdog('content', $message);
return $message;
}
}
/**
* Menu callback; displays a listing of all orphaned book pages.
*/
function book_admin_orphan() {
$result = db_query(db_rewrite_sql('SELECT n.nid, n.title, n.status, b.parent FROM {node} n INNER JOIN {book} b ON n.vid = b.vid'));
while ($page = db_fetch_object($result)) {
$pages[$page->nid] = $page;
}
if ($pages) {
$output .= ''. t('Orphan pages') .'
';
$header = array(t('Title'), t('Weight'), array('data' => t('Operations'), 'colspan' => '3'));
foreach ($pages as $nid => $node) {
if ($node->parent && empty($pages[$node->parent])) {
$rows[] = book_admin_edit_line($node, $depth);
$rows = array_merge($rows, book_admin_edit_book($node->nid, $depth + 1));
}
}
$output .= theme('table', $header, $rows);
}
return $output;
}
/**
* Menu callback; displays the book administration page.
*/
function book_admin($nid = 0) {
$op = $_POST['op'];
$edit = $_POST['edit'];
if ($op == t('Save book pages')) {
drupal_set_message(book_admin_save($nid, $edit));
}
if ($nid) {
return book_admin_edit($nid);
}
else {
return book_admin_overview();
}
}
/**
* Returns an administrative overview of all books.
*/
function book_admin_overview() {
$result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE b.parent = 0 ORDER BY b.weight, n.title'));
while ($book = db_fetch_object($result)) {
$rows[] = array(l($book->title, "node/$book->nid"), l(t('outline'), "admin/node/book/$book->nid"));
}
$headers = array(t('Book'), t('Operations'));
return theme('table', $headers, $rows);
}
/**
* Implementation of hook_help().
*/
function book_help($section) {
switch ($section) {
case 'admin/help#book':
return t(
"The \"book\" content type is suited for creating structured, multi-page hypertexts such as site resource guides, manuals, and Frequently Asked Questions (FAQs). It permits a document to have chapters, sections, subsections, etc. Authors with suitable permissions can add pages to a collaborative book, placing them into the existing document by adding them to a table of contents menu.
Books have additional ''previous'', ''up'', and ''next'' navigation elements at the bottom of each page for moving through the text. Additional navigation may be provided by enabling the \"book navigation block\" on the
block administration page.
Users can select the \"printer-friendly version\" link visible at the bottom of a book page to generate a printer-friendly display of the page and all of its subsections. They can choose to export the page and its subsections as DocBook XML (for offline editing, or production of print or other electronic publication formats) by selecting the \"export DocBook XML\" link. DocBook export currently treats node content as preformatted text. Selecting the \"export OPML\" link will generate an outline document (titles only) in OPML format, readable by many outline editing tools. Note: it may be neccessary to shift-click on the link to save the results to a file on the local computer.
Administrators can view a book outline, from which is it possible to change the titles of sections, and their weight (thus reordering sections). From this outline, it is also possible to edit and/or delete book pages. Many content types besides pages (for example, blog entries, stories, and polls) can be added to a collaborative book by choosing the \"outline\" tab when viewing the post.
You can:
For more information, visit the online documentation.
",
array(
'%create' => url('node/add/book'),
'%collaborative-book' => url('admin/node/book'),
'%workflow' => url('admin/node/configure/types/book'),
'%book-block' => url('admin/block'),
'%permissions' => url('admin/access/permissions'),
'%book-module-help' => url('http://drupal.org/handbook/modules/book')
)
);
case 'admin/modules#description':
return t('Allows users to collaboratively author a book.');
case 'admin/node/book':
return t('
The book module offers a mean to organize content, authored by many users, in an online manual, outline or FAQ.
');
case 'admin/node/book/orphan':
return t('Pages in a book are like a tree. As pages are edited, reorganized and removed, child pages might be left with no link to the rest of the book. Such pages are referred to as "orphan pages". On this page, administrators can review their books for orphans and reattach those pages as desired.
');
case 'node/add#book':
return t("A book is a collaborative writing effort: users can collaborate writing the pages of the book, positioning the pages in the right order, and reviewing or modifying pages previously written. So when you have some information to share or when you read a page of the book and you didn't like it, or if you think a certain page could have been written better, you can do something about it.");
}
if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'outline') {
return t('The outline feature allows you to include posts in the book hierarchy.', array('%book' => url('book')));
}
}