AutoDoc:BlueSpiceBookshelf: Difference between revisions

VisualWikitext

Revision as of 11:44, 22 June 2023

DescriptionMsg

Enables BlueSpice to manage and export hierarchical collections of articles.

License

GPL-3.0-only

Requirements

MediaWiki: 1.38.0

BlueSpiceFoundation: 4.1

IntegratesInto

BlueSpiceBookshelf
BlueSpiceVisualEditorConnector
ContentDroplets

SpecialPages

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

DefaultUserOptions

User options

Name	Value
bs-bookshelf-defaultview	'gridviewpanel'

Config

Configuration

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

ApiModules

API Modules

bs-bookshelf-bookstore
bs-bookshelf-manage
bs-bookshelf-mass-add-page-store
bs-bookshelf-page-collection-store
bs-bookshelf-store

@@ Line 13: / Line 13: @@
 |mediawiki = {{AutoDocVersion
 |name = MediaWiki
-|version = 1.35.0
+|version = 1.38.0
 }}
 |extensions = {{AutoDocVersion
 |name = BlueSpiceFoundation
-|version = 4.0
+|version = 4.1
 }}
 }}
@@ Line 24: / Line 24: @@
 |into = {{AutoDocListItem
 |item = BlueSpiceBookshelf
+}}
+{{AutoDocListItem
+|item = BlueSpiceVisualEditorConnector
+}}
+{{AutoDocListItem
+|item = ContentDroplets
 }}
 }}
@@ Line 78: / Line 84: @@
 |name = BookShelfShowChapterNavigationPagerBeforeContent
 |value = <nowiki>false</nowiki>
+}}
+{{AutoDocOption
+|name = BookshelfMainLinksBookshelf
+|value = <nowiki>true</nowiki>
 }}
 {{AutoDocOption
@@ Line 140: / Line 150: @@
 |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFgetPage BSUEModulePDFgetPage]
 |callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFgetPage\ModifyForExport::callback
+}}
+{{AutoDocCallback
+|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUsageTrackerRegisterCollectors BSUsageTrackerRegisterCollectors]
+|callback = \BlueSpice\Bookshelf\Hook\BSUsageTrackerRegisterCollectors\NoOfUserBooks::callback
 }}
 {{AutoDocCallback
 |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
-|callback = \BlueSpice\Bookshelf\Hook\BeforePageDisplay\AddResources::callback
+|callback = \BlueSpice\Bookshelf\Hook\BeforePageDisplay\AddResources::callback, add-chapter-number-to-title-and-headings
 }}
 {{AutoDocCallback
 |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BlueSpiceDiscoveryTemplateDataProviderAfterInit BlueSpiceDiscoveryTemplateDataProviderAfterInit]
 |callback = discovery-skin
-}}
-{{AutoDocCallback
-|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ChameleonSkinTemplateOutputPageBeforeExec ChameleonSkinTemplateOutputPageBeforeExec]
-|callback = BlueSpice\Bookshelf\Hook\ChameleonSkinTemplateOutputPageBeforeExec\SetBookContentModelActions::callback, BlueSpice\Bookshelf\Hook\ChameleonSkinTemplateOutputPageBeforeExec\AddChapterPager::callback, BlueSpice\Bookshelf\Hook\ChameleonSkinTemplateOutputPageBeforeExec\AddBookshelfUI::callback, BlueSpice\Bookshelf\Hook\ChameleonSkinTemplateOutputPageBeforeExec\AddToBookTool::callback
 }}
 {{AutoDocCallback
@@ Line 168: / Line 178: @@
 |name = [https://www.mediawiki.org/wiki/Manual:Hooks/MWStakeCommonUIRegisterSkinSlotComponents MWStakeCommonUIRegisterSkinSlotComponents]
 |callback = common-user-interface
+}}
+{{AutoDocCallback
+|name = [https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageBeforeHTML OutputPageBeforeHTML]
+|callback = add-chapter-number-to-title-and-headings
 }}
 {{AutoDocCallback
 |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation::Universal SkinTemplateNavigation::Universal]
-|callback = BlueSpice\Bookshelf\Hook\SkinTemplateNavigationUniversal\AddAddToBookEntry::callback, BlueSpice\Bookshelf\Hook\SkinTemplateNavigationUniversal\AddEditBook::callback
+|callback = addAddToBookEntry, addEditBook
 }}
 }}