book.module 32.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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
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)) {
    $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"));

    $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
122
function book_load($node) {
Dries's avatar
 
Dries committed
123
  global $user;
Dries's avatar
 
Dries committed
124

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

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

Dries's avatar
 
Dries committed
129 130
    /*
    ** If a user is about to update a book page, we overload some
131
    ** fields to reflect the changes.  We use the request URI to
Dries's avatar
 
Dries committed
132
    ** dectect this as we don't want to interfer with updating a
Dries's avatar
 
Dries committed
133
    ** book page through the admin pages.
Dries's avatar
 
Dries committed
134 135
    */

Dries's avatar
 
Dries committed
136 137 138 139 140 141 142 143
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
      $book->name = "";
    }
Dries's avatar
 
Dries committed
144
  }
Dries's avatar
 
Dries committed
145

Dries's avatar
 
Dries committed
146 147 148
  /*
  ** 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
149
  ** always such that the "edit this page"-links appear.
Dries's avatar
 
Dries committed
150
  */
Dries's avatar
 
Dries committed
151

Dries's avatar
 
Dries committed
152
  $book->revision = 1;
Dries's avatar
 
Dries committed
153

Dries's avatar
 
Dries committed
154
  return $book;
Dries's avatar
 
Dries committed
155 156
}

Dries's avatar
 
Dries committed
157
function book_insert($node) {
Dries's avatar
 
Dries committed
158
  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
159
}
Dries's avatar
 
Dries committed
160

Dries's avatar
 
Dries committed
161
function book_update($node) {
Dries's avatar
 
Dries committed
162
  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
163
}
Dries's avatar
 
Dries committed
164

165
function book_delete(&$node) {
Dries's avatar
 
Dries committed
166
  db_query("DELETE FROM {book} WHERE nid = %d", $node->nid);
Dries's avatar
 
Dries committed
167 168
}

169
function book_validate(&$node) {
170
  if ($node->format && user_access("create php content")) {
171 172 173 174 175 176
    // Do not filter PHP code, do not auto-extract a teaser
    $node->teaser = $node->body;
  }
  else {
    $node->format = 0;
  }
Dries's avatar
 
Dries committed
177

178 179 180 181 182 183
  // 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
184 185
}

186
function book_form(&$node, &$help, &$error) {
Dries's avatar
 
Dries committed
187
  global $user;
Dries's avatar
 
Dries committed
188

Dries's avatar
 
Dries committed
189
  $op = $_POST["op"];
190
  $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
191

192 193 194 195
  if (function_exists("taxonomy_node_form")) {
    $output .= implode("", taxonomy_node_form("book", $node));
  }

Dries's avatar
 
Dries committed
196
  $output .= form_textarea(t("Body"), "body", $node->body, 60, 20, form_allowed_tags_text());
197
  $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
198 199

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
200
    $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
201
    if (user_access("create php content")) {
Dries's avatar
 
Dries committed
202
      $output .= form_radios("Type", "format", $node->format, array(0 => "HTML / text", 1 => "PHP"));
Dries's avatar
 
Dries committed
203
    }
Dries's avatar
 
Dries committed
204 205 206 207 208 209 210
  }
  else {

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

Dries's avatar
 
Dries committed
211 212
    $help = book_node("description");

Dries's avatar
 
Dries committed
213 214 215 216 217 218 219 220 221 222 223
    /*
    ** 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
224
function book_node_link($node = 0) {
Dries's avatar
 
Dries committed
225 226 227 228
  global $user;

  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
229 230 231 232 233 234 235 236

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

    if ($op == t("Update book outline")) {
Dries's avatar
 
Dries committed
242
      db_query("UPDATE {book} SET parent = %d, weight = %d WHERE nid = %d", $edit["parent"], $edit["weight"], $node->nid);
Dries's avatar
 
Dries committed
243
      drupal_set_message(t("updated the book outline."));
Dries's avatar
 
Dries committed
244 245 246
    }

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

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

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

      $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
257
      $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
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

      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
274
    return form($output, "post", url("admin/node/book"));
Dries's avatar
 
Dries committed
275 276 277
  }
}

Dries's avatar
 
Dries committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
/*
** 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
316
function book_location($node, $nodes = array()) {
Dries's avatar
 
Dries committed
317 318
  // TODO: eliminate the recursion

Dries's avatar
 
Dries committed
319
  $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
320 321 322 323 324 325 326
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
 
Dries committed
327
function book_location_down($node, $nodes = array()) {
Dries's avatar
 
Dries committed
328 329
  // TODO: eliminate the recursion

Dries's avatar
 
Dries committed
330
  $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
331 332 333 334 335 336 337 338
  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
339 340 341 342 343
  // 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
344
  // previous on the same level
Dries's avatar
 
Dries committed
345
  $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
346 347 348
  if ($direct_above) {
    // get last leaf of $above
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
349 350

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
351 352 353
  }
  else {
    // direct parent
Dries's avatar
 
Dries committed
354
    $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
355 356 357 358 359 360
    return $prev;
  }
}

function book_next($node) {
  // get first direct child
Dries's avatar
 
Dries committed
361
  $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
362 363 364 365
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
366
  // no direct child: get next for this level or any parent in this book
Dries's avatar
 
Dries committed
367
  array_push($path = book_location($node), $node); // path to root node including this one
Dries's avatar
 
Dries committed
368 369
  // loop through nodes to book root, starting with this node
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
 
Dries committed
370
    $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
371 372 373 374 375 376
    if ($next) {
      return $next;
    }
  }
}

Dries's avatar
 
Dries committed
377
function book_content($node, $main = 0) {
Dries's avatar
 
Dries committed
378
  $op = $_POST["op"];
Dries's avatar
 
Dries committed
379

Dries's avatar
 
Dries committed
380 381
  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
 
Dries committed
382 383
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
 
Dries committed
384 385
  */

Dries's avatar
 
Dries committed
386
  if ($op != t("Preview") && $node->moderate && arg(0) != "queue") {
Dries's avatar
 
Dries committed
387 388 389 390 391
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
392 393
  }

Dries's avatar
 
Dries committed
394 395 396 397 398
  /*
  ** Extract the page body.  If body is dynamic (using PHP code), the body
  ** will be generated.
  */

Dries's avatar
 
Dries committed
399 400 401 402 403 404 405 406 407 408 409 410
  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
411
    $node = node_prepare($node, $main);
Dries's avatar
 
Dries committed
412
  }
Dries's avatar
 
Dries committed
413

Dries's avatar
 
Dries committed
414 415 416
  return $node;
}

Dries's avatar
 
Dries committed
417
function book_view($node, $main = 0, $page = 0) {
Dries's avatar
 
Dries committed
418
  $node = book_content($node, $main);
Dries's avatar
 
Dries committed
419 420 421 422 423
  /*
  ** 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
424

Dries's avatar
 
Dries committed
425 426
  $output = "";

Dries's avatar
 
Dries committed
427
  if ($main) {
Dries's avatar
 
Dries committed
428
    $output .= theme("node", $node, $main, $page);
Dries's avatar
 
Dries committed
429
  }
Dries's avatar
 
Dries committed
430
  else {
Dries's avatar
 
Dries committed
431 432 433
    if ($node->moderate) {
      $node->body = $node->body . "<div class=\"log\"><div class=\"title\">". t("Log") .":</div>$node->log</div>";
    }
Dries's avatar
 
Dries committed
434
    // Add the navigation and the breadcrumb if we view a page
Dries's avatar
 
Dries committed
435
    if ($page) {
Dries's avatar
 
Dries committed
436
      $node = book_navigation($node);
Dries's avatar
 
Dries committed
437
      // Print the breadcrumb
Dries's avatar
 
Dries committed
438
      drupal_set_breadcrumb($node->breadcrumb);
Dries's avatar
 
Dries committed
439
    }
Dries's avatar
 
Dries committed
440
    // Print the node
Dries's avatar
 
Dries committed
441
    $output .= theme("node", $node, $main, $page);
Dries's avatar
 
Dries committed
442
  }
Dries's avatar
 
Dries committed
443 444

  return $output;
Dries's avatar
 
Dries committed
445 446 447
}

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

Dries's avatar
 
Dries committed
450
  if (node_access("view", $node)) {
Dries's avatar
 
Dries committed
451

Dries's avatar
 
Dries committed
452
    if ($node->type == "book") {
Dries's avatar
 
Dries committed
453
      $output .= book_view($node, 0, 1);
Dries's avatar
 
Dries committed
454 455
    }
    else {
Dries's avatar
 
Dries committed
456

Dries's avatar
 
Dries committed
457 458
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
Dries's avatar
 
Dries committed
459

Dries's avatar
 
Dries committed
460 461 462
        /*
        ** Add the book navigation if the node is in the book.
        */
Dries's avatar
 
Dries committed
463

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

Dries's avatar
 
Dries committed
466 467 468 469 470 471
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
          $node = book_navigation($node);
        }
Dries's avatar
 
Dries committed
472

Dries's avatar
 
Dries committed
473 474 475
        /*
        ** make $node->type a book. This is for the links.
        */
Dries's avatar
 
Dries committed
476

Dries's avatar
 
Dries committed
477
        $node->type = "book";
Dries's avatar
 
Dries committed
478

Dries's avatar
 
Dries committed
479 480 481
        /*
        ** View the node
        */
Dries's avatar
 
Dries committed
482 483
        drupal_set_breadcrumb($node->breadcrumb);
        $output .= theme("node", $node, 0, 1);
Dries's avatar
 
Dries committed
484 485 486 487 488 489 490
      }
      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
491
        $output .= node_view($node, 0, 1);
Dries's avatar
 
Dries committed
492 493
      }
    }
Dries's avatar
 
Dries committed
494
    if (function_exists("comment_render") && $node->comment) {
Dries's avatar
 
Dries committed
495
      $output .= comment_render($node, $cid);
Dries's avatar
 
Dries committed
496 497
    }

Dries's avatar
 
Dries committed
498
    /*
Dries's avatar
 
Dries committed
499
    ** Update the history table, stating that this user viewed this node.
Dries's avatar
 
Dries committed
500
    */
Dries's avatar
 
Dries committed
501 502
    node_tag_new($node->nid);
  }
Dries's avatar
 
Dries committed
503 504 505 506
  else {
    $output .= message_access();
  }
  return $output;
Dries's avatar
 
Dries committed
507
}
Dries's avatar
 
Dries committed
508

Dries's avatar
 
Dries committed
509
function book_navigation($node) {
Dries's avatar
 
Dries committed
510

Dries's avatar
 
Dries committed
511
    $path = book_location($node);
Dries's avatar
 
Dries committed
512

Dries's avatar
 
Dries committed
513 514 515 516 517 518 519 520
    /*
    ** 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
521
    }
Dries's avatar
 
Dries committed
522

Dries's avatar
 
Dries committed
523
    if ($node->nid) {
Dries's avatar
 
Dries committed
524
      $output .= "<div class=\"book\">";
Dries's avatar
 
Dries committed
525 526 527 528 529 530

      if ($tree = book_tree($node->nid)) {
        $output .= "<div class=\"tree\">". book_tree($node->nid) ."</div>";
      }

      if ($prev = book_prev($node)) {
Dries's avatar
 
Dries committed
531
        $links .= "<div class=\"prev\">";
Dries's avatar
 
Dries committed
532
        $links .= l(t("previous"), "book/view/$prev->nid", array("title" => t("View the previous page.")));
Dries's avatar
 
Dries committed
533 534 535
        $links .= "</div>";
        $titles .= "<div class=\"prev\">$prev->title</div>";
      }
Dries's avatar
 
Dries committed
536 537 538 539
      else {
        $links .= "<div class=\"prev\">&nbsp;</div>"; // make an empty div to fill the space
      }
      if ($next = book_next($node)) {
Dries's avatar
 
Dries committed
540
        $links .= "<div class=\"next\">";
Dries's avatar
 
Dries committed
541
        $links .= l(t("next"), "book/view/$next->nid", array("title" => t("View the next page.")));
Dries's avatar
 
Dries committed
542 543 544
        $links .= "</div>";
        $titles .= "<div class=\"next\">$next->title</div>";
      }
Dries's avatar
 
Dries committed
545 546 547
      else {
        $links .= "<div class=\"next\">&nbsp;</div>"; // make an empty div to fill the space
      }
Dries's avatar
 
Dries committed
548 549
      if ($node->parent) {
        $links .= "<div class=\"up\">";
Dries's avatar
 
Dries committed
550
        $links .= l(t("up"), "book/view/$node->parent", array("title" => t("View this page's parent section.")));
Dries's avatar
 
Dries committed
551 552
        $links .= "</div>";
      }
Dries's avatar
 
Dries committed
553

Dries's avatar
 
Dries committed
554
      $output .= "<div class=\"nav\">";
Dries's avatar
 
Dries committed
555 556
      $output .= " <div class=\"links\">$links</div>";
      $output .= " <div class=\"titles\">$titles</div>";
Dries's avatar
 
Dries committed
557
      $output .= "</div>";
Dries's avatar
 
Dries committed
558
      $output .= "</div>";
Dries's avatar
 
Dries committed
559
    }
Dries's avatar
 
Dries committed
560 561
    $node->body = $node->body.$output;
  return $node;
Dries's avatar
 
Dries committed
562
}
Dries's avatar
 
Dries committed
563

Dries's avatar
 
Dries committed
564 565 566 567 568 569 570 571 572 573 574 575
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
576
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
 
Dries committed
577

Dries's avatar
 
Dries committed
578
  $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
579

Dries's avatar
 
Dries committed
580
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
581 582 583 584
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
 
Dries committed
585
  }
Dries's avatar
 
Dries committed
586 587

  /*
Dries's avatar
 
Dries committed
588 589
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
 
Dries committed
590
  */
Dries's avatar
 
Dries committed
591

Dries's avatar
 
Dries committed
592
  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
593
    $toc[0] = "<". t("root") .">";
Dries's avatar
 
Dries committed
594 595
  }

Dries's avatar
 
Dries committed
596
  /*
Dries's avatar
 
Dries committed
597
  ** Iterate root book nodes:
Dries's avatar
 
Dries committed
598 599
  */

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

Dries's avatar
 
Dries committed
602 603 604
  return $toc;
}

Dries's avatar
 
Dries committed
605

Dries's avatar
 
Dries committed
606
function book_tree_recurse($nid, $depth, $children, $unfold = array()) {
Dries's avatar
 
Dries committed
607
  if ($depth > 0) {
Dries's avatar
 
Dries committed
608 609
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
        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
628
        }
Dries's avatar
 
Dries committed
629 630
      }
    }
Dries's avatar
 
Dries committed
631 632 633 634 635
  }

  return $output;
}

Dries's avatar
 
Dries committed
636

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

Dries's avatar
 
Dries committed
639
  $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
640

Dries's avatar
 
Dries committed
641 642 643 644
  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
645
  }
Dries's avatar
 
Dries committed
646

Dries's avatar
 
Dries committed
647 648 649
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
    return "<ul>$tree</ul>";
  }
Dries's avatar
 
Dries committed
650 651
}

Dries's avatar
 
Dries committed
652

Dries's avatar
 
Dries committed
653
function book_render() {
Dries's avatar
 
Dries committed
654

Dries's avatar
 
Dries committed
655
  $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
656

Dries's avatar
 
Dries committed
657 658 659 660
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));

Dries's avatar
 
Dries committed
661
    if ($node) {
Dries's avatar
 
Dries committed
662 663
      // take the most recent approved revision, extract the page and check output:
      $node = book_content($node);
Dries's avatar
 
Dries committed
664
      // output the content:
Dries's avatar
 
Dries committed
665
      $output .= "<div class=\"book\">";
Dries's avatar
 
Dries committed
666
      $output .= "<div class=\"title\">". l($node->title, "book/view/$node->nid") ."</div>";
Dries's avatar
 
Dries committed
667
      $output .= "<div class=\"body\">". $node->body ."</div>";
Dries's avatar
 
Dries committed
668
      $output .= "</div>";
Dries's avatar
 
Dries committed
669
    }
Dries's avatar
 
Dries committed
670 671
  }

Dries's avatar
 
Dries committed
672
  drupal_set_title(t("Books"));
Dries's avatar
 
Dries committed
673
  print theme("page", $output);
Dries's avatar
 
Dries committed
674 675 676
}

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

Dries's avatar
 
Dries committed
678
  if (user_access("access content")) {
Dries's avatar
 
Dries committed
679
    switch (arg(1)) {
Dries's avatar
 
Dries committed
680
      case "view":
Dries's avatar
 
Dries committed
681
        $node = node_load(array("nid" => arg(2)));
Dries's avatar
 
Dries committed
682 683
        $output = book_show($node, arg(3));
        print theme("page", $output, $node->title);
Dries's avatar
 
Dries committed
684
        break;
Dries's avatar
 
Dries committed
685
      case "print":
Dries's avatar
 
Dries committed
686
        print book_print(arg(2), $depth = 1);
Dries's avatar
 
Dries committed
687 688 689
        break;
      default:
        book_render();
Dries's avatar
 
Dries committed
690 691 692
    }
  }
  else {
Dries's avatar
 
Dries committed
693
    print theme("page", message_access());
Dries's avatar
 
Dries committed
694
  }
Dries's avatar
 
Dries committed
695 696
}

697
function book_print($id = "", $depth = 1) {
Dries's avatar
 
Dries committed
698
  global $base_url;
699
  $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
700

Dries's avatar
 
Dries committed
701 702 703
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
Dries's avatar
 
Dries committed
704

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

Dries's avatar
 
Dries committed
712
      if ($node->body) {
Dries's avatar
 
Dries committed
713
        $output .= $node->body;
Dries's avatar
 
Dries committed
714
      }
Dries's avatar
 
Dries committed
715
    }
Dries's avatar
 
Dries committed
716
  }
Dries's avatar
 
Dries committed
717

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

Dries's avatar
 
Dries committed
720 721 722 723 724 725
  $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
726 727
}

728
function book_print_recurse($parent = "", $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 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
730

Dries's avatar
 
Dries committed
731 732 733 734 735 736
  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
737
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
738 739
    }

Dries's avatar
 
Dries committed
740 741
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
742 743 744
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
      }
Dries's avatar
 
Dries committed
745
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries's avatar
 
Dries committed
746

Dries's avatar
 
Dries committed
747
      if ($node->body) {
Dries's avatar
 
Dries committed
748
        $output .= "<ul>". $node->body ."</ul>";
Dries's avatar
 
Dries committed
749
      }
Dries's avatar
 
Dries committed
750

751
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
752
    }
Dries's avatar
 
Dries committed
753
  }
Dries's avatar
 
Dries committed
754

Dries's avatar
 
Dries committed
755 756
  return $output;
}
Dries's avatar
 
Dries committed
757

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

Dries's avatar
 
Dries committed
760
  $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
761 762

  return $row;
Dries's avatar
 
Dries committed
763 764 765
}

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
 
Dries committed
766
  $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
767 768 769

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

Dries's avatar
 
Dries committed
774
  return $rows;
Dries's avatar
 
Dries committed
775 776 777 778
}

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

Dries's avatar
 
Dries committed
779 780
  if ($nid) {
    $node = node_load(array("nid" => $nid));
Dries's avatar
 
Dries committed
781

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

Dries's avatar
 
Dries committed
784 785 786
    $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
787

Dries's avatar
 
Dries committed
788
    $output .= theme("table", $header, $rows);
Dries's avatar
 
Dries committed
789
    $output .= form_submit(t("Save book pages"));
Dries's avatar
 
Dries committed
790

Dries's avatar
 
Dries committed
791 792
    return form($output);
  }
Dries's avatar
 
Dries committed
793 794 795 796
}

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

Dries's avatar
 
Dries committed
797 798
  if ($nid) {
    $book = node_load(array("nid" => $nid));
Dries's avatar
 
Dries committed
799

Dries's avatar
 
Dries committed
800 801 802 803
    foreach ($edit as $nid => $value) {
      /*
      ** Check to see whether the title needs updating:
      */
Dries's avatar
 
Dries committed
804

Dries's avatar
 
Dries committed
805
      $title = db_result(db_query("SELECT title FROM {node} WHERE nid = %d", $nid));
Dries's avatar
 
Dries committed
806
      if ($title != $value["title"]) {
Dries's avatar
 
Dries committed
807
        db_query("UPDATE {node} SET title = '%s' WHERE nid = %d", $value["title"], $nid);
Dries's avatar
 
Dries committed
808
      }
Dries's avatar
 
Dries committed
809

Dries's avatar
 
Dries committed
810 811 812
      /*
      ** Check to see whether the weight needs updating:
      */
Dries's avatar
 
Dries committed
813

Dries's avatar
 
Dries committed
814
      $weight = db_result(db_query("SELECT weight FROM {book} WHERE nid = %d", $nid));
Dries's avatar
 
Dries committed
815
      if ($weight != $value["weight"]) {
Dries's avatar
 
Dries committed
816
        db_query("UPDATE {book} SET weight = %d WHERE nid = %d", $value["weight"], $nid);
Dries's avatar
 
Dries committed
817
      }
Dries's avatar
 
Dries committed
818 819
    }

Dries's avatar
 
Dries committed
820 821
    $message = t("updated book '%title'", array("%title" => $book->title));
    watchdog("special", $message);
Dries's avatar
 
Dries committed
822

Dries's avatar
 
Dries committed
823 824
    return $message;
  }
Dries's avatar
 
Dries committed
825 826 827 828
}

function book_admin_orphan() {

Dries's avatar
 
Dries committed
829
  $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
830 831 832 833 834

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

Dries's avatar
 
Dries committed
835
  if ($pages) {
Dries's avatar
 
Dries committed
836 837
    $output .= "<h3>Orphan pages</h3>";
    $header = array(t("title"), t("weight"), array("data" => t("operations"), "colspan" => 3));
Dries's avatar
 
Dries committed
838 839
    foreach ($pages as $nid => $node) {
      if ($node->parent && empty($pages[$node->parent])) {
Dries's avatar
 
Dries committed
840 841
        $rows[] = book_admin_view_line($node, $depth);
        $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
 
Dries committed
842
      }
Dries's avatar
 
Dries committed
843
    }
Dries's avatar
 
Dries committed
844
    $output .= theme("table", $header, $rows);
Dries's avatar
 
Dries committed
845 846
  }

Dries's avatar
 
Dries committed
847
  print theme("page", $output);
Dries's avatar
 
Dries committed
848 849 850 851 852 853
}

function book_admin_links() {
}

function book_admin() {
Dries's avatar
 
Dries committed
854 855
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
856 857

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
858
    if (empty($op)) {
Dries's avatar
 
Dries committed
859
      $op = arg(3);
Dries's avatar
 
Dries committed
860 861
    }

Dries's avatar
 
Dries committed
862
    switch ($op) {
Dries's avatar
 
Dries committed
863 864 865 866
      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
867
        $output = book_node_link();
Dries's avatar
 
Dries committed
868
        break;
Dries's avatar
 
Dries committed
869
      case "orphan":
Dries's avatar
 
Dries committed
870
        $output = book_admin_orphan();
Dries's avatar
 
Dries committed
871
        break;
872
      case t("Save book pages"):
Dries's avatar
 
Dries committed
873
        drupal_set_message(book_admin_save(arg(3), $edit));
Dries's avatar
 
Dries committed
874
        // fall through:
Dries's avatar
 
Dries committed
875
      default:
Dries's avatar
 
Dries committed
876
        $output .= book_admin_view(arg(3));
Dries's avatar
 
Dries committed
877 878
        break;
    }
Dries's avatar
 
Dries committed
879
    print theme("page", $output);
Dries's avatar
 
Dries committed
880 881
  }
  else {
Dries's avatar
 
Dries committed
882
    print theme("page", message_access());
Dries's avatar
 
Dries committed
883 884 885
  }
}

Dries's avatar
 
Dries committed
886
function book_help($section = "admin/help#book") {
Dries's avatar
 
Dries committed
887
  $output = "";
888

Dries's avatar
 
Dries committed
889
  switch ($section) {
Dries's avatar
 
Dries committed
890
    case 'admin/help#book':
891
      $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
892 893
      $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>";
894 895
      $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
896 897
      $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>";
898
      $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>";
899
      $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>";
900 901
      $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
902
      break;
Dries's avatar