From 1e8c9d8192d0f8c17c64bcd09f34219f4832b368 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Tue, 26 Mar 2002 21:33:45 +0000
Subject: - Included documentation contributed by Moshe.

---
 modules/book.module      | 9 +++++++++
 modules/book/book.module | 9 +++++++++
 2 files changed, 18 insertions(+)

diff --git a/modules/book.module b/modules/book.module
index f49afab15..dd8b1a606 100644
--- a/modules/book.module
+++ b/modules/book.module
@@ -1,6 +1,15 @@
 <?php
 // $Id$
 
+function book_help() {
+  $output .= "<h3>Maintain a FAQ with <i>Collaborative book</i></h3>";
+  $output .= "<p>The collaborative book (i.e. <code>book.module</code>) in Drupal is a terrific way to easily manage an FAQ (Frequently Asked Questions) section of your web site. The main benefit for an administrator is that you don't have to write all the questions/answers by yourself.  Let the community do it for you!</p>";
+  $output .= "<p>In order to setup the FAQ, you have to create a new <i>book</i> which will hold all your content.  To do so, click on <i>create book page</i> in your user box.  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><root></i> as the parent of this page.  Leave the <i>log message</i> and <i>type</i> fields blank for now.  After you've submitted this book page, you are ready to begin filling up your book with questions that are frequently asked.</p>";
+  $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 <i>Collaborative book</i>, you can reorganize posts in your book so that it stays organized.</p>";
+  $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. And remember that all future comments and edits will automatically be reflected in your book.</li><li>You may wish to edit the title and teaser 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 help users navigate quickly to the information that they seek.</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 <i>create book page</i> link.</li><li>If you don't see the <i>administer</i> link, then you probably have insufficient <a href=\"admin.php?mod=user&op=permission\">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>";
+  return $output;
+}
+
 function book_node($field) {
   global $user;
 
diff --git a/modules/book/book.module b/modules/book/book.module
index f49afab15..dd8b1a606 100644
--- a/modules/book/book.module
+++ b/modules/book/book.module
@@ -1,6 +1,15 @@
 <?php
 // $Id$
 
+function book_help() {
+  $output .= "<h3>Maintain a FAQ with <i>Collaborative book</i></h3>";
+  $output .= "<p>The collaborative book (i.e. <code>book.module</code>) in Drupal is a terrific way to easily manage an FAQ (Frequently Asked Questions) section of your web site. The main benefit for an administrator is that you don't have to write all the questions/answers by yourself.  Let the community do it for you!</p>";
+  $output .= "<p>In order to setup the FAQ, you have to create a new <i>book</i> which will hold all your content.  To do so, click on <i>create book page</i> in your user box.  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><root></i> as the parent of this page.  Leave the <i>log message</i> and <i>type</i> fields blank for now.  After you've submitted this book page, you are ready to begin filling up your book with questions that are frequently asked.</p>";
+  $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 <i>Collaborative book</i>, you can reorganize posts in your book so that it stays organized.</p>";
+  $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. And remember that all future comments and edits will automatically be reflected in your book.</li><li>You may wish to edit the title and teaser 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 help users navigate quickly to the information that they seek.</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 <i>create book page</i> link.</li><li>If you don't see the <i>administer</i> link, then you probably have insufficient <a href=\"admin.php?mod=user&op=permission\">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>";
+  return $output;
+}
+
 function book_node($field) {
   global $user;
 
-- 
cgit v1.2.3