Revision as of 15:16, 10 August 2022 by Margit Link-Rodrigue (talk | contribs)
1. 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 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: | 4.1+ |
1.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.
1.1.1. 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.
1.2. Technical Information
This information applies to BlueSpice 4. Technical details for BlueSpice cloud can differ in some cases.
1.2.1. Requirements
- MediaWiki: 1.38.0
- BlueSpiceFoundation: 4.1
1.2.2. Integrates into
- BlueSpiceBookshelf
- BlueSpiceVisualEditorConnector
- ContentDroplets
- MWStakeContentProvisioner
1.2.3. Special pages
- Bookshelf
- BookshelfBookEditor
- BookshelfBookManager
1.2.4. Permissions
| Name | Description | Role |
|---|---|---|
| bookshelf-viewspecialpage | Access the special page Special:Bookshelf | reader |
| bookshelfbookmanager-viewspecialpage | Access the special page Special:BookshelfBookManager | reader |
1.2.5. Configuration
| Name | Value |
|---|---|
| BookShelfDefaultCoverImage | 'resources/images/assets/coverimage/dummy.png' |
| BookShelfShowChapterNavigationPagerAfterContent | false |
| BookShelfShowChapterNavigationPagerBeforeContent | false |
| BookshelfMainLinksBookshelf | true |
| BookshelfPrependPageTOCNumbers | true |
| BookshelfSupressBookNS | true |
| BookshelfTitleDisplayText | true |
1.2.6. User options
| Name | Value |
|---|---|
| bs-bookshelf-defaultview | 'gridviewpanel' |
1.2.7. API Modules
- bs-book-chapters-store
- bs-bookshelf-bookstore
- bs-bookshelf-manage
- bs-bookshelf-mass-add-page-store
- bs-bookshelf-page-collection-store
- bs-bookshelf-store
1.2.8. Hooks
- BSBookshelfGetBookData
- BSUEModulePDFAfterFindFiles
- BSUEModulePDFbeforeGetPage
- BSUEModulePDFcollectMetaData
- BSUEModulePDFgetPage
- BSUsageTrackerRegisterCollectors
- BeforePageDisplay
- BlueSpiceDiscoveryTemplateDataProviderAfterInit
- ContentHandlerDefaultModelFor
- GetPreferences
- LoadExtensionSchemaUpdates
- MWStakeCommonUIRegisterSkinSlotComponents
- OutputPageBeforeHTML
- SkinTemplateNavigation::Universal
Discussions