Last edited 9 months ago
by Margit Link-Rodrigue

Template:BSExtensionInfobox and Reference:BlueSpiceBookshelf: Difference between pages

(Difference between pages)
VisualWikitext
No edit summary
Tag: 2017 source edit
 
No edit summary
Tag: 2017 source edit
 
Line 1: Line 1:
<noinclude>This is the "BSExtensionInfobox" template. Used mainly for MediaWiki extensions, but also for BlueSpice extensions that don't have a page in the AutoDoc namespace. For AutoDoc extensions, use the template BSExtensionInfo.
{{BSExtensionInfo
It should be called in the following format:
|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.
 
*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 <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.


<pre>{{BSExtensionInfobox
|desc=
|status=
|developer=
|type=
|compatible=
|edition=
|category=
|active=
|license=
|docu=
}}
}}
</pre>
Edit the page to see the template text.
</noinclude><includeonly>{{#default_form:BSExtensionInfoboxForm}}
<h1>{{#switch: {{PAGENAME}}|BlueSpiceDiscovery|BlueSpiceCalumma|Chameleon=Skin:{{PAGENAME}}|Extension: {{PAGENAME}} }}</h1>
<br />
<i class="bi bi-arrow-right-circle"></i> [[:Category:Extension|all extensions]]
{| class="extension-infobox  fullwidth"
|-
!class="extension-infobox-header" colspan="4"|Overview
|-
! Description:
|colspan="3" | [[BSExtensionInfoDescription::{{{desc|}}}]]
|-
! State:
| [[BSExtensionInfoStatus::{{{status|}}}]]
! Dependency:
| {{#arraymap:{{{compatible|}}}|,|y|[[BSExtensionInfoCompatible::y]]}}
|-
! Developer:
| {{#arraymap:{{{developer|}}}|,|y|[[BSExtensionInfoDeveloper::y]]}}
! License:
| [[BSExtensionInfoLicense::{{{license|-}}}]]
|-
! Type:
| {{#if:{{{docu|}}}|[{{{docu|}}} {{{type|}}}]|{{{type|}}}}} {{#set:BSExtensionInfoType={{{type|}}}}}
! Category:
| {{#arraymap:{{{category|-}}}|,|z|[[BSExtensionInfoCategory::z]]}}
|-
! Edition:
| colspan="3"|{{#arraymap:{{{edition|}}}|,|@@|[[BSExtensionInfoEdition::@@]]}}
|-
!class="extension-infobox-helppage" colspan="4"|{{#ifexist: Manual:Extension/{{PAGENAME}} | <div class="questionmark-icon"> '''[[Manual:Extension/{{PAGENAME}}|View help page]]'''</div>|{{#if: {{{docu|}}}|For more info, visit '''[{{{docu|}}} Mediawiki].'''|}} }}
|}
<div id="importdata">
{{#if: {{{features|}}}|==Features==
{{{features}}}|}}
</div>
__NOTOC__
__HIDETITLE__
[[Category:Extension]]{{Translation}}</includeonly>

Latest revision as of 16:00, 10 August 2022

Extension: BlueSpiceBookshelf

all extensions

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: 4.1+
View user help page

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.

Technical Information

This information applies to BlueSpice 4. Technical details for BlueSpice Cloud can differ in some cases.

Requirements

  • MediaWiki: 1.38.0
  • BlueSpiceFoundation: 4.1

Integrates into

  • BlueSpiceBookshelf
  • BlueSpiceVisualEditorConnector
  • ContentDroplets
  • MWStakeContentProvisioner

Special pages

  • Bookshelf
  • BookshelfBookEditor
  • BookshelfBookManager

Permissions

Name Description Role
bookshelf-viewspecialpage Access the special page Special:Bookshelf reader
bookshelfbookmanager-viewspecialpage Access the special page Special:BookshelfBookManager reader

Configuration

Name Value
BookShelfDefaultCoverImage 'resources/images/assets/coverimage/dummy.png'
BookShelfShowChapterNavigationPagerAfterContent false
BookShelfShowChapterNavigationPagerBeforeContent false
BookshelfMainLinksBookshelf true
BookshelfPrependPageTOCNumbers true
BookshelfSupressBookNS true
BookshelfTitleDisplayText true

User options

Name Value
bs-bookshelf-defaultview 'gridviewpanel'

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

Hooks

Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=Template:BSExtensionInfobox&oldid=4645"

Discussions