Manual:Extension/BlueSpiceBookshelf

BlueSpice 4.5:This help page applies to the book functionality for BlueSpice 4.5+. For earlier versions, go to the previous documentation.

In BlueSpice pro, wiki pages can be displayed as a structured book with chapter navigation. A book can also be printed as a PDF file with a cover sheet.

Characteristics of books

Books have the following characteristics:

• On book pages, the book navigation is displayed instead of the main navigation.
• A wiki page can be in multiple books.
• Books can be printed completely or partially as a PDF with a cover sheet.
• Books can be grouped into individual book shelves.

Creating a book

Books are created from the page Special:Books.

Click Create new book in the actions menu of the page tools.

To create a book:

1. Click the +-button.
2. Enter a Book title.
3. Select "General books" as type of the book.
   

   Create a book
4. Click Done. The book editor loads next.

Important!The book is only created in the wiki when at least one page has been saved in the book.

Adding pages

You are now in the book editing mode.

Book edit buttons

1. Click the Plus button (1). A dialog window opens.
2. Search for a page in the wiki and select it. If a different name is to be displayed in the book navigation, you can enter a display title (optional).
3. Click Done.
4. Add additional pages.

1. Click the arrow of the Save button and select Save and add chapter navigation. This process inserts the <bookshelf /> tag into the source code of all wiki pages in the book. This causes a revision of the pages.
   

   Add chapter navigation

Tip:You can click a page title of a book page before adding a new book page. This is then inserted as a sub-chapter. You can move pages to the desired position later using drag & drop with the mouse.

The book is now displayed on the wiki bookshelf. The bookshelf can be reached via the entry links in the main navigation.

Note:There is no option to go directly from the bookshelf to the book manager.

Mass-adding of pages

After clicking "Mass add", a dialog is opened. It contains different criteria for page selection:

• All pages of a category
• All subpages of a certain page
• From a page collection - page collections are lists of pages located in the MediaWiki namespace. They are usually created from a Word import or from search results.

After adding your book pages click Save at the bottom of the page. Now you have created a page in the namespace Book. It simply contains the list of pages that have been added to the book.

Adding metadata

While editing a book (adding or removing pages), metadata for the book can be added. References to these metadata can be included in the PDF template. To edit metadata, select the top-most node of the book (first page) and click the wrench icon. A dialog with a drop-down selection of the following options is available:

• Title
• Subtitle
• Author 1
• Author 2
• Document-ID
• Document type
• Department
• Version
• Bookshelf image
• Template (PDF): If you maintain multiple PDF templates for books, you can select one of them here.
• Table of Contents (Only article titles, or Embed article TOCs)

It is also possible to add your own met data for use in the <booklist>-tag, for example.

Add graphic for gallery view

Add the Bookshelf image metadata element to add a cover photo for a book in the bookshelf gallery view. Select this option from the drop-down list and click Add. Then enter the name of the image (without the “File:” prefix) in the value field. Any image currently uploaded to the wiki can be used. The image will then be displayed in the book gallery. However, the image is not used as a cover image for the PDF export (exception: BlueSpice cloud).

Types of books

Type	Description	Chapter navigation
General books	Visible to all users. Only general books can have a chapter navigation. In almost all cases a book is set up as a "general book".	Yes
Own books	An own book is only visible in the bookshelf to the user who created the book. Such a book does not have a chapter navigation. Own books are usually created to export wiki pages as a PDF with a cover sheet.	No
Temporary books	This selection is also available to wiki users who are not logged into the wiki and is therefore mainly useful for public wikis. These books are only temporarily stored in the user's browser and not in the wiki itself. If the browser cache is deleted or the user switches to another browser, the book is no longer available. The main aim of temporary books is so that users can collectively print out wiki pages as PDFs.	No

Exporting a book

Books, individual chapters or even individual book pages can be exported as PDF files:

1. Open the book in the book manager.
2. Select each of the pages or chapters to export by clicking the appropriate check boxes. Sub-chapters are selected automatically.
3. Click the Export Selections drop-down menu to open a list of the available formats.
   

Actions in the book manager

The link Administration > Books in the menu Global Actions loads the page Special:Book Administration. Here you can edit your books.

Book manager actions

• Edit (1): Links to the Book editor where you can edit the book contents and metadata.
• Delete (2): Deletes the book page in the namespace Book without deleting the wiki pages.
• Duplicate (3): Duplicates this book, including all the pages of the book to a different namespace.
• Export (4): Exports all wiki pages in this book to PDF.
• Assign (5): Assigns the book to designated users. These users are the responsible editors of the book.

Configuration

Display options

Book

• Show book chapter pager after content: Displays previous/next book page navigation at the end of each book page. (1)
• Show book chapter pager before content: Displays previous/next book page navigation at the beginning of each book page. (2)
  
  

  Book navigation
  
  
• Use display title from book source on article: Shows the title from the book navigation as page title instead of the page name.
  

book display title

Note:If the page additionally contains a {{DISPLAYTITLE}} tag, the display title of the page is shown on the page and in the book navigation instead of the page label provided in the book page.

Content structuring

Prepend article table of contents and headlines with book numberation: The page TOC does not start with the main heading 1, but with the actual number from the book chapter (see screenshot). If users have activated in their user preferences to "auto-number headings", the numbering system is matched accordingly.

Prepended chapter numbers

Export

• Supress namespace prefix of book articles in output: The namespace prefix of an article is not shown in PDFs.

Skinning

• Show entrypoint "Books": Adds a link to the page Special:Books to the main navigation entrypoints.

Export

Wiki administrators can make the following adjustments for the book export:

• Show stabilization information in PDF export:
  Prints the timestamp for the last approved version below the page headings in the PDF (date of approval and date of last edit before approval).
  

• Supress namespace prefix of book articles in output: The namespace prefix of an article is not shown in PDFs.

• Show watermark for expired pages in PDF: Shows the watermark for expired pages in PDFs.
• Show watermark for expired pages in print version: Shows the watermark for expired pages when a page is printed.

Configuring the file size limits (server)

By default, the book export is limited to 50MB in file size. To adjust this value, complete the following steps:

1. In Apache Tomcat, open the file web.xml:

   sudo -s
   nano /opt/tomcat/webapps/manager/WEB-INF/web.xml
   

2. Look for the following lines and adjust the value (e.g. for 250MB=26214400)

   <max-file-size>262144000</max-file-size>
   <max-request-size>262144000</max-request-size>
   

3. The web app BShtml2PDF also has a setting that needs to be adjusted:

   nano /opt/tomcat/webapps/BShtml2PDF/WEB-INF
   

4. Enter your values in the following lines:

   <param-name>maxMemSize</param-name> <param-value>26214400</param-value>
   <param-name>maxFileize</param-name> <param-value>26214400</param-value>
   

5. Restart Apache Tomcat

   service tomcat restart
   

Deleting a book

When you delete a book, you only remove the book page of the book (that is, the table of contents) in the "Book" namespace. However, the wiki pages in the book are not deleted. Before deleting the book, a pop-up menu informs you that the bookshelf-tag will not be automatically removed from the pages.

The bookshelf tags have no effect on the wiki pages after deleting the book page. If you want to remove them manually, you can go to the page Special:ReplaceText and do a "find and replace".

Duplicating a book

You can create an entire copy of the book by duplicating it:

To duplicate a book:

1. Enter a target name: The default value is the book name with the suffix (copy). Change this to create a different book title.
2. Select a namespace: Choose a namespace that is different from the original namespace.

If you are not careful, you might experience some unintended consequences. By creating a new book, you also create copies of all the wiki pages in the original book. Since a namespace cannot contain the same page twice, you have to copy the files to a different namespace.

About the duplicated files:

• Book page: A new page in the namespace book. If you don't enter a new title, the book will be created with the same title and the suffix (Copy). E.g. Employee Manual (Copy). This file includes a copy of the structure of your original book with the corresponding links to the duplicated pages in the new copy.
• Wiki pages: All pages contained in the original book are duplicated. The following scenarios are possible:
  • Same namespace: If you duplicate a book in the same namespace, no actual duplicates of the actual wiki are created. Instead, the bookshelf tag is updated to point to the copy of the book. For example, if your original book contains the page HR:Quality assurance (the book is in the namespace HR), the Quality assurance page now contains the bookshelf tag .
  • Different namespace: If you create the book copy in a different namespace, the bookshelf tag in the original files remains unchanged. The new pages in the different namespace are created with a bookshelf tag for the new book copy. This is most likely the scenario you want.

Including a book table of contents on a page   v4.4+

The Content droplet “Book table of contents” can be used to insert the an entire book TOC or an individual chapter navigation of a book on any wiki page.

Content droplet "Book table of contents"

Adding a PDF-download link to a page

The Content droplet “Book PDF link” can be used to insert a link on a page that will download a book directly as a PDF.

Permissions

To create and edit books, users need edit rights in Book namespace. Additionally, a user can only add pages to the book that that user can read. If a user tries to export a book to PDF that contains pages for which the user does not have permissions, the user will get an error message.

Technical Reference: BlueSpiceBookshelf

---

To submit feedback about this documentation, visit our community forum.