VOOZH about

URL: https://www.mediawiki.org/wiki/Extension:Bookshelf

⇱ Extension:Bookshelf - MediaWiki


Jump to content
From mediawiki.org
👁 Image
This extension is mainly supported in an external venue: BlueSpice Community Forum.
If you need help, you should post there, and not on the talk page.
MediaWiki extensions manual
👁 Image
Bookshelf
Release status: stable
👁 Image
Description Combines wiki pages to create books and also to export them as PDF.
Author(s) Hallo Welt! GmbH
Maintainer(s) Hallo Welt! GmbH
Latest version 4.5
Compatibility policy For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension.
MediaWiki 1.43 (LTS)
Database changes Yes
  • $wgBookShelfDefaultCoverImage
  • $wgBookshelfToolbarOffset
  • $wgBookshelfMainLinksBookshelf
  • $wgBookshelfDefaultBookTemplate
  • $wgBookShelfShowChapterNavigationPagerAfterContent
  • $wgBookshelfTitleDisplayText
  • $wgBookShelfShowChapterNavigationPagerBeforeContent
  • $wgBookshelfSupressBookNS
  • $wgBookshelfPrependPageTOCNumbers
  • bookshelfbookmanager-viewspecialpage
  • bookshelf-viewspecialpage
Licence GNU General Public License 3.0 only
Download
Translate the Bookshelf extension if it is available at translatewiki.net
👁 Image
 Community Forum

Bookshelf combines wiki pages to create books with a chapter navigation. The book or book chapters can then be exported (for example with Extension:PDFCreator).

Usage / features

[edit]
  • Sets of different pages (chapters) can be put together individually to create 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.
  • Some aspects of this extension can be customized in the configuration management.

Characteristics of books

[edit]

Books have the following characteristics:

  • On book pages, the book navigation is displayed instead of the standard navigation.
  • The book chapter levels can be created with a visual drag-and-drop interface.
  • A wiki page can be in multiple books. If a page is in multiple books, the book navigation shows a dropdown menu that allows to switch between these books.
  • Books can be printed completely or partially as a PDF with a cover sheet.
  • Books can be grouped into individual bookshelves.

Administration

[edit]

Wiki administrators can configure the following settings:

  • Show a chapter pager before or after the page content.
  • Show book chapter numbers in table of contents and headlines.
  • Use display title from book source on article.
  • Set the default export template for books.


Installation

[edit]

.git) as a "vcs repository" and the package name (mediawiki/BlueSpiceBookshelf) and version to the require section of your composer.local.json. Example:

{
"repositories":[
{
"type":"vcs",
"url":"https://github.com/wikimedia/mediawiki-extensions-BlueSpiceBookshelf
.git"
}
],
"require":{
"mediawiki/BlueSpiceBookshelf":"BlueSpiceBookshelf"
}
}
  • Run the following command in your MediaWiki installation path
composer update --no-dev
wfLoadExtension( 'BlueSpiceBookshelf' );

External Links

[edit]

This extension was originally made for BlueSpice. BlueSpice is a MediaWiki distribution for enterprises and organizations. It enhances MediaWiki, in particular in the areas of quality management, process support, administration, editing and security. This extension is bundled with BlueSpice pro.

BlueSpice: