-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue #3047806 by jhodgdon, Gayathri J, thejimbirch, anmolgoyal74, lu…
…woldy, batigolix, shimpy, alonaoneill, volkswagenchick, tatarbj, Amber Himes Matz, rkoller, CelSki, xjm: Convert book.module hook_help() to topic(s) (cherry picked from commit c61c5dc139c00eee96889f7eb38468a5c7ef516c)
- Loading branch information
Showing
5 changed files
with
102 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
label: 'Managing books' | ||
top_level: true | ||
--- | ||
{% set user_topic = render_var(url('help.help_topic', {'id': 'user.overview'})) %} | ||
<h2>{% trans %}What is a book?{% endtrans %}</h2> | ||
<p>{% trans %}A book is a structured group of content pages, arranged in a hierarchical structure called a <em>book outline</em>. A book hierarchy can be up to nine levels deep, and a book can include <em>Book page</em> content items or other content items. Every book has a default book-specific navigation block, which contains links that lead to the previous and next pages in the book and to the level above the current page in the book's structure.{% endtrans %}</p> | ||
<h2>{% trans %}What are the permissions for books?{% endtrans %}</h2> | ||
<p>{% trans %}The following permissions are needed to create and manage books; see <a href="{{ user_topic }}">Managing user accounts and site visitors</a> and its related topics for more about permissions.{% endtrans %}</p> | ||
<dl> | ||
<dt>{% trans %}Create new books{% endtrans %}</dt> | ||
<dd>{% trans %}Allows users to add new books to the site.{% endtrans %}</dd> | ||
<dt>{% trans %}Add content and child pages to books and manage their hierarchies{% endtrans %}</dt> | ||
<dd>{% trans %}Allows users to add configured types of content to existing books.{% endtrans %}</dd> | ||
<dt>{% trans %}Administer book outlines{% endtrans %}</dt> | ||
<dd>{% trans %}Allows users to add <em>any</em> type of content to a book, use the book overview administration page, and rearrange the pages of a book from the book outline page.{% endtrans %} | ||
<dt>{% trans %}Administer site configuration (in the System module section){% endtrans %}</dt> | ||
<dd>{% trans %}Allows users to do many site configuration tasks, including configuring books. This permission has security implications.{% endtrans %} | ||
</dd> | ||
<dt>{% trans %}View printer-friendly books{% endtrans %}</dt> | ||
<dd>{% trans %}Allows users to click the <em>printer-friendly version</em> link to generate a printer-friendly display of the page, which includes pages below it in the book outline.{% endtrans %} | ||
</dd> | ||
<dt>{% trans %}<em>Book page</em> content permissions (in the Node module section){% endtrans %}</dt> | ||
<dd>{% trans %}Like other content types, the <em>Book page</em> content type has separate permissions for creating, editing, and deleting a user's own and any content items of this type.{% endtrans %} | ||
</dd> | ||
</dl> | ||
<h2>{% trans %}Managing books{% endtrans %}</h2> | ||
<p>{% trans %}Book management is handled by the core Book module. The topics listed below will help you create, edit, and configure books.{% endtrans %}</p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
label: 'Adding content to a book' | ||
related: | ||
- book.about | ||
- book.configuring | ||
- book.creating | ||
- book.organizing | ||
--- | ||
{% set node_add = render_var(url('node.add_page')) %} | ||
{% set config = render_var(url('help.help_topic', {'id': 'book.configuring'})) %} | ||
<h2>{% trans %}Goal{% endtrans %}</h2> | ||
<p>{% trans %}Add a page to an existing book.{% endtrans %}</p> | ||
<h2>{% trans %}Steps{% endtrans %}</h2> | ||
<ol> | ||
<li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Content</em> > <a href="{{ node_add }}"><em>Add content</em></a> > <em>Book page</em>. If you have configured additional content types that can be added to books, you can substitute a different content type for <em>Book page</em> (see the <a href="{{ config }}">Configuring books</a> topic for more information).{% endtrans %}</li> | ||
<li>{% trans %}Enter a title for the page and some text for the body of the page.{% endtrans %}</li> | ||
<li>{% trans %}In the vertical tabs area, click <em>Book Outline</em>. Select the book you want to add the page to in the <em>Book</em> select list. If you want to insert this page into the book hierarchy, also select the desired parent page in the <em>Parent item</em> select list.{% endtrans %}</li> | ||
<li>{% trans %}Select the desired weight for the page in the <em>Weight</em> select list (pages with the same parent item are ordered from lowest to highest weight).{% endtrans %}</li> | ||
<li>{% trans %}Click <em>Save</em> to add the page to the book.{% endtrans %}</li> | ||
</ol> |
18 changes: 18 additions & 0 deletions
18
modules/help_topics/help_topics/book.configuring.html.twig
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
label: 'Configuring books' | ||
related: | ||
- book.about | ||
- book.adding | ||
- book.creating | ||
- book.organizing | ||
--- | ||
{% set settings = render_var(url('book.settings')) %} | ||
<h2>{% trans %}Goal{% endtrans %}</h2> | ||
<p>{% trans %}Configure settings related to books.{% endtrans %}</p> | ||
<h2>{% trans %}Steps{% endtrans %}</h2> | ||
<ol> | ||
<li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Structure</em> > <em>Books</em> > <a href="{{ settings }}"><em>Settings</em></a>.{% endtrans %}</li> | ||
<li>{% trans %}Check all of the content types that you would like to use as book pages in the <em>Content types allowed in book outlines</em> field.{% endtrans %}</li> | ||
<li>{% trans %}In the <em>Content type for the Add child page link</em> field, select the content type that will be created from the <em>Add child page</em> link on a book page.{% endtrans %}</li> | ||
<li>{% trans %}Click <em>Save configuration</em>.{% endtrans %}</li> | ||
</ol> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
label: 'Creating a book' | ||
related: | ||
- book.about | ||
- book.adding | ||
- book.organizing | ||
- book.configuring | ||
--- | ||
<h2>{% trans %}Goal{% endtrans %}</h2> | ||
<p>{% trans %}Create a new book.{% endtrans %}</p> | ||
<h2>{% trans %}Steps{% endtrans %}</h2> | ||
<ol> | ||
<li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Content</em> > <em>Add content</em> > <em>Book page</em>. If you have configured additional content types that can be added to books, you can substitute a different content type for <em>Book page</em>.{% endtrans %}</li> | ||
<li>{% trans %}Enter a title for the book, and if desired, some text for the body of the book's title page.{% endtrans %}</li> | ||
<li>{% trans %}In the vertical tabs area, click <em>Book Outline</em>. Select <em>- Create a new book -</em> from the <em>Book</em> select list.{% endtrans %}</li> | ||
<li>{% trans %}Click <em>Save</em> to create the book.{% endtrans %}</li> | ||
</ol> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
label: 'Changing the outline of a book' | ||
related: | ||
- book.about | ||
- book.adding | ||
- book.creating | ||
- book.configuring | ||
--- | ||
{% set overview = render_var(url('book.admin')) %} | ||
<h2>{% trans %}Goal{% endtrans %}</h2> | ||
<p>{% trans %}Change the order and titles of pages within a book.{% endtrans %}</p> | ||
<h2>{% trans %}Steps{% endtrans %}</h2> | ||
<ol> | ||
<li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Structure</em> > <a href="{{ overview }}"><em>Books</em></a>.{% endtrans %}</li> | ||
<li>{% trans %}Click <em>Edit order and titles</em> for the book you would like to change.{% endtrans %}</li> | ||
<li>{% trans %}Drag the book pages to the desired order.{% endtrans %}</li> | ||
<li>{% trans %}If desired, enter new text for one or more of the page titles within the book.{% endtrans %}</li> | ||
<li>{% trans %}Click <em>Save book pages</em>.{% endtrans %}</li> | ||
</ol> |