summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDries Buytaert2002-06-09 14:02:35 (GMT)
committer Dries Buytaert2002-06-09 14:02:35 (GMT)
commit300e524368c158d4e2ab4c8c426772457c61af2e (patch)
treec69855d72e2afbbbc085282b054e449247ff4b67
parentca9fc85e4bbca7e8cc19801bf28aff4c6c5affa1 (diff)
- Updated the book module documentation a bit.
-rw-r--r--modules/book.module89
-rw-r--r--modules/book/book.module89
2 files changed, 40 insertions, 138 deletions
diff --git a/modules/book.module b/modules/book.module
index 8f02ce4..f8f5d27 100644
--- a/modules/book.module
+++ b/modules/book.module
@@ -725,83 +725,34 @@ function book_admin() {
function book_help() {
?>
+<p>The <i>collaborative book</i> is a magnificient mechanism for organizing content authored by many users. You may use it to organize a manual, to <a href="#faq">maintain a FAQ</a>, or to manage any outline-like content. Books can have chapters, sections, etc. In fact, books can have an arbitrarily deep nesting strucuture.</p>
-<p>The Collaborative Book is a magnificient mechanism for organizing content authored by many users.
-You may use it to organize a Manual (e.g. <a href="http://www.drupal.org">Drupal Handbook</a>),
-to <a href="#faq">maintain a FAQ</a>, or to manage any outline-like content. Books can have
-Chapters, Sections, etc. In fact, books can have an arbitrarily deep nesting strucuture.</p>
-
-<p>Under the covers, a Book is only an organization of nodes. These nodes are often of type <i>book page</i>,
-but can be of any content type. Every node in the book has a <i>Parent</i>. The Parent is the node
-which "contains" the child node. This is how book.module establishes its hierarchy. On any given level
-in the hierarchy, a book can contain many nodes. Book uses the Weight field to order these sibling nodes.</p>
-
-<p>Book pages are a special, powerful node type. These nodes are specifically designed to be included in a book.
-Their special power comes from the bilility 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 '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 usually stored as a new revision of a node. This capability makes it easy to revert to an old version of a page,
-should that become desirable.</p>
-
-<p>Like other node types, Book submissions and edits may be subject to moderation, depending on your configuration.
-Similarly, Books use <? echo la("permissions", array("mod" => "user", "op" => "permission")) ?> 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 Admin 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 <i>create book page</i> link.</p>
-
-<p>Administrators may review the hierarchy of their books by clicking on the <? echo la("Collaborative Book link", array("mod" => "book")) ?> in the Admin center. There, nodes may be edited, reorganized, removed from book, and deleted. This behavior may change in the future. When a Parent node is deleted, he may leave behind child nodes.
+<p>Under the covers, a book is only an organization of nodes. These nodes are often of type <i>book page</i>, but can be of any content type. Every node in the book has a <i>Parent</i>. The parent is the node which "contains" the child node. This is how book.module establishes its hierarchy. On any given level in the hierarchy, a book can contain many nodes. Book uses the Weight field to order these sibling nodes.</p>
+
+<p>Book pages are a special, powerful node type. These nodes are specifically designed to be included in a book. Their special power comes from the bilility 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 usually stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that become desirable.</p>
+
+<p>Like other node types, book submissions and edits may be subject to moderation, depending on your configuration. Similarly, books use <? echo la("permissions", array("mod" => "user", "op" => "permission")) ?> 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 <i>create book page</i> link.</p>
+
+<p>Administrators may review the hierarchy of their books by clicking on the <? echo la("collaborative book link", array("mod" => "book")) ?> 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, he may leave behind child nodes.
These nodes are now <i>orphans</i>. Administrators should periodically <? echo la("review their books for orphans", array("mod" => "book", "op" => "orphan")) ?> and reaffiliate those pages as desired. Finally, administrators may also
<? echo la("export their books", array("mod" => "book", "op" => "feed")) ?> to a single, flat HTML page which is suitable for printing.</p>
-<a name="faq"></a><h3>Maintain an FAQ with <i>Collaborative Book</i></h3>
-
-<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>
-
-<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>
-
-<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>
+<a name="faq"></a><h3>Maintain a FAQ using a collaborative book</i></h3>
+
+<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>
+
+<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 have submitted this book page, you are ready to begin filling up your book with questions that are frequently asked.</p>
+
+<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>
<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 <? echo la("permissions", array("mod" => "user", "op" => "permission")) ?>.</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>
+ <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 <? echo la("permissions", array("mod" => "user", "op" => "permission")) ?>.</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>
-
<?php
-
}
?>
diff --git a/modules/book/book.module b/modules/book/book.module
index 8f02ce4..f8f5d27 100644
--- a/modules/book/book.module
+++ b/modules/book/book.module
@@ -725,83 +725,34 @@ function book_admin() {
function book_help() {
?>
+<p>The <i>collaborative book</i> is a magnificient mechanism for organizing content authored by many users. You may use it to organize a manual, to <a href="#faq">maintain a FAQ</a>, or to manage any outline-like content. Books can have chapters, sections, etc. In fact, books can have an arbitrarily deep nesting strucuture.</p>
-<p>The Collaborative Book is a magnificient mechanism for organizing content authored by many users.
-You may use it to organize a Manual (e.g. <a href="http://www.drupal.org">Drupal Handbook</a>),
-to <a href="#faq">maintain a FAQ</a>, or to manage any outline-like content. Books can have
-Chapters, Sections, etc. In fact, books can have an arbitrarily deep nesting strucuture.</p>
-
-<p>Under the covers, a Book is only an organization of nodes. These nodes are often of type <i>book page</i>,
-but can be of any content type. Every node in the book has a <i>Parent</i>. The Parent is the node
-which "contains" the child node. This is how book.module establishes its hierarchy. On any given level
-in the hierarchy, a book can contain many nodes. Book uses the Weight field to order these sibling nodes.</p>
-
-<p>Book pages are a special, powerful node type. These nodes are specifically designed to be included in a book.
-Their special power comes from the bilility 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 '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 usually stored as a new revision of a node. This capability makes it easy to revert to an old version of a page,
-should that become desirable.</p>
-
-<p>Like other node types, Book submissions and edits may be subject to moderation, depending on your configuration.
-Similarly, Books use <? echo la("permissions", array("mod" => "user", "op" => "permission")) ?> 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 Admin 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 <i>create book page</i> link.</p>
-
-<p>Administrators may review the hierarchy of their books by clicking on the <? echo la("Collaborative Book link", array("mod" => "book")) ?> in the Admin center. There, nodes may be edited, reorganized, removed from book, and deleted. This behavior may change in the future. When a Parent node is deleted, he may leave behind child nodes.
+<p>Under the covers, a book is only an organization of nodes. These nodes are often of type <i>book page</i>, but can be of any content type. Every node in the book has a <i>Parent</i>. The parent is the node which "contains" the child node. This is how book.module establishes its hierarchy. On any given level in the hierarchy, a book can contain many nodes. Book uses the Weight field to order these sibling nodes.</p>
+
+<p>Book pages are a special, powerful node type. These nodes are specifically designed to be included in a book. Their special power comes from the bilility 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 usually stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that become desirable.</p>
+
+<p>Like other node types, book submissions and edits may be subject to moderation, depending on your configuration. Similarly, books use <? echo la("permissions", array("mod" => "user", "op" => "permission")) ?> 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 <i>create book page</i> link.</p>
+
+<p>Administrators may review the hierarchy of their books by clicking on the <? echo la("collaborative book link", array("mod" => "book")) ?> 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, he may leave behind child nodes.
These nodes are now <i>orphans</i>. Administrators should periodically <? echo la("review their books for orphans", array("mod" => "book", "op" => "orphan")) ?> and reaffiliate those pages as desired. Finally, administrators may also
<? echo la("export their books", array("mod" => "book", "op" => "feed")) ?> to a single, flat HTML page which is suitable for printing.</p>
-<a name="faq"></a><h3>Maintain an FAQ with <i>Collaborative Book</i></h3>
-
-<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>
-
-<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>
-
-<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>
+<a name="faq"></a><h3>Maintain a FAQ using a collaborative book</i></h3>
+
+<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>
+
+<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 have submitted this book page, you are ready to begin filling up your book with questions that are frequently asked.</p>
+
+<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>
<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 <? echo la("permissions", array("mod" => "user", "op" => "permission")) ?>.</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>
+ <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 <? echo la("permissions", array("mod" => "user", "op" => "permission")) ?>.</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>
-
<?php
-
}
?>