book.module 32.1 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
function book_block($op = 'list', $delta = 0) {

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

    $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 (arg(1) == 'edit' && !user_access("administer nodes")) {
Dries's avatar
   
Dries committed
128
129
    /*
    ** If a user is about to update a book page, we overload some
Dries's avatar
   
Dries committed
130
    ** fields to reflect the changes.
Dries's avatar
   
Dries committed
131
132
    */

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

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

Dries's avatar
   
Dries committed
149
  $book->revision = 1;
Dries's avatar
   
Dries committed
150

Dries's avatar
   
Dries committed
151
  return $book;
Dries's avatar
   
Dries committed
152
153
}

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

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

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

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

175
176
177
178
179
180
  // 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
181
182
}

Dries's avatar
   
Dries committed
183
function book_form(&$node, &$error) {
Dries's avatar
   
Dries committed
184
  global $user;
Dries's avatar
   
Dries committed
185

Dries's avatar
   
Dries committed
186
  $op = $_POST["op"];
187
  $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
188

189
190
191
192
  if (function_exists("taxonomy_node_form")) {
    $output .= implode("", taxonomy_node_form("book", $node));
  }

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

  if (user_access("administer nodes")) {
Dries's avatar
   
Dries committed
197
    $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
198
    if (user_access("create php content")) {
Dries's avatar
   
Dries committed
199
      $output .= form_radios("Type", "format", $node->format, array(0 => "HTML / text", 1 => "PHP"));
Dries's avatar
   
Dries committed
200
    }
Dries's avatar
   
Dries committed
201
202
203
204
205
206
207
208
209
210
211
212
213
  }
  else {
    /*
    ** If a regular user updates a book page, we create a new revision
    ** authored by that user:
    */

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

  return $output;
}

Dries's avatar
   
Dries committed
214
function book_node_link($node = 0) {
Dries's avatar
   
Dries committed
215
216
217
218
  global $user;

  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
219
220
221
222
223
224
225
226

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

    if ($op == t("Update book outline")) {
Dries's avatar
   
Dries committed
232
      db_query("UPDATE {book} SET parent = %d, weight = %d WHERE nid = %d", $edit["parent"], $edit["weight"], $node->nid);
Dries's avatar
   
Dries committed
233
      drupal_set_message(t("updated the book outline."));
Dries's avatar
   
Dries committed
234
235
236
    }

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

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

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

      $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
247
      $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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263

      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
264
    return form($output, "post", url("admin/node/book"));
Dries's avatar
   
Dries committed
265
266
267
  }
}

Dries's avatar
   
Dries committed
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
/*
** 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
306
function book_location($node, $nodes = array()) {
Dries's avatar
   
Dries committed
307
308
  // TODO: eliminate the recursion

Dries's avatar
   
Dries committed
309
  $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
310
311
312
313
314
315
316
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
   
Dries committed
317
function book_location_down($node, $nodes = array()) {
Dries's avatar
   
Dries committed
318
319
  // TODO: eliminate the recursion

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

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
   
Dries committed
341
342
343
  }
  else {
    // direct parent
Dries's avatar
   
Dries committed
344
    $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
345
346
347
348
349
350
    return $prev;
  }
}

function book_next($node) {
  // get first direct child
Dries's avatar
   
Dries committed
351
  $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
352
353
354
355
  if ($child) {
    return $child;
  }

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

Dries's avatar
   
Dries committed
367
function book_content($node, $main = 0) {
Dries's avatar
   
Dries committed
368
  $op = $_POST["op"];
Dries's avatar
   
Dries committed
369

Dries's avatar
   
Dries committed
370
371
  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
   
Dries committed
372
373
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
   
Dries committed
374
375
  */

Dries's avatar
   
Dries committed
376
  if ($op != t("Preview") && $node->moderate && arg(0) != "queue") {
Dries's avatar
   
Dries committed
377
378
379
380
381
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
   
Dries committed
382
383
  }

Dries's avatar
   
Dries committed
384
385
386
387
388
  /*
  ** Extract the page body.  If body is dynamic (using PHP code), the body
  ** will be generated.
  */

Dries's avatar
   
Dries committed
389
390
391
392
393
394
395
396
397
398
399
400
  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
401
    $node = node_prepare($node, $main);
Dries's avatar
   
Dries committed
402
  }
Dries's avatar
   
Dries committed
403

Dries's avatar
   
Dries committed
404
405
406
  return $node;
}

Dries's avatar
   
Dries committed
407
function book_view($node, $main = 0, $page = 0) {
Dries's avatar
   
Dries committed
408
  $node = book_content($node, $main);
Dries's avatar
   
Dries committed
409
410
411
412
413
  /*
  ** 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
414

Dries's avatar
   
Dries committed
415
416
  $output = "";

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

  return $output;
Dries's avatar
   
Dries committed
435
436
437
}

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

Dries's avatar
   
Dries committed
440
  if (node_access("view", $node)) {
Dries's avatar
   
Dries committed
441

Dries's avatar
   
Dries committed
442
    if ($node->type == "book") {
Dries's avatar
   
Dries committed
443
      $output .= book_view($node, 0, 1);
Dries's avatar
   
Dries committed
444
445
    }
    else {
Dries's avatar
   
Dries committed
446

Dries's avatar
   
Dries committed
447
448
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
Dries's avatar
   
Dries committed
449

Dries's avatar
   
Dries committed
450
451
452
        /*
        ** Add the book navigation if the node is in the book.
        */
Dries's avatar
   
Dries committed
453

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

Dries's avatar
   
Dries committed
456
457
458
459
460
461
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
          $node = book_navigation($node);
        }
Dries's avatar
   
Dries committed
462

Dries's avatar
   
Dries committed
463
464
465
        /*
        ** make $node->type a book. This is for the links.
        */
Dries's avatar
   
Dries committed
466

Dries's avatar
   
Dries committed
467
        $node->type = "book";
Dries's avatar
   
Dries committed
468

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

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

Dries's avatar
   
Dries committed
499
function book_navigation($node) {
Dries's avatar
   
Dries committed
500

Dries's avatar
   
Dries committed
501
  $path = book_location($node);
Dries's avatar
   
Dries committed
502

Dries's avatar
   
Dries committed
503
504
505
506
507
508
509
510
511
  /*
  ** 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
512

Dries's avatar
   
Dries committed
513
514
515
516
517
  if ($node->nid) {
    $output .= "<div class=\"book\">";

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

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

Dries's avatar
   
Dries committed
544
545
546
547
548
549
    $output .= "<div class=\"nav\">";
    $output .= " <div class=\"links\">$links</div>";
    $output .= " <div class=\"titles\">$titles</div>";
    $output .= "</div>";
    $output .= "</div>";
  }
Dries's avatar
   
Dries committed
550

Dries's avatar
   
Dries committed
551
  $node->body = $node->body.$output;
Dries's avatar
   
Dries committed
552

Dries's avatar
   
Dries committed
553
  return $node;
Dries's avatar
   
Dries committed
554
}
Dries's avatar
 
Dries committed
555

Dries's avatar
   
Dries committed
556
557
558
559
560
561
562
563
564
565
566
567
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
568
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
   
Dries committed
569

Dries's avatar
   
Dries committed
570
  $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
571

Dries's avatar
   
Dries committed
572
  while ($node = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
573
574
575
576
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
   
Dries committed
577
  }
Dries's avatar
   
Dries committed
578
579

  /*
Dries's avatar
   
Dries committed
580
581
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
   
Dries committed
582
  */
Dries's avatar
   
Dries committed
583

Dries's avatar
   
Dries committed
584
  if (user_access("administer nodes")) {
Dries's avatar
   
Dries committed
585
    $toc[0] = "<". t("root") .">";
Dries's avatar
   
Dries committed
586
587
  }

Dries's avatar
   
Dries committed
588
  /*
Dries's avatar
   
Dries committed
589
  ** Iterate root book nodes:
Dries's avatar
   
Dries committed
590
591
  */

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

Dries's avatar
   
Dries committed
594
595
596
  return $toc;
}

Dries's avatar
 
Dries committed
597

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

  return $output;
}

Dries's avatar
   
Dries committed
628

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

Dries's avatar
   
Dries committed
631
  $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
632

Dries's avatar
   
Dries committed
633
634
635
636
  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
637
  }
Dries's avatar
   
Dries committed
638

Dries's avatar
   
Dries committed
639
640
641
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
    return "<ul>$tree</ul>";
  }
Dries's avatar
   
Dries committed
642
643
}

Dries's avatar
   
Dries committed
644

Dries's avatar
   
Dries committed
645
function book_render() {
Dries's avatar
   
Dries committed
646

Dries's avatar
   
Dries committed
647
  $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
648

Dries's avatar
   
Dries committed
649
650
651
652
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));

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

Dries's avatar
   
Dries committed
664
  drupal_set_title(t("Books"));
Dries's avatar
   
Dries committed
665
  print theme("page", $output);
Dries's avatar
   
Dries committed
666
667
668
}

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

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

689
function book_print($id = "", $depth = 1) {
Dries's avatar
   
Dries committed
690
  global $base_url;
691
  $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
692

Dries's avatar
   
Dries committed
693
694
695
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
Dries's avatar
   
Dries committed
696

Dries's avatar
   
Dries committed
697
698
    if ($node) {
      // output the content:
Dries's avatar
   
Dries committed
699
700
701
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
      }
Dries's avatar
   
Dries committed
702
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries's avatar
   
Dries committed
703

Dries's avatar
   
Dries committed
704
      if ($node->body) {
Dries's avatar
   
Dries committed
705
        $output .= $node->body;
Dries's avatar
   
Dries committed
706
      }
Dries's avatar
   
Dries committed
707
    }
Dries's avatar
   
Dries committed
708
  }
Dries's avatar
   
Dries committed
709

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

Dries's avatar
   
Dries committed
712
713
714
715
716
717
  $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
718
719
}

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

Dries's avatar
   
Dries committed
723
724
725
726
727
728
  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
729
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
   
Dries committed
730
731
    }

Dries's avatar
   
Dries committed
732
733
    if ($node) {
      // output the content:
Dries's avatar
   
Dries committed
734
735
736
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
      }
Dries's avatar
   
Dries committed
737
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries's avatar
   
Dries committed
738

Dries's avatar
   
Dries committed
739
      if ($node->body) {
Dries's avatar
   
Dries committed
740
        $output .= "<ul>". $node->body ."</ul>";
Dries's avatar
   
Dries committed
741
      }
Dries's avatar
   
Dries committed
742

743
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
   
Dries committed
744
    }
Dries's avatar
   
Dries committed
745
  }
Dries's avatar
   
Dries committed
746

Dries's avatar
   
Dries committed
747
748
  return $output;
}
Dries's avatar
   
Dries committed
749

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

Dries's avatar
   
Dries committed
752
  $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
753
754

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

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
   
Dries committed
758
  $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
759
760
761

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

Dries's avatar
   
Dries committed
766
  return $rows;
Dries's avatar
   
Dries committed
767
768
769
770
}

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

Dries's avatar
   
Dries committed
771
772
  if ($nid) {
    $node = node_load(array("nid" => $nid));
Dries's avatar
   
Dries committed
773

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

Dries's avatar
   
Dries committed
776
777
778
    $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
779

Dries's avatar
   
Dries committed
780
    $output .= theme("table", $header, $rows);
Dries's avatar
   
Dries committed
781
    $output .= form_submit(t("Save book pages"));
Dries's avatar
   
Dries committed
782

Dries's avatar
   
Dries committed
783
784
    return form($output);
  }
Dries's avatar
   
Dries committed
785
786
787
788
}

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

Dries's avatar
   
Dries committed
789
790
  if ($nid) {
    $book = node_load(array("nid" => $nid));
Dries's avatar
   
Dries committed
791

Dries's avatar
   
Dries committed
792
793
794
795
    foreach ($edit as $nid => $value) {
      /*
      ** Check to see whether the title needs updating:
      */
Dries's avatar
   
Dries committed
796

Dries's avatar
   
Dries committed
797
      $title = db_result(db_query("SELECT title FROM {node} WHERE nid = %d", $nid));
Dries's avatar
   
Dries committed
798
      if ($title != $value["title"]) {
Dries's avatar
   
Dries committed
799
        db_query("UPDATE {node} SET title = '%s' WHERE nid = %d", $value["title"], $nid);
Dries's avatar
   
Dries committed
800
      }
Dries's avatar
   
Dries committed
801

Dries's avatar
   
Dries committed
802
803
804
      /*
      ** Check to see whether the weight needs updating:
      */
Dries's avatar
   
Dries committed
805

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

Dries's avatar
   
Dries committed
812
813
    $message = t("updated book '%title'", array("%title" => $book->title));
    watchdog("special", $message);
Dries's avatar
   
Dries committed
814

Dries's avatar
   
Dries committed
815
816
    return $message;
  }
Dries's avatar
   
Dries committed
817
818
819
820
}

function book_admin_orphan() {

Dries's avatar
   
Dries committed
821
  $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
822
823
824
825
826

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

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

Dries's avatar
   
Dries committed
839
  print theme("page", $output);
Dries's avatar
   
Dries committed
840
841
842
843
844
845
}

function book_admin_links() {
}

function book_admin() {
Dries's avatar
   
Dries committed
846
847
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
848
849

  if (user_access("administer nodes")) {
Dries's avatar
   
Dries committed
850
    if (empty($op)) {
Dries's avatar
   
Dries committed
851
      $op = arg(3);
Dries's avatar
   
Dries committed
852
853
    }

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

Dries's avatar
   
Dries committed
878
function book_help($section = "admin/help#book") {
Dries's avatar
   
Dries committed
879
  $output = "";
880

Dries's avatar
   
Dries committed
881
  switch ($section) {
Dries's avatar
   
Dries committed
882
    case 'admin/help#book':
883
      $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
884
885
      $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>";
886
887
      $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
888
889
      $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>";
890
      $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>";
891
      $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>";
892
893
      $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
894
      break;
Dries's avatar
   
Dries committed
895
    case 'admin/system/modules#description':
Dries's avatar
   
Dries committed
896
      $output = t("Allows users to collaboratively author a book.");
Dries's avatar
   
Dries committed
897
898
      break;
    case 'admin/node/book':
Dries's avatar
   
Dries committed
899
      $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
900
901
      break;
    case 'admin/node/book/orphan':
Dries's avatar
   
Dries committed
902
      $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
903
904
905
      break;
  }

Dries's avatar
   
Dries committed
906
  return $output;
907
}
Dries's avatar
   
Dries committed
908
909

function book_help_page() {
Dries's avatar
   
Dries committed
910
  print theme("page", book_help());
Dries's avatar
   
Dries committed
911
}
Dries's avatar
   
Dries committed
912

Dries's avatar
   
Dries committed
913
?>