AutoDoc:BlueSpiceBookshelf

==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.43.0

}}

|extensions = {{AutoDocVersion

|name = BlueSpiceFoundation

|version = 5.0.0

}}

{{AutoDocVersion

|name = MenuEditor

|version = 3.0.0

}}

{{AutoDocVersion

|name = VueJsPlus

|version = 1.0.0

}}

}}

==IntegratesInto==

{{AutoDocIntegratesInto

|into = {{AutoDocListItem

|item = BlueSpiceBookshelf

}}

{{AutoDocListItem

|item = BlueSpiceExtendedSearch

}}

{{AutoDocListItem

|item = BlueSpiceVisualEditorConnector

}}

{{AutoDocListItem

|item = ContentDroplets

}}

{{AutoDocListItem

|item = MWStakeContentProvisioner

}}

{{AutoDocListItem

|item = MenuEditor

}}

{{AutoDocListItem

|item = NotifyMe

}}

{{AutoDocListItem

|item = PDFCreator

}}

}}

==SpecialPages==

{{AutoDocSpecialPages

|SpecialPages = {{AutoDocCallback

|name = Books

|callback = \BlueSpice\Bookshelf\Special\Books

}}

}}

==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 = BookshelfDefaultBookTemplate

|value = <nowiki>'StandardBookPDF'</nowiki>

}}

{{AutoDocOption

|name = BookshelfMainLinksBookshelf

|value = <nowiki>true</nowiki>

}}

{{AutoDocOption

|name = BookshelfPrependPageTOCNumbers

|value = <nowiki>true</nowiki>

}}

{{AutoDocOption

|name = BookshelfTitleDisplayText

|value = <nowiki>true</nowiki>

}}

{{AutoDocOption

|name = BookshelfToolbarOffset

|value = <nowiki>153</nowiki>

}}

}}

==ApiModules==

{{AutoDocApiModules

|APIModules = {{AutoDocCallback

|name = bs-book-chapters-store

|callback = BlueSpice\Bookshelf\Api\Store\ApiBookChaptersStore

}}

{{AutoDocCallback

|name = bs-books-overview-store

|callback = BlueSpice\Bookshelf\Api\Store\ApiBooksOverviewStore

}}

{{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/BSBookshelfBooksOverviewBeforeSetBookActions BSBookshelfBooksOverviewBeforeSetBookActions]

|callback = addExportAction

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfPageAddedToBook BSBookshelfPageAddedToBook]

|callback = updateSearchIndex

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfPageRemovedFromBook BSBookshelfPageRemovedFromBook]

|callback = updateSearchIndex

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFAfterFindFiles BSUEModulePDFAfterFindFiles]

|callback = ue-module-pdf

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFcollectMetaData BSUEModulePDFcollectMetaData]

|callback = ue-module-pdf

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFgetPage BSUEModulePDFgetPage]

|callback = ue-module-pdf

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]

|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/ContentHandlerDefaultModelFor ContentHandlerDefaultModelFor]

|callback = book-content-default-mode

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]

|callback = BlueSpice\Bookshelf\Hook\LoadExtensionSchemaUpdates\AddConvertContentModel::callback, BlueSpice\Bookshelf\Hook\LoadExtensionSchemaUpdates\AddBooksTable::callback, BlueSpice\Bookshelf\Hook\LoadExtensionSchemaUpdates\AddBookChaptersTable::callback, BlueSpice\Bookshelf\Hook\LoadExtensionSchemaUpdates\AddBookMetaTable::callback, migrateBooks, addPDFTemplates

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MWStakeCommonUIRegisterSkinSlotComponents MWStakeCommonUIRegisterSkinSlotComponents]

|callback = common-user-interface

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MediaWikiServices MediaWikiServices]

|callback = book-content-default-mode

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MultiContentSave MultiContentSave]

|callback = book-source-actions

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/NumberHeadingsBeforeApply NumberHeadingsBeforeApply]

|callback = add-chapter-number-to-title-and-headings

}}

{{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/PageDeleteComplete PageDeleteComplete]

|callback = book-source-actions

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/PageMoveComplete PageMoveComplete]

|callback = book-source-actions, updateChapter

}}

{{AutoDocCallback

|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation::Universal SkinTemplateNavigation::Universal]

|callback = addAddToBookEntry, addEditBook, addNewBook

}}

}}

​

​