You are here

README.txt in Book helper 7

Same filename and directory in other branches
  1. 6 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Features
 * Requirements
 * Installation
 * Similar Modules
 * Other notes


INTRODUCTION
------------

The Book helper module improves Drupal core book module's functionality.

Core Book module does a great job at building custom site sections. The Book
helper module enables additional features from Drupal's menu system to improve
the ordering of a book's pages. This module also allows administrators to
further customize a book's navigation block.


FEATURES
--------

- Enhances the book outline manager.
  - Allows a book's link title to be different then the node's title.
    This behavior is similar the menu system's default behavior.
  - Adds 'enable' checkbox (aka hidden) to the manage book outline page.

- Adds an 'Order' tab (node/%/order) to a book's main page.

- Adds 'administer own book outlines' permission for ordering books from a book's main page.

- Removes the 'Outline' tab from all nodes.

- Removes the book fieldset from node edit pages if the content type does not
  allowed book outlines.

- Removes 'add child page' and 'printer-friendly version'

- Removes book navigation

- Customizes visibility of a book's navigation elements.

- Automatically 'Create new book' for selected content types.

- Includes 'Book (inline) navigation' block that can be easily positioned after
  a node's content

- Disables new revisions from being created when a book's node title is updated.

- Displays a warning when deleting a book page (node/%/delete) that has child
  pages.

- Allows top-level pages to be removed from books.
  http://drupal.org/node/283045

- Keeps a book's main page's menu link active while navigating to lower-level
  book pages.


REQUIREMENTS
------------

- Book (core): Allows users to structure site pages in a hierarchy or outline.
  http://drupal.org/documentation/modules/book


INSTALLATION
------------

1. Copy the book_helper directory to the sites/all/modules directory of your
   Drupal installation.

2. Enable the "Book helper" module in "Administration > Modules".
   (admin/modules)

3. Configure additional Book settings (admin/content/book/settings)

4. Create a book with pages.

   4.1. Enable default (core) 'Book navigation' block.
   
   4.2. Enable 'Book helper: Book (inline) navigation' block.


SIMILAR MODULES
---------------

- Book made simple: Automatic creation of a book and simple creation of child
  pages.
  http://drupal.org/project/BookMadeSimple

- Menu Editor enhances the menu editing form with inline text fields for title,
  path and description, and provides placeholders for new items.
  http://drupal.org/project/menu_editor
 

OTHER NOTES
---------------

[Order]

- Check that 'Order' tab is visible on the main book page. (node/%/order)

- Goto 'Books' admin page (admin/content/book) and confirm that
  'edit order and titles' is displaying new UI.

- Test 'sync' checkbox.

- Test 'enable' checkbox. Make 'Book navigation' is hiding disable pages.

- Test 'revert' empty book.

[Outline]

- Goto 'Administer > Content management > Books > Settings.
  (admin/content/book/settings)

- Set 'Remove outline tab from all book pages' to 'Yes'.

- Verify 'Outline' tab is removed from book pages.


[Book Navigation]

- Goto 'Administer > Content management > Books > Settings.
  (admin/content/book/settings)

- Check and uncheck options under 'Select book navigation options:'.
  Verify elements are being removed from book navigation.

- Check 'Remove book navigation from all book pages.'
  Confirm only the book helper block is visible.

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Features
  5. * Requirements
  6. * Installation
  7. * Similar Modules
  8. * Other notes
  9. INTRODUCTION
  10. ------------
  11. The Book helper module improves Drupal core book module's functionality.
  12. Core Book module does a great job at building custom site sections. The Book
  13. helper module enables additional features from Drupal's menu system to improve
  14. the ordering of a book's pages. This module also allows administrators to
  15. further customize a book's navigation block.
  16. FEATURES
  17. --------
  18. - Enhances the book outline manager.
  19. - Allows a book's link title to be different then the node's title.
  20. This behavior is similar the menu system's default behavior.
  21. - Adds 'enable' checkbox (aka hidden) to the manage book outline page.
  22. - Adds an 'Order' tab (node/%/order) to a book's main page.
  23. - Adds 'administer own book outlines' permission for ordering books from a book's main page.
  24. - Removes the 'Outline' tab from all nodes.
  25. - Removes the book fieldset from node edit pages if the content type does not
  26. allowed book outlines.
  27. - Removes 'add child page' and 'printer-friendly version'
  28. - Removes book navigation
  29. - Customizes visibility of a book's navigation elements.
  30. - Automatically 'Create new book' for selected content types.
  31. - Includes 'Book (inline) navigation' block that can be easily positioned after
  32. a node's content
  33. - Disables new revisions from being created when a book's node title is updated.
  34. - Displays a warning when deleting a book page (node/%/delete) that has child
  35. pages.
  36. - Allows top-level pages to be removed from books.
  37. http://drupal.org/node/283045
  38. - Keeps a book's main page's menu link active while navigating to lower-level
  39. book pages.
  40. REQUIREMENTS
  41. ------------
  42. - Book (core): Allows users to structure site pages in a hierarchy or outline.
  43. http://drupal.org/documentation/modules/book
  44. INSTALLATION
  45. ------------
  46. 1. Copy the book_helper directory to the sites/all/modules directory of your
  47. Drupal installation.
  48. 2. Enable the "Book helper" module in "Administration > Modules".
  49. (admin/modules)
  50. 3. Configure additional Book settings (admin/content/book/settings)
  51. 4. Create a book with pages.
  52. 4.1. Enable default (core) 'Book navigation' block.
  53. 4.2. Enable 'Book helper: Book (inline) navigation' block.
  54. SIMILAR MODULES
  55. ---------------
  56. - Book made simple: Automatic creation of a book and simple creation of child
  57. pages.
  58. http://drupal.org/project/BookMadeSimple
  59. - Menu Editor enhances the menu editing form with inline text fields for title,
  60. path and description, and provides placeholders for new items.
  61. http://drupal.org/project/menu_editor
  62. OTHER NOTES
  63. ---------------
  64. [Order]
  65. - Check that 'Order' tab is visible on the main book page. (node/%/order)
  66. - Goto 'Books' admin page (admin/content/book) and confirm that
  67. 'edit order and titles' is displaying new UI.
  68. - Test 'sync' checkbox.
  69. - Test 'enable' checkbox. Make 'Book navigation' is hiding disable pages.
  70. - Test 'revert' empty book.
  71. [Outline]
  72. - Goto 'Administer > Content management > Books > Settings.
  73. (admin/content/book/settings)
  74. - Set 'Remove outline tab from all book pages' to 'Yes'.
  75. - Verify 'Outline' tab is removed from book pages.
  76. [Book Navigation]
  77. - Goto 'Administer > Content management > Books > Settings.
  78. (admin/content/book/settings)
  79. - Check and uncheck options under 'Select book navigation options:'.
  80. Verify elements are being removed from book navigation.
  81. - Check 'Remove book navigation from all book pages.'
  82. Confirm only the book helper block is visible.