- * 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.
- *
+ *
+ * The function delegates the generation of output to helper functions.
+ * The function name is derived by prepending 'book_export_' to the
+ * given output type. So, e.g., a type of 'html' results in a call to
+ * the function book_export_html().
+ *
* @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
+ * The following types are currently supported:
+ * html: HTML (printer friendly output)
+ * dxml: Drupal book XML
+ * opml: 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 = 0) {
- global $base_url;
$type = drupal_strtolower($type);
$depth = _book_get_depth($nid);
- switch ($type) {
- case 'docbook':
- $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;
- break;
- case 'html':
- 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";
- }
- $html = "\n";
- $html .= '';
- $html .= "\n
". check_plain($node->title) ."\n";
- $html .= '
';
- $html .= '
' . "\n";
- $html .= "\n";
- $html .= "\n\n". $output . "\n\n\n";
- print $html;
- break;
- case 'opml':
- $output .= book_recurse($nid, $depth, 'book_node_visitor_opml_pre', 'book_node_visitor_opml_post');
- $ompl = "\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;
- break;
+
+ $export_function = 'book_export_' . $type;
+
+ if (function_exists($export_function)) {
+ print call_user_func($export_function, $nid, $depth);
}
}
/**
+ * This function is called by book_export() to generate HTML for export.
+ *
+ * The given node is /embedded to its absolute depth in a top level
+ * section/. For example, a child node with depth 2 in the hierarchy
+ * is contained in (otherwise empty) <div> 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.
+ *
+ * @param nid
+ * - an integer representing the node id (nid) of the node to export
+ * @param depth
+ * - an integer giving the depth in the book hierarchy of the node
+ which is to be exported
+ * @return
+ * - the HTML representing the node and its children in the book hierarchy
+*/
+function book_export_html($nid, $depth) {
+ global $base_url;
+ 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";
+ }
+ $html = "\n";
+ $html .= '';
+ $html .= "\n
". check_plain($node->title) ."\n";
+ $html .= '
';
+ $html .= '
' . "\n";
+ $html .= "\n";
+ $html .= "\n\n". $output . "\n\n\n";
+ return $html;
+}
+
+/**
+ * This function is called by book_export() to generate DXML for export.
+ *
+ * The function also calls drupal_set_header() to set a header suitable
+ * for returning XML content.
+ *
+ * @param nid
+ * - an integer representing the node id (nid) of the node to export
+ * @param depth
+ * - an integer giving the depth in the book hierarchy of the node
+ which is to be exported
+ * @return
+ * - the DXML representing the node and its children in the book hierarchy
+*/
+function book_export_dxml($nid, $depth) {
+ drupal_set_header('Content-Type: text/xml; charset=utf-8');
+ $xml = "\n";
+ $xml .= "\n";
+ $xml .= book_recurse($nid, $depth, 'book_node_visitor_dxml_pre', 'book_node_visitor_dxml_post');
+ return $xml;
+}
+
+/**
+ * This function is called by book_export() to generate OPML for export.
+ *
+ * Unlike HTML output, OPML output is not embedded to its absolute
+ * level in the parent book. The exported node will be the top level
+ * element in the OPML outline.
+ *
+ * The function also calls drupal_set_header() to set a header suitable
+ * for returning XML content.
+ *
+ * @param nid
+ * - an integer representing the node id (nid) of the node to export
+ * @param depth
+ * - an integer giving the depth in the book hierarchy of the node
+ which is to be exported
+ * @return
+ * - the OPML representing the node and its children in the book
+ * hierarchy. Only titles are exported.
+
+*/
+function book_export_opml($nid, $depth) {
+ drupal_set_header('Content-Type: text/xml; charset=utf-8');
+ $output .= book_recurse($nid, $depth, 'book_node_visitor_opml_pre', 'book_node_visitor_opml_post');
+ $ompl = "\n";
+ $opml .= "
\n";
+ $opml .= "\n". check_plain($node->title) ."\n";
+ $opml .= "\n\n". $output . "\n\n\n";
+ return $opml;
+}
+
+/**
* 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.
+ * @param nid
+ * - the nid of 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.
@@ -835,91 +878,102 @@ function book_node_visitor_html_post($no
return "
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.
+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 Drupal XML (for offline editing, or to move books between sites) by selecting the \"export Drupal XML\" link. 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.