Difference between revisions of "AutoDoc:BlueSpiceBookshelf"
hw>Unknown user |
m (1 revision imported) |
Contents
DescriptionMsg[edit source]
Enables BlueSpice to manage and export hierarchical collections of articles.
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: 1.31
- BlueSpiceFoundation: 3.1
IntegratesInto[edit source]
- BlueSpiceBookshelf
SpecialPages[edit source]
- Bookshelf
- BookshelfBookEditor
- BookshelfBookManager
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| bookshelf-viewspecialpage | Access the special page Special:Bookshelf | reader |
| bookshelfbookmanager-viewspecialpage | Access the special page Special:BookshelfBookManager | reader |
DefaultUserOptions[edit source]
User options[edit source]
| Name | Value |
|---|---|
| bs-bookshelf-defaultview | 'gridviewpanel' |
Config[edit source]
Configuration[edit source]
| Name | Value |
|---|---|
| BookShelfDefaultCoverImage | 'resources/images/assets/coverimage/dummy.png' |
| BookShelfShowChapterNavigationPagerAfterContent | false |
| BookShelfShowChapterNavigationPagerBeforeContent | false |
| BookshelfPrependPageTOCNumbers | true |
| BookshelfSupressBookNS | true |
| BookshelfTitleDisplayText | true |
ApiModules[edit source]
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]
Hooks[edit source]
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpiceBookshelf
|desc = {{int:bs-bookshelf-extension-description
}}
}}
==License==
{{AutoDocLicense
|name = GPL-3.0-only
}}
==Requirements==
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = 1.31
}}
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundation
|version = 3.1
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceBookshelf
}}
}}
==SpecialPages==
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|name = Bookshelf
|callback = \BlueSpice\Bookshelf\Special\Bookshelf
}}
{{AutoDocCallback
|name = BookshelfBookEditor
|callback = \BlueSpice\Bookshelf\Special\BookshelfBookEditor
}}
{{AutoDocCallback
|name = BookshelfBookManager
|callback = \BlueSpice\Bookshelf\Special\BookshelfBookManager
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = bookshelf-viewspecialpage
|type = global
|roles = reader
|desc = {{int:right-bookshelf-viewspecialpage
}}
}}
{{AutoDocPermission
|name = bookshelfbookmanager-viewspecialpage
|type = global
|roles = reader
|desc = {{int:right-bookshelfbookmanager-viewspecialpage
}}
}}
}}
==DefaultUserOptions==
{{AutoDocDefaultUserOptions
|options = {{AutoDocOption
|name = bs-bookshelf-defaultview
|value = <nowiki>'gridviewpanel'</nowiki>
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = BookShelfDefaultCoverImage
|value = <nowiki>'resources/images/assets/coverimage/dummy.png'</nowiki>
}}
{{AutoDocOption
|name = BookShelfShowChapterNavigationPagerAfterContent
|value = <nowiki>false</nowiki>
}}
{{AutoDocOption
|name = BookShelfShowChapterNavigationPagerBeforeContent
|value = <nowiki>false</nowiki>
}}
{{AutoDocOption
|name = BookshelfPrependPageTOCNumbers
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = BookshelfSupressBookNS
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = BookshelfTitleDisplayText
|value = <nowiki>true</nowiki>
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-bookshelf-bookstore
|callback = ApiBookshelfBookStore
}}
{{AutoDocCallback
|name = bs-bookshelf-manage
|callback = ApiBookshelfManage
}}
{{AutoDocCallback
|name = bs-bookshelf-mass-add-page-store
|callback = ApiBookshelfMassAddPageStore
}}
{{AutoDocCallback
|name = bs-bookshelf-page-collection-store
|callback = ApiBookshelfPageCollectionStore
}}
{{AutoDocCallback
|name = bs-bookshelf-store
|callback = ApiBookshelfStore
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfGetBookData BSBookshelfGetBookData]
|callback = \BlueSpice\Bookshelf\Hook\BSBookshelfGetBookData\RunLegacyHook::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSInsertMagicAjaxGetData BSInsertMagicAjaxGetData]
|callback = \BlueSpice\Bookshelf\Hook\BSInsertMagicAjaxGetData\AddBookshelfTag::callback, \BlueSpice\Bookshelf\Hook\BSInsertMagicAjaxGetData\AddBookmetaTag::callback, \BlueSpice\Bookshelf\Hook\BSInsertMagicAjaxGetData\AddBooklistTag::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFAfterFindFiles BSUEModulePDFAfterFindFiles]
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFAfterFindFiles\AddAttachments::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFbeforeGetPage BSUEModulePDFbeforeGetPage]
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFbeforeGetPage\AdaptPageTitle::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFcollectMetaData BSUEModulePDFcollectMetaData]
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFcollectMetaData\SupressBookNS::callback, \BlueSpice\Bookshelf\Hook\BSUEModulePDFcollectMetaData\AddBookMeta::callback
}}
{{AutoDocCallback
|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/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\Bookshelf\Hook\BeforePageDisplay\AddResources::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ContentHandlerDefaultModelFor ContentHandlerDefaultModelFor]
|callback = BlueSpice\Bookshelf\Hook\ContentHandlerDefaultModelFor\GetBookContentHandler::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|callback = \BlueSpice\Bookshelf\Hook\GetPreferences\BookshelfDefaultView::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = BlueSpice\Bookshelf\Hook\LoadExtensionSchemaUpdates\AddConvertContentModel::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ParserFirstCallInit ParserFirstCallInit]
|callback = BlueSpice\Bookshelf\Hook\ParserFirstCallInit\SetParserHooks::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
|callback = BlueSpice\Bookshelf\Hook\SkinTemplateOutputPageBeforeExec\SetBookContentModelActions::callback, BlueSpice\Bookshelf\Hook\SkinTemplateOutputPageBeforeExec\AddChapterPager::callback, BlueSpice\Bookshelf\Hook\SkinTemplateOutputPageBeforeExec\AddBookshelfUI::callback, BlueSpice\Bookshelf\Hook\SkinTemplateOutputPageBeforeExec\AddToBookTool::callback
}}
}}(No difference)
|