book.module 32 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5
function book_node_name($node) {
  return t("book page");
Dries's avatar
 
Dries committed
6 7
}

Dries's avatar
 
Dries committed
8 9 10 11
function book_perm() {
  return array("maintain books");
}

Dries's avatar
 
Dries committed
12
function book_access($op, $node) {
Dries's avatar
 
Dries committed
13
  global $user;
Dries's avatar
 
Dries committed
14 15

  if ($op == "view") {
Dries's avatar
 
Dries committed
16 17 18 19 20 21 22 23
    /*
    ** Everyone can access all published book pages whether these pages
    ** are still waiting for approval or not.  We might not always want
    ** to display pages that are waiting for approval, but we take care
    ** of that problem in the book_view() function.
    */

    return $node->status;
Dries's avatar
 
Dries committed
24 25
  }

Dries's avatar
 
Dries committed
26
  if ($op == "create") {
Dries's avatar
 
Dries committed
27 28 29 30 31
    /*
    ** Only registered users can create book pages.  Given the nature
    ** of the book module this is considered to be a good/safe idea.
    */

Dries's avatar
 
Dries committed
32
    return user_access("maintain books");
Dries's avatar
 
Dries committed
33 34 35
  }

  if ($op == "update") {
Dries's avatar
 
Dries committed
36
    /*
Dries's avatar
 
Dries committed
37 38
    ** Only registered users can update book pages.  Given the nature
    ** of the book module this is considered to be a good/safe idea.
Dries's avatar
 
Dries committed
39
    ** One can only update a book page if there are no suggested updates
Dries's avatar
 
Dries committed
40 41 42 43
    ** of that page waiting for approval, when it is not a PHP-page and
    ** as long as the "create new revision"-bit is set.  That is, only
    ** updates that don't overwrite the current or pending information
    ** are allowed.
Dries's avatar
 
Dries committed
44
    */
Dries's avatar
 
Dries committed
45

Dries's avatar
 
Dries committed
46
    return user_access("maintain books") && !$node->moderate && !$node->format && $node->revision;
Dries's avatar
 
Dries committed
47
  }
Dries's avatar
 
Dries committed
48 49
}

Dries's avatar
 
Dries committed
50 51 52
/**
 * Implementation of hook_link().
 */
Dries's avatar
 
Dries committed
53
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
54 55 56

  $links = array();

Dries's avatar
 
Dries committed
57 58
  if ($type == 'page' && user_access('access content')) {
    $links[] = l(t('books'), 'book', array('title' => t('Read and contribute to the collaborative books.')));
Dries's avatar
 
Dries committed
59 60
  }

Dries's avatar
 
Dries committed
61 62 63
  if ($type == 'node' && $node->type == 'book') {
    if (book_access('update', $node)) {
      $links[] = l(t('edit this page'), "node/edit/$node->nid", array('title' => t('Suggest an update for this book page.')));
Dries's avatar
 
Dries committed
64
    }
Dries's avatar
 
Dries committed
65
    if (!$main) {
Dries's avatar
 
Dries committed
66
      $links[] = l(t('printer-friendly version'), "book/print/$node->nid", array('title' => t('Show a printer-friendly version of this book page and its sub-pages.')));
Dries's avatar
 
Dries committed
67
    }
Dries's avatar
 
Dries committed
68 69
  }

Dries's avatar
 
Dries committed
70 71
  if ($type == 'system') {
    menu('node/add/book', t('book page'), user_access('maintain books') ? 'node_page' : MENU_DENIED, 0);
Dries's avatar
 
Dries committed
72

Dries's avatar
 
Dries committed
73 74 75 76 77 78 79
    menu('admin/node/book', t('books'), user_access('administer nodes') ? 'book_admin' : MENU_DENIED, 4);
    menu('admin/node/book/orphan', t('orphan pages'), user_access('administer nodes') ? 'book_admin_orphan' : MENU_DENIED, 8);
    menu('admin/node/book/help', t('help'), user_access('administer nodes') ? 'book_help_page' : MENU_DENIED, 9);

    $result = db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = 0 ORDER BY b.weight, n.title");
    while ($book = db_fetch_object($result)) {
      menu("admin/node/book/$book->nid", t('"%title" book', array('%title' => $book->title)), user_access('administer nodes') ? 'book_admin' : MENU_DENIED);
Dries's avatar
 
Dries committed
80
    }
Dries's avatar
 
Dries committed
81
    menu('book', t('books'), user_access('access content') ? 'book_page' : MENU_DENIED, 0, MENU_HIDE);
Dries's avatar
 
Dries committed
82 83
  }

Dries's avatar
 
Dries committed
84
  return $links;
Dries's avatar
 
Dries committed
85 86
}

Dries's avatar
 
Dries committed
87 88 89 90
function book_block($op = 'list', $delta = 0) {

  // Only display this block when the user is browsing a book:
  if (arg(0) == 'book' && arg(1) == 'view' && $nid = arg(2)) {
Dries's avatar
Dries committed
91
    $page = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.nid = %d", $nid));
Dries's avatar
 
Dries committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114

    $path = book_location($page);
    $path[] = $page;

    foreach ($path as $key => $node) {
      $expand[] = $node->nid;
    }

    $title = $path[0]->title;
    $table = book_tree($expand[0], 5, $expand);
  }

  if ($op == 'list') {
    $block[0]['info'] = t('Book navigation');
  }
  else {
    $block['subject'] = $title;
    $block['content'] = $table;
  }

   return $block;
}

Dries's avatar
 
Dries committed
115
function book_load($node) {
Dries's avatar
 
Dries committed
116
  global $user;
Dries's avatar
 
Dries committed
117

Dries's avatar
 
Dries committed
118
  $book = db_fetch_object(db_query("SELECT format, parent, weight, log FROM {book} WHERE nid = %d", $node->nid));
Dries's avatar
 
Dries committed
119

Dries's avatar
 
Dries committed
120
  if (arg(1) == 'edit' && !user_access("administer nodes")) {
Dries's avatar
 
Dries committed
121 122
    /*
    ** If a user is about to update a book page, we overload some
Dries's avatar
 
Dries committed
123
    ** fields to reflect the changes.
Dries's avatar
 
Dries committed
124 125
    */

Dries's avatar
 
Dries committed
126 127 128 129 130 131 132 133
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
      $book->name = "";
    }
Dries's avatar
 
Dries committed
134
  }
Dries's avatar
 
Dries committed
135

Dries's avatar
 
Dries committed
136 137 138
  /*
  ** We set the revision field to indicate that we have to create
  ** a new revision when updating this book page.  We enable this
Dries's avatar
 
Dries committed
139
  ** always such that the "edit this page"-links appear.
Dries's avatar
 
Dries committed
140
  */
Dries's avatar
 
Dries committed
141

Dries's avatar
 
Dries committed
142
  $book->revision = 1;
Dries's avatar
 
Dries committed
143

Dries's avatar
 
Dries committed
144
  return $book;
Dries's avatar
 
Dries committed
145 146
}

Dries's avatar
 
Dries committed
147
function book_insert($node) {
Dries's avatar
 
Dries committed
148
  db_query("INSERT INTO {book} (nid, format, parent, weight, log) VALUES (%d, %d, %d, %d, '%s')", $node->nid, $node->format, $node->parent, $node->weight, $node->log);
Dries's avatar
 
Dries committed
149
}
Dries's avatar
 
Dries committed
150

Dries's avatar
 
Dries committed
151
function book_update($node) {
Dries's avatar
 
Dries committed
152
  db_query("UPDATE {book} SET format = %d, parent = %d, weight = %d, log = '%s' WHERE nid = %d", $node->format, $node->parent, $node->weight, $node->log, $node->nid);
Dries's avatar
 
Dries committed
153
}
Dries's avatar
 
Dries committed
154

155
function book_delete(&$node) {
Dries's avatar
 
Dries committed
156
  db_query("DELETE FROM {book} WHERE nid = %d", $node->nid);
Dries's avatar
 
Dries committed
157 158
}

159
function book_validate(&$node) {
160
  if ($node->format && user_access("create php content")) {
161 162 163 164 165 166
    // Do not filter PHP code, do not auto-extract a teaser
    $node->teaser = $node->body;
  }
  else {
    $node->format = 0;
  }
Dries's avatar
 
Dries committed
167

168 169 170 171 172 173
  // Set default values for non administrators:
  if (!user_access("administer nodes")) {
    $node->format = 0;
    $node->weight = 0;
    $node->revision = 1;
  }
Dries's avatar
 
Dries committed
174 175
}

Dries's avatar
 
Dries committed
176
function book_form(&$node, &$error) {
Dries's avatar
 
Dries committed
177
  global $user;
Dries's avatar
 
Dries committed
178

Dries's avatar
 
Dries committed
179
  $op = $_POST["op"];
180
  $output = form_select(t("Parent"), "parent", $node->parent, book_toc(), t("The parent subject or category the page belongs in."));
Dries's avatar
 
Dries committed
181

182 183 184 185
  if (function_exists("taxonomy_node_form")) {
    $output .= implode("", taxonomy_node_form("book", $node));
  }

Dries's avatar
 
Dries committed
186
  $output .= form_textarea(t("Body"), "body", $node->body, 60, 20, filter_tips_short());
187
  $output .= form_textarea(t("Log message"), "log", $node->log, 60, 5, t("An explanation of the additions or updates being made to help the group understand your motivations."));
Dries's avatar
 
Dries committed
188 189

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
190
    $output .= form_weight(t("Weight"), "weight", $node->weight, 15, t("The heavier pages will sink and the lighter pages will be positioned nearer the top."));
Dries's avatar
 
Dries committed
191
    if (user_access("create php content")) {
Dries's avatar
 
Dries committed
192
      $output .= form_radios("Type", "format", $node->format, array(0 => "HTML / text", 1 => "PHP"));
Dries's avatar
 
Dries committed
193
    }
Dries's avatar
 
Dries committed
194 195 196 197 198 199 200 201 202 203 204 205 206
  }
  else {
    /*
    ** If a regular user updates a book page, we create a new revision
    ** authored by that user:
    */

    $output .= form_hidden("revision", 1);
  }

  return $output;
}

Dries's avatar
 
Dries committed
207
function book_node_link($node = 0) {
Dries's avatar
 
Dries committed
208 209 210 211
  global $user;

  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
212 213 214 215 216 217 218 219

  if ($node->type != "book") {

    if ($edit["nid"]) {
      $node = node_load(array("nid" => $edit["nid"]));
    }

    if ($op == t("Add to book outline")) {
Dries's avatar
 
Dries committed
220
      db_query("INSERT INTO {book} (nid, parent, weight) VALUES (%d, %d, %d)", $node->nid, $edit["parent"], $edit["weight"]);
Dries's avatar
 
Dries committed
221
      drupal_set_message(t("added the node to the book."));
Dries's avatar
 
Dries committed
222 223 224
    }

    if ($op == t("Update book outline")) {
Dries's avatar
 
Dries committed
225
      db_query("UPDATE {book} SET parent = %d, weight = %d WHERE nid = %d", $edit["parent"], $edit["weight"], $node->nid);
Dries's avatar
 
Dries committed
226
      drupal_set_message(t("updated the book outline."));
Dries's avatar
 
Dries committed
227 228 229
    }

    if ($op == t("Remove from book outline")) {
Dries's avatar
 
Dries committed
230
      db_query("DELETE FROM {book} WHERE nid = %d", $node->nid);
Dries's avatar
 
Dries committed
231
      drupal_set_message(t("removed the node form the book."));
Dries's avatar
 
Dries committed
232 233
    }

234
    $output .= "<h3>". t("Edit book outline for node %booktitle", array("%booktitle" => "<em>$node->title</em>")) ."</h3>";
Dries's avatar
 
Dries committed
235 236

    if ($edit["nid"]) {
Dries's avatar
 
Dries committed
237
      $page = db_fetch_object(db_query("SELECT * FROM {book} WHERE nid = %d", $node->nid));
Dries's avatar
 
Dries committed
238 239

      $output .= form_select(t("Parent"), "parent", $page->parent, book_toc(), t("The parent subject or category the page belongs in."));
Dries's avatar
 
Dries committed
240
      $output .= form_weight(t("Weight"), "weight", $node->weight, 15, t("The heavier pages will sink and the lighter pages will be positioned nearer the top."));
Dries's avatar
 
Dries committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

      if ($page->nid) {
        $output .= form_submit(t("Update book outline"));
        $output .= form_submit(t("Remove from book outline"));
      }
      else {
        $output .= form_submit(t("Add to book outline"));
      }

    }
    else {
      $output .= form_submit(t("Edit book outline"));
    }

    $output .= form_hidden("nid", $node->nid);

Dries's avatar
 
Dries committed
257
    return form($output, "post", url("admin/node/book"));
Dries's avatar
 
Dries committed
258 259 260
  }
}

Dries's avatar
 
Dries committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
/*
** Return the the most recent revision that matches the specified
** conditions.
*/

function book_revision_load($page, $conditions = array()) {

  $revisions = array_reverse(node_revision_list($page));

  foreach ($revisions as $revision) {

    /*
    ** Extract the specified revision:
    */

    $node = node_revision_load($page, $revision);

    /*
    ** Check to see if the conditions are met:
    */

    $status = 1;

    foreach ($conditions as $key => $value) {
      if ($node->$key != $value) {
        $status = 0;
      }
    }

    if ($status) {
      return $node;
    }
  }
}

/*
** Return the path (call stack) to a certain book page.
*/
Dries's avatar
 
Dries committed
299
function book_location($node, $nodes = array()) {
Dries's avatar
 
Dries committed
300 301
  // TODO: eliminate the recursion

Dries's avatar
 
Dries committed
302
  $parent = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.nid = %d", $node->parent));
Dries's avatar
 
Dries committed
303 304 305 306 307 308 309
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
 
Dries committed
310
function book_location_down($node, $nodes = array()) {
Dries's avatar
 
Dries committed
311 312
  // TODO: eliminate the recursion

Dries's avatar
 
Dries committed
313
  $last_direct_child = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d ORDER BY b.weight DESC, n.title DESC", $node->nid));
Dries's avatar
 
Dries committed
314 315 316 317 318 319 320 321
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

function book_prev($node) {
Dries's avatar
 
Dries committed
322 323 324 325 326
  // if the parent is zero, we are at the start of a book so there is no previous
  if ($node->parent == 0) {
    return NULL;
  }

Dries's avatar
 
Dries committed
327
  // previous on the same level
Dries's avatar
 
Dries committed
328
  $direct_above = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') AND (b.weight < %d OR (b.weight = %d AND n.title < '%s')) ORDER BY b.weight DESC, n.title DESC", $node->parent, $node->weight, $node->weight, $node->title));
Dries's avatar
 
Dries committed
329 330 331
  if ($direct_above) {
    // get last leaf of $above
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
332 333

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
334 335 336
  }
  else {
    // direct parent
Dries's avatar
 
Dries committed
337
    $prev = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.nid = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '')", $node->parent));
Dries's avatar
 
Dries committed
338 339 340 341 342 343
    return $prev;
  }
}

function book_next($node) {
  // get first direct child
Dries's avatar
 
Dries committed
344
  $child = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight ASC, n.title ASC", $node->nid));
Dries's avatar
 
Dries committed
345 346 347 348
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
349
  // no direct child: get next for this level or any parent in this book
Dries's avatar
 
Dries committed
350
  array_push($path = book_location($node), $node); // path to root node including this one
Dries's avatar
 
Dries committed
351 352
  // loop through nodes to book root, starting with this node
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
 
Dries committed
353
    $next = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') AND (b.weight > %d OR (b.weight = %d AND n.title > '%s')) ORDER BY b.weight ASC, n.title ASC", $leaf->parent, $leaf->weight, $leaf->weight, $leaf->title));
Dries's avatar
 
Dries committed
354 355 356 357 358 359
    if ($next) {
      return $next;
    }
  }
}

Dries's avatar
 
Dries committed
360
function book_content($node, $main = 0) {
Dries's avatar
 
Dries committed
361
  $op = $_POST["op"];
Dries's avatar
 
Dries committed
362

Dries's avatar
 
Dries committed
363 364
  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
 
Dries committed
365 366
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
 
Dries committed
367 368
  */

Dries's avatar
 
Dries committed
369
  if ($op != t("Preview") && $node->moderate && arg(0) != "queue") {
Dries's avatar
 
Dries committed
370 371 372 373 374
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
375 376
  }

Dries's avatar
 
Dries committed
377 378 379 380 381
  /*
  ** Extract the page body.  If body is dynamic (using PHP code), the body
  ** will be generated.
  */

Dries's avatar
 
Dries committed
382 383 384 385 386 387 388 389 390 391 392 393
  if ($node->format == 1) {
    // Make sure only authorized users can preview PHP pages.
    if ($op == t("Preview") && !user_access("create php content")) {
      return;
    }

    ob_start();
    eval($node->body);
    $node->teaser = $node->body = ob_get_contents();
    ob_end_clean();
  }
  else {
Dries's avatar
 
Dries committed
394
    $node = node_prepare($node, $main);
Dries's avatar
 
Dries committed
395
  }
Dries's avatar
 
Dries committed
396

Dries's avatar
 
Dries committed
397 398 399
  return $node;
}

Dries's avatar
 
Dries committed
400
function book_view($node, $main = 0, $page = 0) {
Dries's avatar
 
Dries committed
401
  $node = book_content($node, $main);
Dries's avatar
 
Dries committed
402 403 404 405 406
  /*
  ** Display the node.  If not displayed on the main page, we render
  ** the node as a page in the book with extra links to the previous
  ** and the next page.
  */
Dries's avatar
 
Dries committed
407

Dries's avatar
 
Dries committed
408 409
  $output = "";

Dries's avatar
 
Dries committed
410
  if ($main) {
Dries's avatar
 
Dries committed
411
    $output .= theme("node", $node, $main, $page);
Dries's avatar
 
Dries committed
412
  }
Dries's avatar
 
Dries committed
413
  else {
Dries's avatar
 
Dries committed
414 415 416
    if ($node->moderate) {
      $node->body = $node->body . "<div class=\"log\"><div class=\"title\">". t("Log") .":</div>$node->log</div>";
    }
Dries's avatar
 
Dries committed
417
    // Add the navigation and the breadcrumb if we view a page
Dries's avatar
 
Dries committed
418
    if ($page) {
Dries's avatar
 
Dries committed
419
      $node = book_navigation($node);
Dries's avatar
 
Dries committed
420
      // Print the breadcrumb
Dries's avatar
 
Dries committed
421
      drupal_set_breadcrumb($node->breadcrumb);
Dries's avatar
 
Dries committed
422
    }
Dries's avatar
 
Dries committed
423
    // Print the node
Dries's avatar
 
Dries committed
424
    $output .= theme("node", $node, $main, $page);
Dries's avatar
 
Dries committed
425
  }
Dries's avatar
 
Dries committed
426 427

  return $output;
Dries's avatar
 
Dries committed
428 429 430
}

function book_show($node, $cid) {
Dries's avatar
 
Dries committed
431
  $output = "";
Dries's avatar
 
Dries committed
432

Dries's avatar
 
Dries committed
433
  if (node_access("view", $node)) {
Dries's avatar
 
Dries committed
434

Dries's avatar
 
Dries committed
435
    if ($node->type == "book") {
Dries's avatar
 
Dries committed
436
      $output .= book_view($node, 0, 1);
Dries's avatar
 
Dries committed
437 438
    }
    else {
Dries's avatar
 
Dries committed
439

Dries's avatar
 
Dries committed
440
      if (node_hook($node, "content")) {
Dries's avatar
 
Dries committed
441
        $node = node_invoke($node, "content");
Dries's avatar
 
Dries committed
442

Dries's avatar
 
Dries committed
443 444 445
        /*
        ** Add the book navigation if the node is in the book.
        */
Dries's avatar
 
Dries committed
446

Dries's avatar
 
Dries committed
447
        $book = db_fetch_object(db_query("SELECT * FROM {book} WHERE nid = %d", $node->nid));
Dries's avatar
 
Dries committed
448

Dries's avatar
 
Dries committed
449 450 451 452 453 454
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
          $node = book_navigation($node);
        }
Dries's avatar
 
Dries committed
455

Dries's avatar
 
Dries committed
456 457 458
        /*
        ** make $node->type a book. This is for the links.
        */
Dries's avatar
 
Dries committed
459

Dries's avatar
 
Dries committed
460
        $node->type = "book";
Dries's avatar
 
Dries committed
461

Dries's avatar
 
Dries committed
462 463 464
        /*
        ** View the node
        */
Dries's avatar
 
Dries committed
465 466
        drupal_set_breadcrumb($node->breadcrumb);
        $output .= theme("node", $node, 0, 1);
Dries's avatar
 
Dries committed
467 468 469 470 471 472 473
      }
      else {

        /*
        ** We can't get the content of the node and just view the node.
        ** We don't add breadcrums or links.
        */
Dries's avatar
 
Dries committed
474
        $output .= node_view($node, 0, 1);
Dries's avatar
 
Dries committed
475 476
      }
    }
Dries's avatar
 
Dries committed
477
    if (function_exists("comment_render") && $node->comment) {
Dries's avatar
 
Dries committed
478
      $output .= comment_render($node, $cid);
Dries's avatar
 
Dries committed
479 480
    }

Dries's avatar
 
Dries committed
481
    /*
Dries's avatar
 
Dries committed
482
    ** Update the history table, stating that this user viewed this node.
Dries's avatar
 
Dries committed
483
    */
Dries's avatar
 
Dries committed
484 485
    node_tag_new($node->nid);
  }
Dries's avatar
 
Dries committed
486 487 488 489
  else {
    $output .= message_access();
  }
  return $output;
Dries's avatar
 
Dries committed
490
}
Dries's avatar
 
Dries committed
491

Dries's avatar
 
Dries committed
492
function book_navigation($node) {
Dries's avatar
 
Dries committed
493

Dries's avatar
 
Dries committed
494
  $path = book_location($node);
Dries's avatar
 
Dries committed
495

Dries's avatar
 
Dries committed
496 497 498 499 500 501 502 503 504
  /*
  ** Construct the breadcrumb:
  */

  $node->breadcrumb = ""; // Overwrite the trail with a book trail.
  $node->breadcrumb[] = l(t("Home"), "");
  foreach ($path as $level) {
    $node->breadcrumb[] = l($level->title, "book/view/$level->nid");
  }
Dries's avatar
 
Dries committed
505

Dries's avatar
 
Dries committed
506 507 508 509 510
  if ($node->nid) {
    $output .= "<div class=\"book\">";

    if ($tree = book_tree($node->nid)) {
      $output .= "<div class=\"tree\">". book_tree($node->nid) ."</div>";
Dries's avatar
 
Dries committed
511
    }
Dries's avatar
 
Dries committed
512

Dries's avatar
 
Dries committed
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
    if ($prev = book_prev($node)) {
      $links .= "<div class=\"prev\">";
      $links .= l(t("previous"), "book/view/$prev->nid", array("title" => t("View the previous page.")));
      $links .= "</div>";
      $titles .= "<div class=\"prev\">$prev->title</div>";
    }
    else {
      $links .= "<div class=\"prev\">&nbsp;</div>"; // make an empty div to fill the space
    }
    if ($next = book_next($node)) {
      $links .= "<div class=\"next\">";
      $links .= l(t("next"), "book/view/$next->nid", array("title" => t("View the next page.")));
      $links .= "</div>";
      $titles .= "<div class=\"next\">$next->title</div>";
    }
    else {
      $links .= "<div class=\"next\">&nbsp;</div>"; // make an empty div to fill the space
    }
    if ($node->parent) {
      $links .= "<div class=\"up\">";
      $links .= l(t("up"), "book/view/$node->parent", array("title" => t("View this page's parent section.")));
      $links .= "</div>";
    }
Dries's avatar
 
Dries committed
536

Dries's avatar
 
Dries committed
537 538 539 540 541 542
    $output .= "<div class=\"nav\">";
    $output .= " <div class=\"links\">$links</div>";
    $output .= " <div class=\"titles\">$titles</div>";
    $output .= "</div>";
    $output .= "</div>";
  }
Dries's avatar
 
Dries committed
543

Dries's avatar
 
Dries committed
544
  $node->body = $node->body.$output;
Dries's avatar
 
Dries committed
545

Dries's avatar
 
Dries committed
546
  return $node;
Dries's avatar
 
Dries committed
547
}
Dries's avatar
 
Dries committed
548

Dries's avatar
 
Dries committed
549 550 551 552 553 554 555 556 557 558 559 560
function book_toc_recurse($nid, $indent, $toc, $children) {

  if ($children[$nid]) {
    foreach ($children[$nid] as $foo => $node) {
      $toc[$node->nid] = "$indent $node->title";
      $toc = book_toc_recurse($node->nid, "$indent--", $toc, $children);
    }
  }

  return $toc;
}

Dries's avatar
 
Dries committed
561
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
 
Dries committed
562

Dries's avatar
 
Dries committed
563
  $result = db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = '1' ORDER BY b.weight, n.title");
Dries's avatar
 
Dries committed
564

Dries's avatar
 
Dries committed
565
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
566 567 568 569
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
 
Dries committed
570
  }
Dries's avatar
 
Dries committed
571 572

  /*
Dries's avatar
 
Dries committed
573 574
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
 
Dries committed
575
  */
Dries's avatar
 
Dries committed
576

Dries's avatar
 
Dries committed
577
  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
578
    $toc[0] = "<". t("root") .">";
Dries's avatar
 
Dries committed
579 580
  }

Dries's avatar
 
Dries committed
581
  /*
Dries's avatar
 
Dries committed
582
  ** Iterate root book nodes:
Dries's avatar
 
Dries committed
583 584
  */

Dries's avatar
 
Dries committed
585
  $toc = book_toc_recurse($parent, $indent, $toc, $children);
Dries's avatar
 
Dries committed
586

Dries's avatar
 
Dries committed
587 588 589
  return $toc;
}

Dries's avatar
 
Dries committed
590

Dries's avatar
 
Dries committed
591
function book_tree_recurse($nid, $depth, $children, $unfold = array()) {
Dries's avatar
 
Dries committed
592
  if ($depth > 0) {
Dries's avatar
 
Dries committed
593 594
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
        if (in_array($node->nid, $unfold)) {
          if ($tree = book_tree_recurse($node->nid, $depth - 1, $children, $unfold)) {
            $output .= '<li class="expanded">';
            $output .= l($node->title, "book/view/$node->nid");
            $output .= "<ul>$tree</ul>";
            $output .= '</li>';
          }
          else {
            $output .= '<li class="leaf">'. l($node->title, "book/view/$node->nid") .'</li>';
          }
        }
        else {
          if ($tree = book_tree_recurse($node->nid, 1, $children)) {
            $output .= '<li class="collapsed">'. l($node->title, "book/view/$node->nid") .'</li>';
          }
          else {
            $output .= '<li class="leaf">'. l($node->title, "book/view/$node->nid") .'</li>';
          }
Dries's avatar
 
Dries committed
613
        }
Dries's avatar
 
Dries committed
614 615
      }
    }
Dries's avatar
 
Dries committed
616 617 618 619 620
  }

  return $output;
}

Dries's avatar
 
Dries committed
621

Dries's avatar
 
Dries committed
622
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
Dries's avatar
 
Dries committed
623

Dries's avatar
 
Dries committed
624
  $result = db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = '1' AND n.moderate = '0' ORDER BY b.weight, n.title");
Dries's avatar
 
Dries committed
625

Dries's avatar
 
Dries committed
626 627 628 629
  while ($node = db_fetch_object($result)) {
    $list = $children[$node->parent] ? $children[$node->parent] : array();
    array_push($list, $node);
    $children[$node->parent] = $list;
Dries's avatar
 
Dries committed
630
  }
Dries's avatar
 
Dries committed
631

Dries's avatar
 
Dries committed
632 633 634
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
    return "<ul>$tree</ul>";
  }
Dries's avatar
 
Dries committed
635 636
}

Dries's avatar
 
Dries committed
637

Dries's avatar
 
Dries committed
638
function book_render() {
Dries's avatar
 
Dries committed
639

Dries's avatar
 
Dries committed
640
  $result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = 0 AND n.status = 1 AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title");
Dries's avatar
 
Dries committed
641

Dries's avatar
 
Dries committed
642 643 644 645
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));

Dries's avatar
 
Dries committed
646
    if ($node) {
Dries's avatar
 
Dries committed
647 648
      // take the most recent approved revision, extract the page and check output:
      $node = book_content($node);
Dries's avatar
 
Dries committed
649
      // output the content:
Dries's avatar
 
Dries committed
650
      $output .= "<div class=\"book\">";
Dries's avatar
 
Dries committed
651
      $output .= "<div class=\"title\">". l($node->title, "book/view/$node->nid") ."</div>";
Dries's avatar
 
Dries committed
652
      $output .= "<div class=\"body\">". $node->body ."</div>";
Dries's avatar
 
Dries committed
653
      $output .= "</div>";
Dries's avatar
 
Dries committed
654
    }
Dries's avatar
 
Dries committed
655 656
  }

Dries's avatar
 
Dries committed
657
  drupal_set_title(t("Books"));
Dries's avatar
 
Dries committed
658
  print theme("page", $output);
Dries's avatar
 
Dries committed
659 660 661
}

function book_page() {
Dries's avatar
 
Dries committed
662

Dries's avatar
 
Dries committed
663
  if (user_access("access content")) {
Dries's avatar
 
Dries committed
664
    switch (arg(1)) {
Dries's avatar
 
Dries committed
665
      case "view":
Dries's avatar
 
Dries committed
666
        $node = node_load(array("nid" => arg(2)));
Dries's avatar
 
Dries committed
667 668
        $output = book_show($node, arg(3));
        print theme("page", $output, $node->title);
Dries's avatar
 
Dries committed
669
        break;
Dries's avatar
 
Dries committed
670
      case "print":
Dries's avatar
 
Dries committed
671
        print book_print(arg(2), $depth = 1);
Dries's avatar
 
Dries committed
672 673 674
        break;
      default:
        book_render();
Dries's avatar
 
Dries committed
675 676 677
    }
  }
  else {
Dries's avatar
 
Dries committed
678
    drupal_access_denied();
Dries's avatar
 
Dries committed
679
  }
Dries's avatar
 
Dries committed
680 681
}

682
function book_print($id = "", $depth = 1) {
Dries's avatar
 
Dries committed
683
  global $base_url;
684
  $result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND n.nid = %d AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title", $id);
Dries's avatar
 
Dries committed
685

Dries's avatar
 
Dries committed
686 687 688
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
Dries's avatar
 
Dries committed
689

Dries's avatar
 
Dries committed
690 691
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
692
      if (node_hook($node, "content")) {
Dries's avatar
 
Dries committed
693 694
        $node = node_invoke($node, "content");
      }
Dries's avatar
 
Dries committed
695
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries's avatar
 
Dries committed
696

Dries's avatar
 
Dries committed
697
      if ($node->body) {
Dries's avatar
 
Dries committed
698
        $output .= $node->body;
Dries's avatar
 
Dries committed
699
      }
Dries's avatar
 
Dries committed
700
    }
Dries's avatar
 
Dries committed
701
  }
Dries's avatar
 
Dries committed
702

703
  $output .= book_print_recurse($id, $depth);
Dries's avatar
 
Dries committed
704

Dries's avatar
 
Dries committed
705 706 707 708 709 710
  $html = "<html><head><title>$node->title</title>";
  $html .= "<base href=\"$base_url/\" />";
  $html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n</style>";
  $html .= "</head><body>". $output ."</body></html>";

  return $html;
Dries's avatar
 
Dries committed
711 712
}

713
function book_print_recurse($parent = "", $depth = 1) {
Dries's avatar
 
Dries committed
714
  $result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND b.parent = '$parent' AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title");
Dries's avatar
 
Dries committed
715

Dries's avatar
 
Dries committed
716 717 718 719 720 721
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));

    // take the most recent approved revision:
    if ($node->moderate) {
Dries's avatar
 
Dries committed
722
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
723 724
    }

Dries's avatar
 
Dries committed
725 726
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
727
      if (node_hook($node, "content")) {
Dries's avatar
 
Dries committed
728 729
        $node = node_invoke($node, "content");
      }
Dries's avatar
 
Dries committed
730
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries's avatar
 
Dries committed
731

Dries's avatar
 
Dries committed
732
      if ($node->body) {
Dries's avatar
 
Dries committed
733
        $output .= "<ul>". $node->body ."</ul>";
Dries's avatar
 
Dries committed
734
      }
Dries's avatar
 
Dries committed
735

736
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
737
    }
Dries's avatar
 
Dries committed
738
  }
Dries's avatar
 
Dries committed
739

Dries's avatar
 
Dries committed
740 741
  return $output;
}
Dries's avatar
 
Dries committed
742

Dries's avatar
 
Dries committed
743 744
function book_admin_view_line($node, $depth = 0) {

Dries's avatar
 
Dries committed
745
  $row = array("<div style=\"padding-left: ". (25 * $depth) ."px;\">". form_textfield(NULL, "$node->nid][title", $node->title, 64, 255) ."</div>", form_weight(NULL, "$node->nid][weight", $node->weight), l(t("view node"), "node/view/$node->nid"), l(t("edit node"), "admin/node/edit/$node->nid"), l(t("delete node"), "admin/node/delete/$node->nid"));
Dries's avatar
 
Dries committed
746 747

  return $row;
Dries's avatar
 
Dries committed
748 749 750
}

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
 
Dries committed
751
  $result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d ORDER BY b.weight, n.title", $nid);
Dries's avatar
 
Dries committed
752 753 754

  while ($node = db_fetch_object($result)) {
    $node = node_load(array("nid" => $node->nid));
Dries's avatar
 
Dries committed
755 756
    $rows[] = book_admin_view_line($node, $depth);
    $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
 
Dries committed
757 758
  }

Dries's avatar
 
Dries committed
759
  return $rows;
Dries's avatar
 
Dries committed
760 761 762 763
}

function book_admin_view($nid, $depth = 0) {

Dries's avatar
 
Dries committed
764 765
  if ($nid) {
    $node = node_load(array("nid" => $nid));
Dries's avatar
 
Dries committed
766

Dries's avatar
 
Dries committed
767
    $output .= "<h3>$node->title</h3>";
Dries's avatar
 
Dries committed
768

Dries's avatar
 
Dries committed
769 770 771
    $header = array(t("title"), t("weight"), array("data" => t("operations"), "colspan" => 3));
    $rows[] = book_admin_view_line($node);
    $rows = array_merge($rows, book_admin_view_book($nid));
Dries's avatar
 
Dries committed
772

Dries's avatar
 
Dries committed
773
    $output .= theme("table", $header, $rows);
Dries's avatar
 
Dries committed
774
    $output .= form_submit(t("Save book pages"));
Dries's avatar
 
Dries committed
775

Dries's avatar
 
Dries committed
776 777
    return form($output);
  }
Dries's avatar
 
Dries committed
778 779 780 781
}

function book_admin_save($nid, $edit = array()) {

Dries's avatar
 
Dries committed
782 783
  if ($nid) {
    $book = node_load(array("nid" => $nid));
Dries's avatar
 
Dries committed
784

Dries's avatar
 
Dries committed
785 786 787 788
    foreach ($edit as $nid => $value) {
      /*
      ** Check to see whether the title needs updating:
      */
Dries's avatar
 
Dries committed
789

Dries's avatar
 
Dries committed
790
      $title = db_result(db_query("SELECT title FROM {node} WHERE nid = %d", $nid));
Dries's avatar
 
Dries committed
791
      if ($title != $value["title"]) {
Dries's avatar
 
Dries committed
792
        db_query("UPDATE {node} SET title = '%s' WHERE nid = %d", $value["title"], $nid);
Dries's avatar
 
Dries committed
793
      }
Dries's avatar
 
Dries committed
794

Dries's avatar
 
Dries committed
795 796 797
      /*
      ** Check to see whether the weight needs updating:
      */
Dries's avatar
 
Dries committed
798

Dries's avatar
 
Dries committed
799
      $weight = db_result(db_query("SELECT weight FROM {book} WHERE nid = %d", $nid));
Dries's avatar
 
Dries committed
800
      if ($weight != $value["weight"]) {
Dries's avatar
 
Dries committed
801
        db_query("UPDATE {book} SET weight = %d WHERE nid = %d", $value["weight"], $nid);
Dries's avatar
 
Dries committed
802
      }
Dries's avatar
 
Dries committed
803 804
    }

Dries's avatar
 
Dries committed
805 806
    $message = t("updated book '%title'", array("%title" => $book->title));
    watchdog("special", $message);
Dries's avatar
 
Dries committed
807

Dries's avatar
 
Dries committed
808 809
    return $message;
  }
Dries's avatar
 
Dries committed
810 811 812 813
}

function book_admin_orphan() {

Dries's avatar
 
Dries committed
814
  $result = db_query("SELECT n.nid, n.title, n.status, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid");
Dries's avatar
 
Dries committed
815 816 817 818 819

  while ($page = db_fetch_object($result)) {
    $pages[$page->nid] = $page;
  }

Dries's avatar
 
Dries committed
820
  if ($pages) {
Dries's avatar
 
Dries committed
821 822
    $output .= "<h3>Orphan pages</h3>";
    $header = array(t("title"), t("weight"), array("data" => t("operations"), "colspan" => 3));
Dries's avatar
 
Dries committed
823 824
    foreach ($pages as $nid => $node) {
      if ($node->parent && empty($pages[$node->parent])) {
Dries's avatar
 
Dries committed
825 826
        $rows[] = book_admin_view_line($node, $depth);
        $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
 
Dries committed
827
      }
Dries's avatar
 
Dries committed
828
    }
Dries's avatar
 
Dries committed
829
    $output .= theme("table", $header, $rows);
Dries's avatar
 
Dries committed
830 831
  }

Dries's avatar
 
Dries committed
832
  print theme("page", $output);
Dries's avatar
 
Dries committed
833 834 835 836 837 838
}

function book_admin_links() {
}

function book_admin() {
Dries's avatar
 
Dries committed
839 840
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
841

Dries's avatar
 
Dries committed
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
  if (empty($op)) {
    $op = arg(3);
  }

  switch ($op) {
    case t("Edit book outline"):
    case t("Add to book outline"):
    case t("Remove from book outline"):
    case t("Update book outline"):
      $output = book_node_link();
      break;
    case "orphan":
      $output = book_admin_orphan();
      break;
    case t("Save book pages"):
      drupal_set_message(book_admin_save(arg(3), $edit));
      // fall through:
    default:
      $output .= book_admin_view(arg(3));
      break;
Dries's avatar
 
Dries committed
862
  }
Dries's avatar
 
Dries committed
863
  print theme("page", $output);
Dries's avatar
 
Dries committed
864 865
}

Dries's avatar
 
Dries committed
866
function book_help($section = "admin/help#book") {
Dries's avatar
 
Dries committed
867
  $output = "";
868

Dries's avatar
 
Dries committed
869
  switch ($section) {
Dries's avatar
 
Dries committed
870
    case 'admin/help#book':
Dries's avatar
 
Dries committed
871 872
      $output .= t("
      <p>The book organises content into a nested hierarchical structure. It is particularly good for manuals, Frequently Asked Questions (FAQs) and the like, allowing you to have chapters, sections, etc.</p>
873 874 875 876
      <p>A book is simply a collection of nodes that have been linked together. These nodes are usually of type <em>book page</em>, but you can insert nodes of any type into a book outline. Every node in the book has a <em>parent</em> node which  \"contains\" it. This is how book.module establishes its hierarchy. At any given level in the hierarchy, a book can contain many nodes. All these sibling nodes are sorted according to the <em>weight</em> that you give them.</p>
      <p>A book page is a special node type that allows you to embed PHP within the body of the page. This capability is only offerred to administrators, since malicious users could abuse this power. In addiiton, book pages contain a <em>log message</em> field which helps your users understand the motivation behind an edit of a book page. Each edited version of a book page is stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that be desirable.</p>
      <p>Like other node types, book submissions and edits may be subject to moderation, depending on your configuration.  Similarly, books use <a href=\"%permissions\">permissions</a> to determine who may read and write to them. Only administrators are allowed to create new books, which are really just nodes whose parent is <em>&lt;root&gt;</em>. To include an existing node in your book, click on the \"administer\"-link in that node.  At the bottom of this administration page, click on the <em>edit book outline</em> button. This enables you to place the node wherever you'd like within the book hierarchy. To add a new node into your book, use the <a href=\"%create\">submit content &raquo; book page</a> link.</p>
      <p>Administrators may review the hierarchy of their books by clicking on the <a href=\"%collaborative-book\">collaborative book</a> link in the adminstration pages. There, nodes may be edited, reorganized, removed from book, and deleted. This behavior may change in the future. When a parent node is deleted, it may leave behind child nodes.  These nodes are now <em>orphans</em>. Administrators should periodically <a href=\"%orphans-book\">review their books for orphans</a> and reaffiliate those pages as desired. Finally, administrators may also <a href=\"%export-book\">export their books</a> to a single, flat HTML page which is suitable for printing.</p>
Dries's avatar
 
Dries committed
877 878
      <h3>Maintaining a FAQ using a collaborative book</h3>
      <p>Collaborative books let you easily set up a Frequently Asked Questions (FAQ) section on your web site. The main benefit is that you don't have to write all the questions/answers by yourself - let the community do it for you!</p>
879 880 881
      <p>In order to set up the FAQ, you have to create a new book which will hold all your content. To do so, click on the <a href=\"%create\">submit content &raquo; book page</a> link. Give it a thoughtful title, and body. A title like \"Estonia Travel - FAQ\" is nice. You may always edit these fields later. You will probably want to designate <em>&lt;root&gt;</em> as the parent of this page. Leave the <em>log message</em> and <em>type</em> fields blank for now. After you have submitted this book page, you are ready to begin filling up your book with questions that are frequently asked.</p>
      <p>Whenever you come across a post which you want to include in your FAQ, click on the <em>administer</em> link. Then click on the <em>edit book outline</em> button at the bottom of the page. Then place the relevant post wherever is most appropriate in your book by selecting a <em>parent</em>. Books are quite flexible. They can have sections like <em>Flying to Estonia</em>, <em>Eating in Estonia</em> and so on. As you get more experienced with the book module, you can reorganize posts in your book so that it stays organized.</p>
      <p>Notes:</p><ul><li>Any comments attached to those relevant posts which you designate as book pages will also be transported into your book. This is a great feature, since much wisdom is shared via comments. Remember that all future comments and edits will automatically be reflected in your book.</li><li>You may wish to edit the title of posts when adding them to your FAQ. This is done on the same page as the <em>Edit book outline</em> button. Clear titles improve navigability enormously.</li><li>Book pages may come from any content type (blog, story, page, etc.). If you are creating a post solely for inclusion in your book, then use the <a href=\"%create\">submit content &raquo; book page</a> link.</li><li>If you don't see the <em>administer</em> link, then you probably have insufficient <a href=\"%permissions\">permissions</a>.</li><li>If you want to get really fancy, note that books are one of the few content types which allow raw PHP in their <em>body</em>. So you've got lots of geeky possibilities there.</li></ul>", array("%permissions" => url("admin/user/permission"), "%create" => url("node/add/book"), "%collaborative-book" => url("admin/node/book"), "%orphans-book" => url("admin/node/book/orphan"), "%export-book" => url("book/print")));
Dries's avatar
 
Dries committed
882
      break;
Dries's avatar
 
Dries committed
883
    case 'admin/system/modules#description':
Dries's avatar
 
Dries committed
884
      $output = t("Allows users to collaboratively author a book.");
Dries's avatar
 
Dries committed
885 886
      break;
    case 'admin/node/book':
Dries's avatar
 
Dries committed
887
      $output = t("The book module offers a mean to organize content, authored by many users, in an online manual, outline or FAQ.");
Dries's avatar
 
Dries committed
888 889
      break;
    case 'admin/node/book/orphan':
Dries's avatar
 
Dries committed
890
      $output = 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 refered to as 'orphan pages'.  On this page, administrators can review their books for orphans and reattach those pages as desired.");
Dries's avatar
 
Dries committed
891
      break;
Dries's avatar
 
Dries committed
892 893 894
    case 'node/add#book':
      $output = 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.");
      break;
Dries's avatar
 
Dries committed
895 896
  }

Dries's avatar
 
Dries committed
897
  return $output;
898
}
Dries's avatar
 
Dries committed
899 900

function book_help_page() {
Dries's avatar
 
Dries committed
901
  print theme("page", book_help());
Dries's avatar
 
Dries committed
902
}
Dries's avatar
 
Dries committed
903

Dries's avatar
 
Dries committed
904
?>