Books

Books are an effective way to organize content on a page and allow simple navigation from one item to another. They appear as a table of contents on the left hand of the screen which users can click on to skip to specific topics associated with the book. An example of a book can be found in the Brightspot Component Library.

When creating a Book, two URLs are generated automatically. They are:

• /book-title/
• /book-title/**

Occasionally, the /book-title/** will appear above the other link. If it does, make sure to drag the /book-title/ link to the top, otherwise the chapters of the book may not function properly.

Different sections can be added to the table of contents by adding Chapters, generally using Topics. These topics will show up on their own pages and the table of contents will still appear to the side when the topics are visited. Sub-chapters can also be added to these topics, allowing the table of contents to go as deep as is needed.

Sometimes, instead of creating a whole new page (topic) to show related content on, it is better to add more content onto a pre-existing topic. A good way to do this is using the Rich Text H2 headers. Anything that is placed inside of an H2 header will also be added to the table of contents. When a user clicks on the headers in the table of contents, it will take them to the topic page and automatically scroll down to where the header is located on the page.

Other content items can be added as chapters, such as articles and pages, however when one of these is clicked, the user will be redirected to that item's page (where the Book's table of contents will no longer be available).

Additional information on Books can be found in Brightspot's official documentation. Please check out the Brightspot Component Library to see an example of how a Book works.

Example Book

Creating a Book

To create a book, first click the plus icon at the top of the Brightspot Editor and select Book from the dropdown.

The following features can be configured:

• Headline: This is the name of the book. It will appear at the top of the Book's landing page.
• Display Name: This will be the internal name of the Book inside the editor. Users will not see this. This automatically gets set to the Headline.
• Sub Headline: The Sub Headline appears underneath the headline on the landing page in smaller text
• Navigation Heading: This will appear at the top of each 'page' or Topic in the book. Users can click on the Navigation Heading to return to the Book's main landing page. This automatically gets set to the Headline.

Adding Chapters

Chapters will automatically appear in the table of contents menu as they get created. To add chapters,

1. Click the + button underneath the chapters subheading, then click One Off.
2. Click on the space underneath Link.
3. Underneath Create in the bottom-left corner, open the dropdown and select Topic (any kind of content item can be linked here, but topics will keep users inside the book), then click New.
4. Add a Headline. A sub headline can also be added.
   

   

5. Enter content into the Body rich text module.
6. Click publish to save the topic and make it available for the book.
7. Click the Back button in the top left corner to return to the book. In the Add to Chapters window, click on the topic that was created. If it doesn't appear immediately, try searching for it based on the headline it was given.
8. Once the topic is added, the Title field will automatically be generated to the Headline of the topic.
9. If desired, repeat steps 1-8 to add Sub Chapters. These subchapters will appear in a dropdown underneath the chapter's Title in the table of contents.