Reference:BlueSpiceBookshelf

all extensions

Overview
Description:	Enables BlueSpice to manage and export hierarchical collections of articles.
State:	stable	Dependency:	BlueSpice
Developer:	HalloWelt	License:	GPL-3.0-only
Type:	BlueSpice	Category:	Book
Edition:	BlueSpice pro, BlueSpice Farm"BlueSpice Farm" is not in the list (BlueSpice free, BlueSpice free (deactivated), BlueSpice pro, BlueSpice pro (deactivated), BlueSpice farm, BlueSpice farm (deactivated), BlueSpice cloud, BlueSpice cloud (deactivated)) of allowed values for the "BSExtensionInfoEdition" property., BlueSpice Cloud"BlueSpice Cloud" is not in the list (BlueSpice free, BlueSpice free (deactivated), BlueSpice pro, BlueSpice pro (deactivated), BlueSpice farm, BlueSpice farm (deactivated), BlueSpice cloud, BlueSpice cloud (deactivated)) of allowed values for the "BSExtensionInfoEdition" property.	Version:
View user help page

Features

Bookshelf combines wiki pages to create books and also to export those pages as a PDF document.

• Sets of different pages (chapters) can be put together individually to a book.
• The table of contents of the book is displayed in the left navigation bar.
• The chapters are displayed in a collapsible tree structure.
• The book or parts of the book can be exported to PDF.

Configuration manager

Some aspects of this extension can be configured on Special:BlueSpiceConfigManager. Here, wiki administrators can:

• prepend the article table of contents and headlines of a page with book numeration.
• supress the namespace prefix of book articles in the PDF output.
• apply the display title from the book source to a wiki page.

This is a big edit.

Technical Information

Technical details for BlueSpice cloud can differ in some cases.

Requirements

• MediaWiki: 1.43.0

• BlueSpiceFoundation: 5.0.0
• MenuEditor: 3.0.0
• VueJsPlus: 1.0.0

Integrates into

• BlueSpiceBookshelf

• BlueSpiceExtendedSearch

• BlueSpiceVisualEditorConnector

• ContentDroplets

• MWStakeContentProvisioner

• MenuEditor

• NotifyMe

• PDFCreator

Special pages

• Books

Permissions

Name	Description	Role
bookshelf-viewspecialpage	Access the special page Special:Bookshelf	reader
bookshelfbookmanager-viewspecialpage	Access the special page Special:BookshelfBookManager	reader

Configuration

Name	Value
BookShelfDefaultCoverImage	'resources/images/assets/coverimage/dummy.png'
BookShelfShowChapterNavigationPagerAfterContent	false
BookShelfShowChapterNavigationPagerBeforeContent	false
BookshelfDefaultBookTemplate	'StandardBookPDF'
BookshelfMainLinksBookshelf	true
BookshelfPrependPageTOCNumbers	true
BookshelfTitleDisplayText	true
BookshelfToolbarOffset	153

User options

Name	Value
bs-bookshelf-defaultview	'gridviewpanel'

API Modules

• bs-book-chapters-store
• bs-books-overview-store
• bs-bookshelf-bookstore
• bs-bookshelf-manage
• bs-bookshelf-mass-add-page-store
• bs-bookshelf-page-collection-store
• bs-bookshelf-store

Hooks

• BSBookshelfBooksOverviewBeforeSetBookActions
• BSBookshelfPageAddedToBook
• BSBookshelfPageRemovedFromBook
• BSUEModulePDFAfterFindFiles
• BSUEModulePDFcollectMetaData
• BSUEModulePDFgetPage
• BeforePageDisplay
• BlueSpiceDiscoveryTemplateDataProviderAfterInit
• ContentHandlerDefaultModelFor
• LoadExtensionSchemaUpdates
• MWStakeCommonUIRegisterSkinSlotComponents
• MediaWikiServices
• MultiContentSave
• NumberHeadingsBeforeApply
• OutputPageBeforeHTML
• PageDeleteComplete
• PageMoveComplete
• SkinTemplateNavigation::Universal

PDF exclude - start

---

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

PDF exclude - end

The display title sets a page title that is different from the page name.

It becomes the preferred page label used in many automatically generated page lists. It can be changed with the visual editor (Options > Advanced settings). The source of the wiki page shows the magic word {{DISPLAYTITLE:My display title}}.