book.module 31.8 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
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
51 52 53

  $links = array();

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

Dries's avatar
 
Dries committed
58 59 60 61
  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
62 63 64
    if (!$main) {
      $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
65 66
  }

Dries's avatar
 
Dries committed
67 68
  if ($type == "system") {
    if (user_access("maintain books")) {
Dries's avatar
 
Dries committed
69
      menu("node/add/book", t("book page"), "node_page", 0);
Dries's avatar
 
Dries committed
70 71
    }
    if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
72
      menu("admin/node/book", t("books"), "book_admin", 4);
73
      menu("admin/node/book/orphan", t("orphan pages"), "book_admin_orphan", 8);
Dries's avatar
 
Dries committed
74
      menu("admin/node/book/help", t("help"), "book_help_page", 9);
Dries's avatar
 
Dries committed
75 76 77

      $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)) {
Dries's avatar
 
Dries committed
78
        menu("admin/node/book/$book->nid", t("'%title' book", array("%title" => $book->title)), "book_admin");
Dries's avatar
 
Dries committed
79
      }
Dries's avatar
 
Dries committed
80
    }
Dries's avatar
 
Dries committed
81
    if (user_access("access content")) {
Dries's avatar
 
Dries committed
82
      menu("book", t("books"), "book_page", 0, MENU_HIDE);
Dries's avatar
 
Dries committed
83
    }
Dries's avatar
 
Dries committed
84 85
  }

Dries's avatar
 
Dries committed
86
  return $links;
Dries's avatar
 
Dries committed
87 88
}

Dries's avatar
 
Dries committed
89 90 91 92
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
93
    $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
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116

    $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
117
function book_load($node) {
Dries's avatar
 
Dries committed
118
  global $user;
Dries's avatar
 
Dries committed
119

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

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

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

Dries's avatar
 
Dries committed
138 139 140
  /*
  ** 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
141
  ** always such that the "edit this page"-links appear.
Dries's avatar
 
Dries committed
142
  */
Dries's avatar
 
Dries committed
143

Dries's avatar
 
Dries committed
144
  $book->revision = 1;
Dries's avatar
 
Dries committed
145

Dries's avatar
 
Dries committed
146
  return $book;
Dries's avatar
 
Dries committed
147 148
}

Dries's avatar
 
Dries committed
149
function book_insert($node) {
Dries's avatar
 
Dries committed
150
  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
151
}
Dries's avatar
 
Dries committed
152

Dries's avatar
 
Dries committed
153
function book_update($node) {
Dries's avatar
 
Dries committed
154
  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
155
}
Dries's avatar
 
Dries committed
156

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

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

170 171 172 173 174 175
  // 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
176 177
}

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

Dries's avatar
 
Dries committed
181
  $op = $_POST["op"];
182
  $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
183

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

Dries's avatar
 
Dries committed
188
  $output .= form_textarea(t("Body"), "body", $node->body, 60, 20, filter_tips_short());
189
  $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
190 191

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
192
    $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
193
    if (user_access("create php content")) {
Dries's avatar
 
Dries committed
194
      $output .= form_radios("Type", "format", $node->format, array(0 => "HTML / text", 1 => "PHP"));
Dries's avatar
 
Dries committed
195
    }
Dries's avatar
 
Dries committed
196 197 198 199 200 201 202 203 204 205 206 207 208
  }
  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
209
function book_node_link($node = 0) {
Dries's avatar
 
Dries committed
210 211 212 213
  global $user;

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

  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
222
      db_query("INSERT INTO {book} (nid, parent, weight) VALUES (%d, %d, %d)", $node->nid, $edit["parent"], $edit["weight"]);
Dries's avatar
 
Dries committed
223
      drupal_set_message(t("added the node to the book."));
Dries's avatar
 
Dries committed
224 225 226
    }

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

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

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

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

      $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
242
      $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
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258

      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
259
    return form($output, "post", url("admin/node/book"));
Dries's avatar
 
Dries committed
260 261 262
  }
}

Dries's avatar
 
Dries committed
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 299 300
/*
** 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
301
function book_location($node, $nodes = array()) {
Dries's avatar
 
Dries committed
302 303
  // TODO: eliminate the recursion

Dries's avatar
 
Dries committed
304
  $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
305 306 307 308 309 310 311
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

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

Dries's avatar
 
Dries committed
315
  $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
316 317 318 319 320 321 322 323
  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
324 325 326 327 328
  // 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
329
  // previous on the same level
Dries's avatar
 
Dries committed
330
  $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
331 332 333
  if ($direct_above) {
    // get last leaf of $above
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
334 335

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
336 337 338
  }
  else {
    // direct parent
Dries's avatar
 
Dries committed
339
    $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
340 341 342 343 344 345
    return $prev;
  }
}

function book_next($node) {
  // get first direct child
Dries's avatar
 
Dries committed
346
  $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
347 348 349 350
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
351
  // no direct child: get next for this level or any parent in this book
Dries's avatar
 
Dries committed
352
  array_push($path = book_location($node), $node); // path to root node including this one
Dries's avatar
 
Dries committed
353 354
  // loop through nodes to book root, starting with this node
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
 
Dries committed
355
    $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
356 357 358 359 360 361
    if ($next) {
      return $next;
    }
  }
}

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

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

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

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
377 378
  }

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

Dries's avatar
 
Dries committed
384 385 386 387 388 389 390 391 392 393 394 395
  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
396
    $node = node_prepare($node, $main);
Dries's avatar
 
Dries committed
397
  }
Dries's avatar
 
Dries committed
398

Dries's avatar
 
Dries committed
399 400 401
  return $node;
}

Dries's avatar
 
Dries committed
402
function book_view($node, $main = 0, $page = 0) {
Dries's avatar
 
Dries committed
403
  $node = book_content($node, $main);
Dries's avatar
 
Dries committed
404 405 406 407 408
  /*
  ** 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
409

Dries's avatar
 
Dries committed
410 411
  $output = "";

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

  return $output;
Dries's avatar
 
Dries committed
430 431 432
}

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

Dries's avatar
 
Dries committed
435
  if (node_access("view", $node)) {
Dries's avatar
 
Dries committed
436

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

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

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

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

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

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

Dries's avatar
 
Dries committed
462
        $node->type = "book";
Dries's avatar
 
Dries committed
463

Dries's avatar
 
Dries committed
464 465 466
        /*
        ** View the node
        */
Dries's avatar
 
Dries committed
467 468
        drupal_set_breadcrumb($node->breadcrumb);
        $output .= theme("node", $node, 0, 1);
Dries's avatar
 
Dries committed
469 470 471 472 473 474 475
      }
      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
476
        $output .= node_view($node, 0, 1);
Dries's avatar
 
Dries committed
477 478
      }
    }
Dries's avatar
 
Dries committed
479
    if (function_exists("comment_render") && $node->comment) {
Dries's avatar
 
Dries committed
480
      $output .= comment_render($node, $cid);
Dries's avatar
 
Dries committed
481 482
    }

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

Dries's avatar
 
Dries committed
494
function book_navigation($node) {
Dries's avatar
 
Dries committed
495

Dries's avatar
 
Dries committed
496
  $path = book_location($node);
Dries's avatar
 
Dries committed
497

Dries's avatar
 
Dries committed
498 499 500 501 502 503 504 505 506
  /*
  ** 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
507

Dries's avatar
 
Dries committed
508 509 510 511 512
  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
513
    }
Dries's avatar
 
Dries committed
514

Dries's avatar
 
Dries committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
    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
538

Dries's avatar
 
Dries committed
539 540 541 542 543 544
    $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
545

Dries's avatar
 
Dries committed
546
  $node->body = $node->body.$output;
Dries's avatar
 
Dries committed
547

Dries's avatar
 
Dries committed
548
  return $node;
Dries's avatar
 
Dries committed
549
}
Dries's avatar
 
Dries committed
550

Dries's avatar
 
Dries committed
551 552 553 554 555 556 557 558 559 560 561 562
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
563
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
 
Dries committed
564

Dries's avatar
 
Dries committed
565
  $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
566

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

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

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

Dries's avatar
 
Dries committed
583
  /*
Dries's avatar
 
Dries committed
584
  ** Iterate root book nodes:
Dries's avatar
 
Dries committed
585 586
  */

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

Dries's avatar
 
Dries committed
589 590 591
  return $toc;
}

Dries's avatar
 
Dries committed
592

Dries's avatar
 
Dries committed
593
function book_tree_recurse($nid, $depth, $children, $unfold = array()) {
Dries's avatar
 
Dries committed
594
  if ($depth > 0) {
Dries's avatar
 
Dries committed
595 596
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
        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
615
        }
Dries's avatar
 
Dries committed
616 617
      }
    }
Dries's avatar
 
Dries committed
618 619 620 621 622
  }

  return $output;
}

Dries's avatar
 
Dries committed
623

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

Dries's avatar
 
Dries committed
626
  $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
627

Dries's avatar
 
Dries committed
628 629 630 631
  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
632
  }
Dries's avatar
 
Dries committed
633

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

Dries's avatar
 
Dries committed
639

Dries's avatar
 
Dries committed
640
function book_render() {
Dries's avatar
 
Dries committed
641

Dries's avatar
 
Dries committed
642
  $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
643

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

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

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

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

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

684
function book_print($id = "", $depth = 1) {
Dries's avatar
 
Dries committed
685
  global $base_url;
686
  $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
687

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

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

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

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

Dries's avatar
 
Dries committed
707 708 709 710 711 712
  $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
713 714
}

715
function book_print_recurse($parent = "", $depth = 1) {
Dries's avatar
 
Dries committed
716
  $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
717

Dries's avatar
 
Dries committed
718 719 720 721 722 723
  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
724
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
725 726
    }

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

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

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

Dries's avatar
 
Dries committed
742 743
  return $output;
}
Dries's avatar
 
Dries committed
744

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

Dries's avatar
 
Dries committed
747
  $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
748 749

  return $row;
Dries's avatar
 
Dries committed
750 751 752
}

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
 
Dries committed
753
  $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
754 755 756

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

Dries's avatar
 
Dries committed
761
  return $rows;
Dries's avatar
 
Dries committed
762 763 764 765
}

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

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

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

Dries's avatar
 
Dries committed
771 772 773
    $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
774

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

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

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
810 811
    return $message;
  }
Dries's avatar
 
Dries committed
812 813 814 815
}

function book_admin_orphan() {

Dries's avatar
 
Dries committed
816
  $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
817 818 819 820 821

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

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

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

function book_admin_links() {
}

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

Dries's avatar
 
Dries committed
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
  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
864
  }
Dries's avatar
 
Dries committed
865
  print theme("page", $output);
Dries's avatar
 
Dries committed
866 867
}

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

Dries's avatar
 
Dries committed
871
  switch ($section) {
Dries's avatar
 
Dries committed
872
    case 'admin/help#book':
Dries's avatar
 
Dries committed
873 874
      $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>
875 876 877 878
      <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
879 880
      <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>
881 882 883
      <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
884
      break;
Dries's avatar
 
Dries committed
885
    case 'admin/system/modules#description':
Dries's avatar
 
Dries committed
886
      $output = t("Allows users to collaboratively author a book.");
Dries's avatar
 
Dries committed
887 888
      break;
    case 'admin/node/book':
Dries's avatar
 
Dries committed
889
      $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
890 891
      break;
    case 'admin/node/book/orphan':
Dries's avatar
 
Dries committed
892
      $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
893
      break;
Dries's avatar
 
Dries committed
894 895 896
    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
897 898
  }

Dries's avatar
 
Dries committed
899
  return $output;
900
}
Dries's avatar
 
Dries committed
901 902

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

Dries's avatar
 
Dries committed
906
?>