For our customers with BlueSpice version 5: Please switch to the BlueSpice 5 helpdesk.
Extension: BlueSpiceBookshelf
| 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 cloud | Version: | 4.1+ |
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.
Technical Information
This information applies to BlueSpice 4. Technical details for BlueSpice cloud can differ in some cases.
Requirements
- MediaWiki: 1.39.0
- BlueSpiceFoundation: 4.3
MenuEditor: 2.0.0 VueJsPlus: 1.0.0
Integrates into
- BlueSpiceBookshelf
- BlueSpiceExtendedSearch
- BlueSpiceVisualEditorConnector
- ContentDroplets
- MWStakeContentProvisioner
- MenuEditor
- NotifyMe
Special pages
- Books
- BookshelfBookEditor
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 |
| BookshelfMainLinksBookshelf | true |
| BookshelfPrependPageTOCNumbers | true |
| BookshelfSupressBookNS | 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
- BSBookshelfGetBookData
- BSBookshelfPageAddedToBook
- BSBookshelfPageRemovedFromBook
- BSUEModulePDFAfterFindFiles
- BSUEModulePDFcollectMetaData
- BSUEModulePDFgetPage
- BeforePageDisplay
- BlueSpiceDiscoveryTemplateDataProviderAfterInit
- ContentHandlerDefaultModelFor
- GetPreferences
- LoadExtensionSchemaUpdates
- MWStakeCommonUIRegisterSkinSlotComponents
- MediaWikiServices
- MultiContentSave
- NumberHeadingsBeforeApply
- OutputPageBeforeHTML
- PageDeleteComplete
- PageMoveComplete
- SkinTemplateNavigation::Universal
