Difference between revisions of "Reference:BlueSpiceBookshelf"
(Tag: 2017 source edit) |
(Tag: 2017 source edit) |
Extension: BlueSpiceBookshelf
| Overview | |||
|---|---|---|---|
| Description: | Enables BlueSpice to manage and export hierarchical collections of articles. | ||
| State: | stable | Dependency: | BlueSpice |
| Developer: | HalloWelt | License: |
GPL-3.0-onlyProperty "BSExtensionInfoLicense" (as page type) with input value "</br>GPL-3.0-only" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process. |
| Type: | BlueSpice | Category: | Book |
| Edition: | BlueSpice pro, BlueSpice Farm, BlueSpice Cloud | ||
Features
Bookshelf combines wiki pages to create books and also to export those pages as a PDF document.
Usage/ Features- 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.
Technical information
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[edit source]
This information applies to BlueSpice 3 . Technical details for BlueSpice cloud can differ in some cases.
Requirements[edit source]
- MediaWiki: 1.31
- BlueSpiceFoundation: 3.1
Integrates into[edit source]
- BlueSpiceBookshelf
Special pages[edit source]
- Bookshelf
- BookshelfBookEditor
- BookshelfBookManager
Permissions[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 source]
| Name | Value |
|---|---|
| BookShelfDefaultCoverImage | 'resources/images/assets/coverimage/dummy.png' |
| BookShelfShowChapterNavigationPagerAfterContent | false |
| BookShelfShowChapterNavigationPagerBeforeContent | false |
| BookshelfPrependPageTOCNumbers | true |
| BookshelfSupressBookNS | true |
| BookshelfTitleDisplayText | true |
User options[edit source]
| Name | Value |
|---|---|
| bs-bookshelf-defaultview | 'gridviewpanel' |
API Modules[edit source]
- bs-bookshelf-bookstore
- bs-bookshelf-manage
- bs-bookshelf-mass-add-page-store
- bs-bookshelf-page-collection-store
- bs-bookshelf-store
Hooks[edit source]
{{BSExtensionInfo
|desc=Combines wiki pages to create books and also to export those pages as a PDF document.
|status=stable
|developer=HalloWelt
|type=BlueSpice
|edition=BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
|compatible=BlueSpice
|category=Book
|license=GPL v3 only
|features=
'''Bookshelf''' combines wiki pages to create books and also to export those pages as a PDF document.
==Usage/ Features==
*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.
==Technical information==
===Configuration====Configuration manager===
Some aspects of this extension can be configured on <code>Special:BlueSpiceConfigManager</code>. 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.
}}| Line 10: | Line 10: | ||
|features= | |features= | ||
'''Bookshelf''' combines wiki pages to create books and also to export those pages as a PDF document. | '''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. | *Sets of different pages (chapters) can be put together individually to a book. | ||
| Line 18: | Line 16: | ||
*The book or parts of the book can be exported to PDF. | *The book or parts of the book can be exported to PDF. | ||
| − | + | ===Configuration manager=== | |
| − | |||
| − | ===Configuration=== | ||
Some aspects of this extension can be configured on <code>Special:BlueSpiceConfigManager</code>. Here, wiki administrators can: | Some aspects of this extension can be configured on <code>Special:BlueSpiceConfigManager</code>. Here, wiki administrators can: | ||