book.module 31.4 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 6
function book_node($field) {
  global $user;

Dries's avatar
 
Dries committed
7
  $info["name"] = t("book page");
Dries's avatar
 
Dries committed
8
  $info["description"] = 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.");
Dries's avatar
 
Dries committed
9 10 11 12

  return $info[$field];
}

Dries's avatar
 
Dries committed
13 14 15 16
function book_perm() {
  return array("maintain books");
}

Dries's avatar
 
Dries committed
17
function book_access($op, $node) {
Dries's avatar
 
Dries committed
18
  global $user;
Dries's avatar
 
Dries committed
19 20

  if ($op == "view") {
Dries's avatar
 
Dries committed
21 22 23 24 25 26 27 28
    /*
    ** 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
29 30
  }

Dries's avatar
 
Dries committed
31
  if ($op == "create") {
Dries's avatar
 
Dries committed
32 33 34 35 36
    /*
    ** 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
37
    return user_access("maintain books");
Dries's avatar
 
Dries committed
38 39 40
  }

  if ($op == "update") {
Dries's avatar
 
Dries committed
41
    /*
Dries's avatar
 
Dries committed
42 43
    ** 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
44
    ** One can only update a book page if there are no suggested updates
Dries's avatar
 
Dries committed
45 46 47 48
    ** 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
49
    */
Dries's avatar
 
Dries committed
50

Dries's avatar
 
Dries committed
51
    return user_access("maintain books") && !$node->moderate && !$node->format && $node->revision;
Dries's avatar
 
Dries committed
52
  }
Dries's avatar
 
Dries committed
53 54
}

Dries's avatar
 
Dries committed
55
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
56 57 58

  $links = array();

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

Dries's avatar
 
Dries committed
63 64 65 66
  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
67 68 69
    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
70 71
  }

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

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

Dries's avatar
 
Dries committed
91
  return $links;
Dries's avatar
 
Dries committed
92 93
}

Dries's avatar
 
Dries committed
94
function book_load($node) {
Dries's avatar
 
Dries committed
95
  global $user;
Dries's avatar
 
Dries committed
96

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

Dries's avatar
 
Dries committed
99
  if (strstr(request_uri(), "node/edit")) {
Dries's avatar
 
Dries committed
100

Dries's avatar
 
Dries committed
101 102
    /*
    ** If a user is about to update a book page, we overload some
103
    ** fields to reflect the changes.  We use the request URI to
Dries's avatar
 
Dries committed
104
    ** dectect this as we don't want to interfer with updating a
Dries's avatar
 
Dries committed
105
    ** book page through the admin pages.
Dries's avatar
 
Dries committed
106 107
    */

Dries's avatar
 
Dries committed
108 109 110 111 112 113 114 115
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
      $book->name = "";
    }
Dries's avatar
 
Dries committed
116
  }
Dries's avatar
 
Dries committed
117

Dries's avatar
 
Dries committed
118 119 120
  /*
  ** 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
121
  ** always such that the "edit this page"-links appear.
Dries's avatar
 
Dries committed
122
  */
Dries's avatar
 
Dries committed
123

Dries's avatar
 
Dries committed
124
  $book->revision = 1;
Dries's avatar
 
Dries committed
125

Dries's avatar
 
Dries committed
126
  return $book;
Dries's avatar
 
Dries committed
127 128
}

Dries's avatar
 
Dries committed
129
function book_insert($node) {
Dries's avatar
 
Dries committed
130
  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
131
}
Dries's avatar
 
Dries committed
132

Dries's avatar
 
Dries committed
133
function book_update($node) {
Dries's avatar
 
Dries committed
134
  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
135
}
Dries's avatar
 
Dries committed
136

137
function book_delete(&$node) {
Dries's avatar
 
Dries committed
138
  db_query("DELETE FROM {book} WHERE nid = %d", $node->nid);
Dries's avatar
 
Dries committed
139 140
}

141
function book_validate(&$node) {
142
  if ($node->format && user_access("create php content")) {
143 144 145 146 147 148
    // Do not filter PHP code, do not auto-extract a teaser
    $node->teaser = $node->body;
  }
  else {
    $node->format = 0;
  }
Dries's avatar
 
Dries committed
149

150 151 152 153 154 155
  // 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
156 157
}

158
function book_form(&$node, &$help, &$error) {
Dries's avatar
 
Dries committed
159
  global $user;
Dries's avatar
 
Dries committed
160

Dries's avatar
 
Dries committed
161
  $op = $_POST["op"];
162
  $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
163

164 165 166 167
  if (function_exists("taxonomy_node_form")) {
    $output .= implode("", taxonomy_node_form("book", $node));
  }

Dries's avatar
 
Dries committed
168
  $output .= form_textarea(t("Body"), "body", $node->body, 60, 20, form_allowed_tags_text());
169
  $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
170 171

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
172
    $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
173
    if (user_access("create php content")) {
Dries's avatar
 
Dries committed
174
      $output .= form_radios("Type", "format", $node->format, array(0 => "HTML / text", 1 => "PHP"));
Dries's avatar
 
Dries committed
175
    }
Dries's avatar
 
Dries committed
176 177 178 179 180 181 182
  }
  else {

    /*
    ** Carry out some explanation or submission guidelines:
    */

Dries's avatar
 
Dries committed
183 184
    $help = book_node("description");

Dries's avatar
 
Dries committed
185 186 187 188 189 190 191 192 193 194 195
    /*
    ** 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
196
function book_node_link($node = 0) {
Dries's avatar
 
Dries committed
197 198 199 200
  global $user;

  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
201 202 203 204 205 206 207 208

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

    if ($op == t("Update book outline")) {
Dries's avatar
 
Dries committed
214
      db_query("UPDATE {book} SET parent = %d, weight = %d WHERE nid = %d", $edit["parent"], $edit["weight"], $node->nid);
Dries's avatar
 
Dries committed
215
      drupal_set_message(t("updated the book outline."));
Dries's avatar
 
Dries committed
216 217 218
    }

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

Dries's avatar
 
Dries committed
223
    $output .= "<h3>". t("Edit book outline for node <i>%booktitle</i>", array("%booktitle" => $node->title)) ."</h3>";
Dries's avatar
 
Dries committed
224 225

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

      $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
229
      $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
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245

      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
246
    return form($output, "post", url("admin/node/book"));
Dries's avatar
 
Dries committed
247 248 249
  }
}

Dries's avatar
 
Dries committed
250 251 252 253 254 255 256 257 258 259 260 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
/*
** 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
288
function book_location($node, $nodes = array()) {
Dries's avatar
 
Dries committed
289
  $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
290 291 292 293 294 295 296
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
 
Dries committed
297
function book_location_down($node, $nodes = array()) {
Dries's avatar
 
Dries committed
298
  $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
299 300 301 302 303 304 305 306
  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
307 308 309 310 311
  // 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
312
  // previous on the same level
Dries's avatar
 
Dries committed
313
  $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
314 315 316
  if ($direct_above) {
    // get last leaf of $above
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
317 318

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
319 320 321
  }
  else {
    // direct parent
Dries's avatar
 
Dries committed
322
    $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
323 324 325 326 327 328
    return $prev;
  }
}

function book_next($node) {
  // get first direct child
Dries's avatar
 
Dries committed
329
  $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
330 331 332 333
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
334
  // no direct child: get next for this level or any parent in this book
Dries's avatar
 
Dries committed
335
  array_push($path = book_location($node), $node); // path to root node including this one
Dries's avatar
 
Dries committed
336 337
  // loop through nodes to book root, starting with this node
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
 
Dries committed
338
    $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
339 340 341 342 343 344
    if ($next) {
      return $next;
    }
  }
}

Dries's avatar
 
Dries committed
345
function book_content($node, $main = 0) {
Dries's avatar
 
Dries committed
346
  $op = $_POST["op"];
Dries's avatar
 
Dries committed
347

Dries's avatar
 
Dries committed
348 349
  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
 
Dries committed
350 351
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
 
Dries committed
352 353
  */

Dries's avatar
 
Dries committed
354
  if ($op != t("Preview") && $node->moderate && arg(0) != "queue") {
Dries's avatar
 
Dries committed
355 356 357 358 359
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
360 361
  }

Dries's avatar
 
Dries committed
362 363 364 365 366
  /*
  ** Extract the page body.  If body is dynamic (using PHP code), the body
  ** will be generated.
  */

Dries's avatar
 
Dries committed
367 368 369 370 371 372 373 374 375 376 377 378
  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
379
    $node = node_prepare($node, $main);
Dries's avatar
 
Dries committed
380
  }
Dries's avatar
 
Dries committed
381

Dries's avatar
 
Dries committed
382 383 384
  return $node;
}

Dries's avatar
 
Dries committed
385
function book_view($node, $main = 0, $page = 0) {
Dries's avatar
 
Dries committed
386
  $node = book_content($node, $main);
Dries's avatar
 
Dries committed
387 388 389 390 391
  /*
  ** 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
392

Dries's avatar
 
Dries committed
393 394
  $output = "";

Dries's avatar
 
Dries committed
395
  if ($main) {
Dries's avatar
 
Dries committed
396
    $output .= theme("node", $node, $main, $page);
Dries's avatar
 
Dries committed
397
  }
Dries's avatar
 
Dries committed
398
  else {
Dries's avatar
 
Dries committed
399 400 401
    if ($node->moderate) {
      $node->body = $node->body . "<div class=\"log\"><div class=\"title\">". t("Log") .":</div>$node->log</div>";
    }
Dries's avatar
 
Dries committed
402
    // Add the navigation and the breadcrumb if we view a page
Dries's avatar
 
Dries committed
403
    if ($page) {
Dries's avatar
 
Dries committed
404
      $node = book_navigation($node);
Dries's avatar
 
Dries committed
405
      // Print the breadcrumb
Dries's avatar
 
Dries committed
406
      drupal_set_breadcrumb($node->breadcrumb);
Dries's avatar
 
Dries committed
407
    }
Dries's avatar
 
Dries committed
408
    // Print the node
Dries's avatar
 
Dries committed
409
    $output .= theme("node", $node, $main, $page);
Dries's avatar
 
Dries committed
410
  }
Dries's avatar
 
Dries committed
411 412

  return $output;
Dries's avatar
 
Dries committed
413 414 415
}

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

Dries's avatar
 
Dries committed
418
  if (node_access("view", $node)) {
Dries's avatar
 
Dries committed
419

Dries's avatar
 
Dries committed
420
    if ($node->type == "book") {
Dries's avatar
 
Dries committed
421
      $output .= book_view($node, 0, 1);
Dries's avatar
 
Dries committed
422 423
    }
    else {
Dries's avatar
 
Dries committed
424

Dries's avatar
 
Dries committed
425 426
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
Dries's avatar
 
Dries committed
427

Dries's avatar
 
Dries committed
428 429 430
        /*
        ** Add the book navigation if the node is in the book.
        */
Dries's avatar
 
Dries committed
431

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

Dries's avatar
 
Dries committed
434 435 436 437 438 439
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
          $node = book_navigation($node);
        }
Dries's avatar
 
Dries committed
440

Dries's avatar
 
Dries committed
441 442 443
        /*
        ** make $node->type a book. This is for the links.
        */
Dries's avatar
 
Dries committed
444

Dries's avatar
 
Dries committed
445
        $node->type = "book";
Dries's avatar
 
Dries committed
446

Dries's avatar
 
Dries committed
447 448 449
        /*
        ** View the node
        */
Dries's avatar
 
Dries committed
450 451
        drupal_set_breadcrumb($node->breadcrumb);
        $output .= theme("node", $node, 0, 1);
Dries's avatar
 
Dries committed
452 453 454 455 456 457 458
      }
      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
459
        $output .= node_view($node, 0, 1);
Dries's avatar
 
Dries committed
460 461
      }
    }
Dries's avatar
 
Dries committed
462
    if (function_exists("comment_render") && $node->comment) {
Dries's avatar
 
Dries committed
463
      $output .= comment_render($node, $cid);
Dries's avatar
 
Dries committed
464 465
    }

Dries's avatar
 
Dries committed
466
    /*
Dries's avatar
 
Dries committed
467
    ** Update the history table, stating that this user viewed this node.
Dries's avatar
 
Dries committed
468
    */
Dries's avatar
 
Dries committed
469 470
    node_tag_new($node->nid);
  }
Dries's avatar
 
Dries committed
471 472 473 474
  else {
    $output .= message_access();
  }
  return $output;
Dries's avatar
 
Dries committed
475
}
Dries's avatar
 
Dries committed
476

Dries's avatar
 
Dries committed
477
function book_navigation($node) {
Dries's avatar
 
Dries committed
478

Dries's avatar
 
Dries committed
479
    $path = book_location($node);
Dries's avatar
 
Dries committed
480

Dries's avatar
 
Dries committed
481 482 483 484 485 486
    /*
    ** Construct the breadcrumb:
    */

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

Dries's avatar
 
Dries committed
492 493 494
    /*
    ** Construct the "next" and "previous" links:
    */
Dries's avatar
 
Dries committed
495

Dries's avatar
 
Dries committed
496 497 498
    if ($node->nid) {
      $prev = book_prev($node);
      $next = book_next($node);
499 500
    }

Dries's avatar
 
Dries committed
501
    if ($node->nid) {
Dries's avatar
 
Dries committed
502
      $output .= "<div class=\"book\">";
Dries's avatar
 
Dries committed
503 504 505
      $output .= "<div class=\"tree\">". book_tree($node->nid) ."</div>";
      if ($prev) {
        $links .= "<div class=\"prev\">";
Dries's avatar
 
Dries committed
506
        $links .= l(t("previous"), "book/view/$prev->nid", array("title" => t("View the previous page in this book.")));
Dries's avatar
 
Dries committed
507 508 509 510 511
        $links .= "</div>";
        $titles .= "<div class=\"prev\">$prev->title</div>";
      }
      if ($next) {
        $links .= "<div class=\"next\">";
Dries's avatar
 
Dries committed
512
        $links .= l(t("next"), "book/view/$next->nid", array("title" => t("View the next page in this book.")));
Dries's avatar
 
Dries committed
513 514 515
        $links .= "</div>";
        $titles .= "<div class=\"next\">$next->title</div>";
      }
Dries's avatar
 
Dries committed
516 517 518
      else {
        $links .= "<div class=\"next\">&nbsp;</div>"; // make an empty div to fill the space
      }
Dries's avatar
 
Dries committed
519 520
      if ($node->parent) {
        $links .= "<div class=\"up\">";
Dries's avatar
 
Dries committed
521
        $links .= l(t("up"), "book/view/$node->parent", array("title" => t("View this page's parent section.")));
Dries's avatar
 
Dries committed
522 523 524 525
        //if ($node->parent != $path[0]->nid) {
        //  $links .= " | ";
        //  $links .= l(t("index"), "node/view/".$path[0]->nid."", array("title" => t("View this book's table of contents.")));
        //}
Dries's avatar
 
Dries committed
526 527 528 529 530 531
        $links .= "</div>";
      }
      $output .= "<div class=\"nav\">";
      $output .= "<div class=\"links\">$links</div>";
      $output .= "<div class=\"titles\">$titles</div>";
      $output .= "</div>";
Dries's avatar
 
Dries committed
532
      $output .= "</div>";
Dries's avatar
 
Dries committed
533
    }
Dries's avatar
 
Dries committed
534 535
    $node->body = $node->body.$output;
  return $node;
Dries's avatar
 
Dries committed
536
}
Dries's avatar
 
Dries committed
537

Dries's avatar
 
Dries committed
538 539 540 541 542 543 544 545 546 547 548 549
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
550
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
 
Dries committed
551

Dries's avatar
 
Dries committed
552
  $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
553

Dries's avatar
 
Dries committed
554
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
555 556 557 558
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
 
Dries committed
559
  }
Dries's avatar
 
Dries committed
560 561

  /*
Dries's avatar
 
Dries committed
562 563
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
 
Dries committed
564
  */
Dries's avatar
 
Dries committed
565

Dries's avatar
 
Dries committed
566
  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
567
    $toc[0] = "<". t("root") .">";
Dries's avatar
 
Dries committed
568 569
  }

Dries's avatar
 
Dries committed
570
  /*
Dries's avatar
 
Dries committed
571
  ** Iterate root book nodes:
Dries's avatar
 
Dries committed
572 573
  */

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

Dries's avatar
 
Dries committed
576 577 578
  return $toc;
}

Dries's avatar
 
Dries committed
579

Dries's avatar
 
Dries committed
580
function book_tree_recurse($nid, $depth, $children) {
Dries's avatar
 
Dries committed
581

Dries's avatar
 
Dries committed
582
  if ($depth > 0) {
Dries's avatar
 
Dries committed
583 584
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
585
        $output .= "<li>";
Dries's avatar
 
Dries committed
586
        $output .= l($node->title, "book/view/$node->nid");
Dries's avatar
 
Dries committed
587 588 589
        if ($tree = book_tree_recurse($node->nid, $depth - 1, $children)) {
          $output .= "<ul>$tree</ul>";
        }
Dries's avatar
 
Dries committed
590
        $output .= "</li>";
Dries's avatar
 
Dries committed
591 592
      }
    }
Dries's avatar
 
Dries committed
593 594 595 596 597
  }

  return $output;
}

Dries's avatar
 
Dries committed
598

Dries's avatar
 
Dries committed
599 600
function book_tree($parent = 0, $depth = 3) {

Dries's avatar
 
Dries committed
601
  $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
602

Dries's avatar
 
Dries committed
603 604 605 606
  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
607
  }
Dries's avatar
 
Dries committed
608

Dries's avatar
 
Dries committed
609 610
  $output = book_tree_recurse($parent, $depth, $children);
  $output = "<ul>$output</ul>";
Dries's avatar
 
Dries committed
611

Dries's avatar
 
Dries committed
612 613 614
  return $output;
}

Dries's avatar
 
Dries committed
615

Dries's avatar
 
Dries committed
616
function book_render() {
Dries's avatar
 
Dries committed
617

Dries's avatar
 
Dries committed
618
  $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
619

Dries's avatar
 
Dries committed
620 621 622 623
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));

Dries's avatar
 
Dries committed
624
    if ($node) {
Dries's avatar
 
Dries committed
625 626
      // take the most recent approved revision, extract the page and check output:
      $node = book_content($node);
Dries's avatar
 
Dries committed
627
      // output the content:
Dries's avatar
 
Dries committed
628
      $output .= "<div class=\"book\">";
Dries's avatar
 
Dries committed
629
      $output .= "<div class=\"title\">". l($node->title, "book/view/$node->nid") ."</div>";
Dries's avatar
 
Dries committed
630
      $output .= "<div class=\"body\">". $node->body ."</div>";
Dries's avatar
 
Dries committed
631
      $output .= "</div>";
Dries's avatar
 
Dries committed
632
    }
Dries's avatar
 
Dries committed
633 634
  }

Dries's avatar
 
Dries committed
635
  drupal_set_title(t("Books"));
Dries's avatar
 
Dries committed
636
  print theme("page", $output);
Dries's avatar
 
Dries committed
637 638 639
}

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

Dries's avatar
 
Dries committed
641
  if (user_access("access content")) {
Dries's avatar
 
Dries committed
642
    switch (arg(1)) {
Dries's avatar
 
Dries committed
643
      case "view":
Dries's avatar
 
Dries committed
644
        $node = node_load(array("nid" => arg(2)));
Dries's avatar
 
Dries committed
645 646
        $output = book_show($node, arg(3));
        print theme("page", $output, $node->title);
Dries's avatar
 
Dries committed
647
        break;
Dries's avatar
 
Dries committed
648
      case "print":
Dries's avatar
 
Dries committed
649
        print book_print(arg(2), $depth = 1);
Dries's avatar
 
Dries committed
650 651 652
        break;
      default:
        book_render();
Dries's avatar
 
Dries committed
653 654 655
    }
  }
  else {
Dries's avatar
 
Dries committed
656
    print theme("page", message_access());
Dries's avatar
 
Dries committed
657
  }
Dries's avatar
 
Dries committed
658 659
}

660
function book_print($id = "", $depth = 1) {
Dries's avatar
 
Dries committed
661
  global $base_url;
662
  $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
663

Dries's avatar
 
Dries committed
664 665 666
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
Dries's avatar
 
Dries committed
667

Dries's avatar
 
Dries committed
668 669
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
670 671 672
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
      }
Dries's avatar
 
Dries committed
673
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries's avatar
 
Dries committed
674

Dries's avatar
 
Dries committed
675
      if ($node->body) {
Dries's avatar
 
Dries committed
676
        $output .= $node->body;
Dries's avatar
 
Dries committed
677
      }
Dries's avatar
 
Dries committed
678
    }
Dries's avatar
 
Dries committed
679
  }
Dries's avatar
 
Dries committed
680

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

Dries's avatar
 
Dries committed
683 684 685 686 687 688
  $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
689 690
}

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

Dries's avatar
 
Dries committed
694 695 696 697 698 699
  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
700
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
701 702
    }

Dries's avatar
 
Dries committed
703 704
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
705 706 707
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
      }
Dries's avatar
 
Dries committed
708
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries's avatar
 
Dries committed
709

Dries's avatar
 
Dries committed
710
      if ($node->body) {
Dries's avatar
 
Dries committed
711
        $output .= "<ul>". $node->body ."</ul>";
Dries's avatar
 
Dries committed
712
      }
Dries's avatar
 
Dries committed
713

714
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
715
    }
Dries's avatar
 
Dries committed
716
  }
Dries's avatar
 
Dries committed
717

Dries's avatar
 
Dries committed
718 719
  return $output;
}
Dries's avatar
 
Dries committed
720

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

Dries's avatar
 
Dries committed
723
  $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
724 725

  return $row;
Dries's avatar
 
Dries committed
726 727 728
}

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
 
Dries committed
729
  $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
730 731 732

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

Dries's avatar
 
Dries committed
737
  return $rows;
Dries's avatar
 
Dries committed
738 739 740 741
}

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

Dries's avatar
 
Dries committed
742 743
  if ($nid) {
    $node = node_load(array("nid" => $nid));
Dries's avatar
 
Dries committed
744

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

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

Dries's avatar
 
Dries committed
751
    $output .= theme("table", $header, $rows);
Dries's avatar
 
Dries committed
752
    $output .= form_submit(t("Save book pages"));
Dries's avatar
 
Dries committed
753

Dries's avatar
 
Dries committed
754 755
    return form($output);
  }
Dries's avatar
 
Dries committed
756 757 758 759
}

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

Dries's avatar
 
Dries committed
760 761
  if ($nid) {
    $book = node_load(array("nid" => $nid));
Dries's avatar
 
Dries committed
762

Dries's avatar
 
Dries committed
763 764 765 766
    foreach ($edit as $nid => $value) {
      /*
      ** Check to see whether the title needs updating:
      */
Dries's avatar
 
Dries committed
767

Dries's avatar
 
Dries committed
768
      $title = db_result(db_query("SELECT title FROM {node} WHERE nid = %d", $nid));
Dries's avatar
 
Dries committed
769
      if ($title != $value["title"]) {
Dries's avatar
 
Dries committed
770
        db_query("UPDATE {node} SET title = '%s' WHERE nid = %d", $value["title"], $nid);
Dries's avatar
 
Dries committed
771
      }
Dries's avatar
 
Dries committed
772

Dries's avatar
 
Dries committed
773 774 775
      /*
      ** Check to see whether the weight needs updating:
      */
Dries's avatar
 
Dries committed
776

Dries's avatar
 
Dries committed
777
      $weight = db_result(db_query("SELECT weight FROM {book} WHERE nid = %d", $nid));
Dries's avatar
 
Dries committed
778
      if ($weight != $value["weight"]) {
Dries's avatar
 
Dries committed
779
        db_query("UPDATE {book} SET weight = %d WHERE nid = %d", $value["weight"], $nid);
Dries's avatar
 
Dries committed
780
      }
Dries's avatar
 
Dries committed
781 782
    }

Dries's avatar
 
Dries committed
783 784
    $message = t("updated book '%title'", array("%title" => $book->title));
    watchdog("special", $message);
Dries's avatar
 
Dries committed
785

Dries's avatar
 
Dries committed
786 787
    return $message;
  }
Dries's avatar
 
Dries committed
788 789 790 791
}

function book_admin_orphan() {

Dries's avatar
 
Dries committed
792
  $result = db_query("SELECT n.nid, n.title, n.status, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.type = 'book'");
Dries's avatar
 
Dries committed
793 794 795 796 797

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

Dries's avatar
 
Dries committed
798
  if ($pages) {
Dries's avatar
 
Dries committed
799 800
    $output .= "<h3>Orphan pages</h3>";
    $header = array(t("title"), t("weight"), array("data" => t("operations"), "colspan" => 3));
Dries's avatar
 
Dries committed
801 802
    foreach ($pages as $nid => $node) {
      if ($node->parent && empty($pages[$node->parent])) {
Dries's avatar
 
Dries committed
803 804
        $rows[] = book_admin_view_line($node, $depth);
        $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
 
Dries committed
805
      }
Dries's avatar
 
Dries committed
806
    }
Dries's avatar
 
Dries committed
807
    $output .= theme("table", $header, $rows);
Dries's avatar
 
Dries committed
808 809
  }

Dries's avatar
 
Dries committed
810
  print theme("page", $output);
Dries's avatar
 
Dries committed
811 812 813 814 815 816
}

function book_admin_links() {
}

function book_admin() {
Dries's avatar
 
Dries committed
817 818
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
819 820

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
821
    if (empty($op)) {
Dries's avatar
 
Dries committed
822
      $op = arg(3);
Dries's avatar
 
Dries committed
823 824
    }

Dries's avatar
 
Dries committed
825
    switch ($op) {
Dries's avatar
 
Dries committed
826 827 828 829
      case t("Edit book outline"):
      case t("Add to book outline"):
      case t("Remove from book outline"):
      case t("Update book outline"):
Dries's avatar
 
Dries committed
830
        $output = book_node_link();
Dries's avatar
 
Dries committed
831
        break;
Dries's avatar
 
Dries committed
832
      case "orphan":
Dries's avatar
 
Dries committed
833
        $output = book_admin_orphan();
Dries's avatar
 
Dries committed
834
        break;
835
      case t("Save book pages"):
Dries's avatar
 
Dries committed
836
        drupal_set_message(book_admin_save(arg(3), $edit));
Dries's avatar
 
Dries committed
837
        // fall through:
Dries's avatar
 
Dries committed
838
      default:
Dries's avatar
 
Dries committed
839
        $output .= book_admin_view(arg(3));
Dries's avatar
 
Dries committed
840 841
        break;
    }
Dries's avatar
 
Dries committed
842
    print theme("page", $output);
Dries's avatar
 
Dries committed
843 844
  }
  else {
Dries's avatar
 
Dries committed
845
    print theme("page", message_access());
Dries's avatar
 
Dries committed
846 847 848
  }
}

Dries's avatar
 
Dries committed
849
function book_help($section = "admin/help#book") {
Dries's avatar
 
Dries committed
850
  $output = "";
851

Dries's avatar
 
Dries committed
852
  switch ($section) {
Dries's avatar
 
Dries committed
853
    case 'admin/help#book':
854
      $output .= "<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>";
Dries's avatar
 
Dries committed
855 856
      $output .= "<p>A book is simply a collection of nodes that have been linked together. These nodes are usually of type <i>book page</i>, but you can insert nodes of any type into a book outline. Every node in the book has a <i>parent</i> 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 <i>weight</i> that you give them.</p>";
      $output .= "<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 <i>log message</i> 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>";
857 858
      $output .= "<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 <i>&lt;root&gt;</i>. 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 <i>edit book outline</i> 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>";
      $output .= "<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 <i>orphans</i>. 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
859 860
      $output .= "<h3>Maintaining a FAQ using a collaborative book</h3>";
      $output .= "<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>";
861
      $output .= "<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 <i>&lt;root&gt;</i> as the parent of this page. Leave the <i>log message</i> and <i>type</i> 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>";
862
      $output .= "<p>Whenever you come across a post which you want to include in your FAQ, click on the <i>administer</i> link. Then click on the <i>edit book outline</i> button at the bottom of the page. Then place the relevant post wherever is most appropriate in your book by selecting a <i>parent</i>. Books are quite flexible. They can have sections like <i>Flying to Estonia</i>, <i>Eating in Estonia</i> 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>";
863 864
      $output .= "<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 <i>Edit book outline</i> 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 <i>administer</i> 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 <i>body</i>. So you've got lots of geeky possibilities there.</li></ul>";
      $output = t($output, 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
865
      break;
Dries's avatar
 
Dries committed
866
    case 'admin/system/modules#description':
Dries's avatar
 
Dries committed
867
      $output = t("Allows users to collaboratively author a book.");
Dries's avatar
 
Dries committed
868 869
      break;
    case 'admin/node/book':
Dries's avatar
 
Dries committed
870
      $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
871 872
      break;
    case 'admin/node/book/orphan':
Dries's avatar
 
Dries committed
873
      $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
874 875 876 877
      break;

  }

Dries's avatar
 
Dries committed
878
  return $output;
879
}
Dries's avatar
 
Dries committed