Difference between revisions of "Reference:BlueSpiceBookshelf"

(Configuration)
(Tag: 2017 source edit)
 

Extension: BlueSpiceBookshelf


Overview
Description: enables you to combine different wiki articles to create books and also to export those as a pdf documentEnables 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

[edit source]Bookshelf is an extension of the package BlueSpice Bookmaker. Bookshelf enables you to combine different wiki articles

Description[edit | edit source]

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

pdf

PDF document.

Usage/ Features[edit | edit source]

Technical information[edit | edit source]

Configuration[edit | edit source]
  • 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:

BlueSpicePreferences, under section "Bookshelf"

BlueSpiceConfigManager. Here, wiki administrators can

configure following

:

Prepend
  • prepend the article table of contents and headlines of a page with book
numberation
  • numeration.
Supress
  • supress the namespace prefix of book articles in the PDF output.
Use
  • apply the display title from the book source
on articleRights (permissions)[edit | edit
  • to a wiki page.

Technical Information[edit source]

The right to create a book depends on "edit" permission in the "Book" namespace

This information applies to BlueSpice 3 . Technical details for BlueSpice cloud can differ in some cases.

Requirements[edit

| edit User manual[edit |

This extension requires BlueSpiceFoundation.

  • MediaWiki: 1.31
  • BlueSpiceFoundation: 3.1

Integrates into[edit source]

  • BlueSpiceBookshelf

Special pages[edit source]

For detailed description and usage please visit our user manual.

Try free our BlueSpice[edit | edit source]

BlueSpice Demo.

  • 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]


Attachments

Discussions