function book_help in Drupal 4

Same name and namespace in other branches

1. 8 core/modules/book/book.module \book_help()
2. 5 modules/book/book.module \book_help()
3. 6 modules/book/book.module \book_help()
4. 7 modules/book/book.module \book_help()
5. 9 core/modules/book/book.module \book_help()

Implementation of hook_help().

File

modules/book.module, line 1001

Allows users to collaboratively author a book.

Code

function book_help($section) {
  switch ($section) {
    case 'admin/help#book':
      $output = '<p>' . t('The <em>book</em> content type is suited for creating structured, multi-page hypertexts such as site resource guides, manuals, and Frequently Asked Questions (FAQs).  It permits a document to have chapters, sections, subsections, etc.  Authors with suitable permissions can add pages to a collaborative book,  placing them into the existing document by adding them to a table of contents menu. ') . '</p>';
      $output .= '<p>' . t('Books have additional <em>previous</em>, <em>up</em>, and <em>next</em> navigation elements at the bottom of each page for moving through the text.  Additional navigation may be provided by enabling the <em>book navigation block</em> on the <a href="%admin-block">block administration page</a>.', array(
        '%admin-block' => url('admin/block'),
      )) . '</p>';
      $output .= '<p>' . t('Users can select the <em>printer-friendly version</em> link visible at the bottom of a book page to generate a printer-friendly display of the page and all of its subsections. ') . '</p>';
      $output .= '<p>' . t('Administrators can view a book outline, from which is it possible to change the titles of sections, and their <i>weight</i> (thus reordering sections).   From this outline, it is also possible to edit and/or delete book pages.   Many content types besides pages (for example, blog entries, stories, and polls) can be added to a collaborative book by choosing the <em>outline</em> tab when viewing the post.') . '</p>';
      $output .= t('<p>You can</p>
<ul>
<li>create new book pages: <a href="%node-add-book">create content &gt;&gt; book page</a>.</li>
<li>administer individual books (choose a book from list): <a href="%admin-node-book">administer &gt;&gt; content &gt;&gt; books</a>.</li>
<li>set workflow and other global book settings on the book configuration page: <a href="%admin-settings-content-types-book-page" title="book page content type">administer &gt;&gt; settings &gt;&gt; content types &gt;&gt; configure book page</a>.</li>
<li>enable the book navigation block: <a href="%admin-block">administer &gt;&gt; blocks</a>.</li>
<li>control who can create, edit, and outline posts in books by setting access permissions: <a href="%admin-access">administer &gt;&gt; access control</a>.</li>
</ul>
', array(
        '%node-add-book' => url('node/add/book'),
        '%admin-node-book' => url('admin/node/book'),
        '%admin-settings-content-types-book-page' => url('admin/settings/content-types/book'),
        '%admin-block' => url('admin/block'),
        '%admin-access' => url('admin/access'),
      ));
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="%book">Book page</a>.', array(
        '%book' => 'http://drupal.org/handbook/modules/book/',
      )) . '</p>';
      return $output;
    case 'admin/modules#description':
      return t('Allows users to collaboratively author a book.');
    case 'admin/node/book':
      return t('<p>The book module offers a means to organize content, authored by many users, in an online manual, outline or FAQ.</p>');
    case 'admin/node/book/orphan':
      return t('<p>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 referred to as "orphan pages".  On this page, administrators can review their books for orphans and reattach those pages as desired.</p>');
    case 'node/add#book':
      return 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.");
  }
  if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'outline') {
    return t('The outline feature allows you to include posts in the <a href="%book">book hierarchy</a>.', array(
      '%book' => url('book'),
    ));
  }
}