| 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: | |
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.
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:
- In Apache Tomcat, open the file web.xml:
sudo -s nano /opt/tomcat/webapps/manager/WEB-INF/web.xml
- 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>
- The web app BShtml2PDF also has a setting that needs to be adjusted:
nano /opt/tomcat/webapps/BShtml2PDF/WEB-INF
- 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>
- Restart Apache Tomcat
service tomcat restart
Technical Information[edit | edit source]
Technical details for BlueSpice cloud can differ in some cases.
Requirements[edit | edit source]
- MediaWiki: 1.43.0
- BlueSpiceFoundation: 5.0.0
- MenuEditor: 3.0.0
- VueJsPlus: 1.0.0
Integrates into[edit | edit source]
- BlueSpiceBookshelf
- BlueSpiceExtendedSearch
- BlueSpiceVisualEditorConnector
- ContentDroplets
- MWStakeContentProvisioner
- MenuEditor
- NotifyMe
- PDFCreator
Special pages[edit | edit source]
- Books
Permissions[edit | edit source]
| Name | Description | Role |
|---|---|---|
| bookshelf-viewspecialpage | Access the special page Special:Bookshelf | reader |
| bookshelfbookmanager-viewspecialpage | Access the special page Special:BookshelfBookManager | reader |
Configuration[edit | edit source]
| 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[edit | edit source]
| Name | Value |
|---|---|
| bs-bookshelf-defaultview | 'gridviewpanel' |
API Modules[edit | edit source]
- 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[edit | edit source]
- BSBookshelfBooksOverviewBeforeSetBookActions
- BSBookshelfPageAddedToBook
- BSBookshelfPageRemovedFromBook
- BSUEModulePDFAfterFindFiles
- BSUEModulePDFcollectMetaData
- BSUEModulePDFgetPage
- BeforePageDisplay
- BlueSpiceDiscoveryTemplateDataProviderAfterInit
- ContentHandlerDefaultModelFor
- LoadExtensionSchemaUpdates
- MWStakeCommonUIRegisterSkinSlotComponents
- MediaWikiServices
- MultiContentSave
- NumberHeadingsBeforeApply
- OutputPageBeforeHTML
- PageDeleteComplete
- PageMoveComplete
- SkinTemplateNavigation::Universal
