From cca3c34faa9c1d5fc56e88e42f1c8054b4c4eaac Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Sat, 9 Oct 2004 06:29:16 +0000 Subject: - Patch #11401 by Goba: documentation updates: + Made error strings in blog.module consistent. + Explained a bit better what the RSD setting is for in the blog module. + Removed the notes about PHP content from block module and book module, since everything is handled via the input formats now. --- modules/book.module | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'modules/book.module') diff --git a/modules/book.module b/modules/book.module index 9184262f5..0e9fc11a4 100644 --- a/modules/book.module +++ b/modules/book.module @@ -792,14 +792,14 @@ function book_help($section) { return t("

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.

A book is simply a collection of nodes that have been linked together. These nodes are usually of type book page, but you can insert nodes of any type into a book outline. Every node in the book has a parent 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 weight that you give them.

-

A book page is a special node type that allows you to embed PHP within the body of the page. This capability is only offered to administrators, since malicious users could abuse this power. In addition, book pages contain a log message 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.

+

Book pages contain a log message 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.

Like other node types, book submissions and edits may be subject to moderation, depending on your configuration. Similarly, books use permissions 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 <top-level>. To include an existing node in your book, click on the \"outline\"-tab on the node's page. 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 create content » book page link.

Administrators may review the hierarchy of their books by clicking on the collaborative book 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 orphans. Administrators should periodically review their books for orphans and reaffiliate those pages as desired. Finally, administrators may also export their books to a single, flat HTML page which is suitable for printing.

Maintaining a FAQ using a collaborative book

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!

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 create content » book page 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 <top-level> as the parent of this page. Leave the log message and type 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.

Whenever you come across a post which you want to include in your FAQ, click on the administer link. Then click on the edit book outline button at the bottom of the page. Then place the relevant post wherever is most appropriate in your book by selecting a parent. Books are quite flexible. They can have sections like Flying to Estonia, Eating in Estonia and so on. As you get more experienced with the book module, you can reorganize posts in your book so that it stays organized.

-

Notes:

", array('%permissions' => url('admin/user/configure/permission'), "%create" => url('node/add/book'), '%collaborative-book' => url('admin/node/book'), '%orphans-book' => url('admin/node/book/orphan'), '%export-book' => url('book/print'))); +

Notes:

", array('%permissions' => url('admin/user/configure/permission'), "%create" => url('node/add/book'), '%collaborative-book' => url('admin/node/book'), '%orphans-book' => url('admin/node/book/orphan'), '%export-book' => url('book/print'))); case 'admin/modules#description': return t('Allows users to collaboratively author a book.'); case 'admin/node/book': -- cgit v1.2.3