Extension/BlueSpiceBookshelf

done
Wiki pages can be organized as structured books with chapter navigation. Books can also be exported as PDF files with a cover page. Books can be grouped into bookshelves, and a wiki page can be included in multiple books.

Introduction page of the user manual with chapter navigation

YouTube: Books (5:22 min.)

Create a book

Create books from the Books page.

Books page with the Create new book action

Create new book

To create a book:

1. Select + Create new book from the page actions.
2. Enter a book title.
3. Enter a subtitle (optional).
4. Select a bookshelf (optional). If no bookshelf is selected, the book is listed under Various books.
5. Upload or select a cover image (optional). If no cover image is selected, a random cover image is applied.
6. Select Save.
7. Select Done. The book editor opens.

Create book dialog with completed fields for a user manual

Create book dialog

An alternative way to create a book is to select New book from the New content button in the header. The remaining steps are the same.

Edit a book

To edit a book:

1. Select Edit in the book preview on the Books page.
2. The book editor opens.

Add pages

Pages can be added as wiki page chapters or text chapter headings.
To add a wiki page chapter:

1. Select + Add element.
2. Select Edit element.
3. For Node type, select Wiki page chapter.
4. Enter the name of the wiki page in Target.
5. Enter the label displayed for the chapter in Text.
6. Select Done.
7. Drag and drop the chapter to the required position.
8. Select Save.
   

To add a text chapter heading:

1. Select + Add element.
2. Select Edit element.
3. For Node type, select Text chapter heading.
4. Enter the chapter heading in Text.
5. Select Done.
6. Drag and drop the chapter heading to the required position.
7. Select Save.

Add multiple pages

Add multiple pages adds several pages to a book based on a selected source.
To add multiple pages:

1. Select Add multiple pages.
2. For Source, select one of the following options:
   • All pages of a category: adds all pages from a selected category to the end of the book.
   • All subpages of a page: adds all subpages of a selected page to the end of the book.
   • Page collection: adds the pages from a page collection to the end of the book.
3. Configure the selected source.
4. Confirm the selection.

Reordering multiple pagesPages added with Add multiple pages cannot currently be moved together to another location in the book. To rearrange the chapters, open the book in source editing mode and copy and paste the chapters into the required order.

Edit book metadata

Book metadata can be edited while editing a book. Some metadata is used when the book is exported as a PDF. All metadata is also available as user-defined document properties in the exported PDF.
The following metadata is available:

Book metadata

Parameter	Description	Included in standard PDF templates
Author 1	User-defined PDF document property; not included on PDF pages.	no
Author 2	User-defined PDF document property; not included on PDF pages.	no
Bookshelf	Determines the bookshelf under which the book is listed on the Books page. It has no relevance for the exported PDF.	no
Bookshelf Image	Image displayed as the book preview image and used as the cover image in the exported PDF.	yes
Department	User-defined PDF document property; not included on PDF pages.	no
Document type	User-defined PDF document property; not included on PDF pages.	no
Document-ID	Manually assigned document ID.	no
PDF export template	Template used to create the PDF. Templates can be defined in the wiki. See PDFCreator.	no
Subtitle	Printed on the cover page.	yes
Title	Printed on the cover page. The title replaces the book title in the PDF output and is used as the PDF file name.	yes
Version	Manually assigned book version number.	no

Export a book

Export the complete book

To export the complete book as a PDF:

1. Select Export on the Books page.
2. The book is downloaded as a PDF.

Export individual chapters

Individual chapters can be selected and exported from the book's chapter tree.
To export individual chapters:

1. Open Pages. If Pages is not available in the navigation, open Special:Pages directly.
2. Select the book.
3. Select the chapters to export.
4. Select Export above the chapter tree.
5. The selected chapters are downloaded as a PDF with a cover page and their original chapter numbering.
   

For information about creating custom PDF export templates, see PDFCreator.

Manage a book

The More actions for this book menu provides additional actions for the current book.

More actions for this book menu

Parameter	Description
Chapters	Chapters opens the book's chapter tree. Individual chapters can be selected and exported from this view.
Delete a book	Delete removes the book, including its table of contents. The wiki pages included in the book are not deleted and are no longer associated with the book.
Edit metadata	Edit metadata opens the book metadata for editing. See Edit book metadata.
Watch a book	Watch adds the book to the list of watched pages.

Add book navigation to a page

The Book table of contents Content Droplet displays the table of contents of an entire book or the chapter navigation of an individual chapter on another wiki page.

Book table of contents Content Droplet showing chapter navigation

Book table of contents

Add a PDF download link to a page

The Book PDF link Content Droplet adds a link to a wiki page that downloads a book directly as a PDF.

Permissions

Edit permissions in the relevant wiki are required to create and edit a book.
A book can only include pages that are readable in the relevant wiki. If a book contains pages that cannot be read with the current permissions, exporting the book as a PDF results in an error.

Configuration

Display options

page excerpt: Extension/BlueSpiceConfigManager#BlueSpiceBookShelf

Export

Wiki administrators can adjust the configuration for book export.
page excerpt: Extension/BlueSpiceConfigManager#Export