book.module 32.3 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
}

183
function book_form(&$node, &$help, &$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
  }
  else {

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

Dries's avatar
   
Dries committed
208
209
    $help = book_node("description");

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

  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
226
227
228
229
230
231
232
233

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

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

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

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

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

      $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
254
      $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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270

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

Dries's avatar
   
Dries committed
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
306
307
308
309
310
311
312
/*
** 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
313
function book_location($node, $nodes = array()) {
Dries's avatar
   
Dries committed
314
315
  // TODO: eliminate the recursion

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

Dries's avatar
   
Dries committed
324
function book_location_down($node, $nodes = array()) {
Dries's avatar
   
Dries committed
325
326
  // TODO: eliminate the recursion

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

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

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

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

Dries's avatar
   
Dries committed
374
function book_content($node, $main = 0) {
Dries's avatar
   
Dries committed
375
  $op = $_POST["op"];
Dries's avatar
   
Dries committed
376

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

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

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
   
Dries committed
389
390
  }

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

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

Dries's avatar
   
Dries committed
411
412
413
  return $node;
}

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

Dries's avatar
   
Dries committed
422
423
  $output = "";

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

  return $output;
Dries's avatar
   
Dries committed
442
443
444
}

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

Dries's avatar
   
Dries committed
447
  if (node_access("view", $node)) {
Dries's avatar
   
Dries committed
448

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

Dries's avatar
   
Dries committed
454
455
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
Dries's avatar
   
Dries committed
456

Dries's avatar
   
Dries committed
457
458
459
        /*
        ** Add the book navigation if the node is in the book.
        */
Dries's avatar
   
Dries committed
460

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

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

Dries's avatar
   
Dries committed
470
471
472
        /*
        ** make $node->type a book. This is for the links.
        */
Dries's avatar
   
Dries committed
473

Dries's avatar
   
Dries committed
474
        $node->type = "book";
Dries's avatar
   
Dries committed
475

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

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

Dries's avatar
   
Dries committed
506
function book_navigation($node) {
Dries's avatar
   
Dries committed
507

Dries's avatar
   
Dries committed
508
    $path = book_location($node);
Dries's avatar
   
Dries committed
509

Dries's avatar
   
Dries committed
510
511
512
513
514
515
516
517
    /*
    ** 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
518
    }
Dries's avatar
   
Dries committed
519

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

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

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

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

Dries's avatar
   
Dries committed
575
  $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
576

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

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

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

Dries's avatar
   
Dries committed
593
  /*
Dries's avatar
   
Dries committed
594
  ** Iterate root book nodes:
Dries's avatar
   
Dries committed
595
596
  */

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

Dries's avatar
   
Dries committed
599
600
601
  return $toc;
}

Dries's avatar
 
Dries committed
602

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

  return $output;
}

Dries's avatar
   
Dries committed
633

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

Dries's avatar
   
Dries committed
636
  $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
637

Dries's avatar
   
Dries committed
638
639
640
641
  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
642
  }
Dries's avatar
   
Dries committed
643

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

Dries's avatar
   
Dries committed
649

Dries's avatar
   
Dries committed
650
function book_render() {
Dries's avatar
   
Dries committed
651

Dries's avatar
   
Dries committed
652
  $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
653

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

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

Dries's avatar
   
Dries committed
669
  drupal_set_title(t("Books"));
Dries's avatar
   
Dries committed
670
  print theme("page", $output);
Dries's avatar
   
Dries committed
671
672
673
}

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

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

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

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

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

Dries's avatar
   
Dries committed
709
      if ($node->body) {
Dries's avatar
   
Dries committed
710
        $output .= $node->body;
Dries's avatar
   
Dries committed
711
      }
Dries's avatar
   
Dries committed
712
    }
Dries's avatar
   
Dries committed
713
  }
Dries's avatar
   
Dries committed
714

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

Dries's avatar
   
Dries committed
717
718
719
720
721
722
  $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
723
724
}

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

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

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

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

748
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
   
Dries committed
749
    }
Dries's avatar
   
Dries committed
750
  }
Dries's avatar
   
Dries committed
751

Dries's avatar
   
Dries committed
752
753
  return $output;
}
Dries's avatar
   
Dries committed
754

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

Dries's avatar
   
Dries committed
757
  $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
758
759

  return $row;
Dries's avatar
   
Dries committed
760
761
762
}

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

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

Dries's avatar
   
Dries committed
771
  return $rows;
Dries's avatar
   
Dries committed
772
773
774
775
}

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

Dries's avatar
   
Dries committed
776
777
  if ($nid) {
    $node = node_load(array("nid" => $nid));
Dries's avatar
   
Dries committed
778

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

Dries's avatar
   
Dries committed
781
782
783
    $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
784

Dries's avatar
   
Dries committed
785
    $output .= theme("table", $header, $rows);
Dries's avatar
   
Dries committed
786
    $output .= form_submit(t("Save book pages"));
Dries's avatar
   
Dries committed
787

Dries's avatar
   
Dries committed
788
789
    return form($output);
  }
Dries's avatar
   
Dries committed
790
791
792
793
}

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

Dries's avatar
   
Dries committed
794
795
  if ($nid) {
    $book = node_load(array("nid" => $nid));
Dries's avatar
   
Dries committed
796

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

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

Dries's avatar
   
Dries committed
807
808
809
      /*
      ** Check to see whether the weight needs updating:
      */
Dries's avatar
   
Dries committed
810

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

Dries's avatar
   
Dries committed
817
818
    $message = t("updated book '%title'", array("%title" => $book->title));
    watchdog("special", $message);
Dries's avatar
   
Dries committed
819

Dries's avatar
   
Dries committed
820
821
    return $message;
  }
Dries's avatar
   
Dries committed
822
823
824
825
}

function book_admin_orphan() {

Dries's avatar
   
Dries committed
826
  $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
827
828
829
830
831

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

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

Dries's avatar
   
Dries committed
844
  print theme("page", $output);
Dries's avatar
   
Dries committed
845
846
847
848
849
850
}

function book_admin_links() {
}

function book_admin() {
Dries's avatar
   
Dries committed
851
852
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
853
854

  if (user_access("administer nodes")) {
Dries's avatar
   
Dries committed
855
    if (empty($op)) {
Dries's avatar
   
Dries committed
856
      $op = arg(3);
Dries's avatar
   
Dries committed
857
858
    }

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

Dries's avatar
   
Dries committed
883
function book_help($section = "admin/help#book") {
Dries's avatar
   
Dries committed
884
  $output = "";
885

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

  }

Dries's avatar
   
Dries committed
912
  return $output;
913
}
Dries's avatar
   
Dries committed
914
915

function book_help_page() {
Dries's avatar
   
Dries committed
916
  print theme("page", book_help());
Dries's avatar
   
Dries committed
917
}
Dries's avatar
   
Dries committed
918

Dries's avatar
   
Dries committed
919
?>