AutoDoc:BlueSpiceBookshelf: Difference between revisions

Back to version history
Browse history interactively
← Older edit
VisualWikitext
m 1 revision imported
m 1 revision imported
 
(4 intermediate revisions by 4 users not shown)
Line 13: Line 13:
|mediawiki = {{AutoDocVersion
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|name = MediaWiki
|version = 1.38.0
|version = 1.43.0
}}
}}
|extensions = {{AutoDocVersion
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundation
|name = BlueSpiceFoundation
|version = 4.1
|version = 5.0.0
}}
{{AutoDocVersion
|name = MenuEditor
|version = 3.0.0
}}
{{AutoDocVersion
|name = VueJsPlus
|version = 1.0.0
}}
}}
}}
}}
Line 24: Line 32:
|into = {{AutoDocListItem
|into = {{AutoDocListItem
|item = BlueSpiceBookshelf
|item = BlueSpiceBookshelf
}}
{{AutoDocListItem
|item = BlueSpiceExtendedSearch
}}
{{AutoDocListItem
|item = BlueSpiceSMWConnector
}}
}}
{{AutoDocListItem
{{AutoDocListItem
Line 33: Line 47:
{{AutoDocListItem
{{AutoDocListItem
|item = MWStakeContentProvisioner
|item = MWStakeContentProvisioner
}}
{{AutoDocListItem
|item = MenuEditor
}}
{{AutoDocListItem
|item = NotifyMe
}}
{{AutoDocListItem
|item = PDFCreator
}}
}}
}}
}}
Line 38: Line 61:
{{AutoDocSpecialPages
{{AutoDocSpecialPages
|SpecialPages = {{AutoDocCallback
|SpecialPages = {{AutoDocCallback
|name = Bookshelf
|name = Books
|callback = \BlueSpice\Bookshelf\Special\Bookshelf
|callback = \BlueSpice\Bookshelf\Special\Books
}}
{{AutoDocCallback
|name = BookshelfBookEditor
|callback = \BlueSpice\Bookshelf\Special\BookshelfBookEditor
}}
{{AutoDocCallback
|name = BookshelfBookManager
|callback = \BlueSpice\Bookshelf\Special\BookshelfBookManager
}}
}}
}}
}}
Line 87: Line 102:
|name = BookShelfShowChapterNavigationPagerBeforeContent
|name = BookShelfShowChapterNavigationPagerBeforeContent
|value = <nowiki>false</nowiki>
|value = <nowiki>false</nowiki>
}}
{{AutoDocOption
|name = BookshelfDefaultBookTemplate
|value = <nowiki>'StandardBookPDF'</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 98: Line 117:
{{AutoDocOption
{{AutoDocOption
|name = BookshelfSupressBookNS
|name = BookshelfSupressBookNS
|value = <nowiki>true</nowiki>
|value = <nowiki>false</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
|name = BookshelfTitleDisplayText
|name = BookshelfTitleDisplayText
|value = <nowiki>true</nowiki>
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = BookshelfToolbarOffset
|value = <nowiki>153</nowiki>
}}
}}
}}
}}
Line 110: Line 133:
|name = bs-book-chapters-store
|name = bs-book-chapters-store
|callback = BlueSpice\Bookshelf\Api\Store\ApiBookChaptersStore
|callback = BlueSpice\Bookshelf\Api\Store\ApiBookChaptersStore
}}
{{AutoDocCallback
|name = bs-books-overview-store
|callback = BlueSpice\Bookshelf\Api\Store\ApiBooksOverviewStore
}}
}}
{{AutoDocCallback
{{AutoDocCallback
Line 135: Line 162:
{{AutoDocHooks
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfGetBookData BSBookshelfGetBookData]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfBooksOverviewBeforeSetBookActions BSBookshelfBooksOverviewBeforeSetBookActions]
|callback = \BlueSpice\Bookshelf\Hook\BSBookshelfGetBookData\RunLegacyHook::callback
|callback = addExportAction
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfPageAddedToBook BSBookshelfPageAddedToBook]
|callback = queueJobs
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFAfterFindFiles BSUEModulePDFAfterFindFiles]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfPageRemovedFromBook BSBookshelfPageRemovedFromBook]
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFAfterFindFiles\AddAttachments::callback
|callback = queueJobs
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFbeforeGetPage BSUEModulePDFbeforeGetPage]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFAfterFindFiles BSUEModulePDFAfterFindFiles]
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFbeforeGetPage\AdaptPageTitle::callback
|callback = ue-module-pdf
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFcollectMetaData BSUEModulePDFcollectMetaData]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFcollectMetaData BSUEModulePDFcollectMetaData]
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFcollectMetaData\SupressBookNS::callback, \BlueSpice\Bookshelf\Hook\BSUEModulePDFcollectMetaData\AddBookMeta::callback
|callback = ue-module-pdf
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFgetPage BSUEModulePDFgetPage]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFgetPage BSUEModulePDFgetPage]
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFgetPage\ModifyForExport::callback
|callback = ue-module-pdf
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUsageTrackerRegisterCollectors BSUsageTrackerRegisterCollectors]
|callback = \BlueSpice\Bookshelf\Hook\BSUsageTrackerRegisterCollectors\NoOfUserBooks::callback
}}
}}
{{AutoDocCallback
{{AutoDocCallback
Line 168: Line 195:
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ContentHandlerDefaultModelFor ContentHandlerDefaultModelFor]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ContentHandlerDefaultModelFor ContentHandlerDefaultModelFor]
|callback = BlueSpice\Bookshelf\Hook\ContentHandlerDefaultModelFor\GetBookContentHandler::callback
|callback = book-content-default-mode
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
|callback = \BlueSpice\Bookshelf\Hook\GetPreferences\BookshelfDefaultView::callback
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
|callback = BlueSpice\Bookshelf\Hook\LoadExtensionSchemaUpdates\AddConvertContentModel::callback, BlueSpice\Bookshelf\Hook\LoadExtensionSchemaUpdates\AddBookChapterTable::callback
|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
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MWStakeCommonUIRegisterSkinSlotComponents MWStakeCommonUIRegisterSkinSlotComponents]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MWStakeCommonUIRegisterSkinSlotComponents MWStakeCommonUIRegisterSkinSlotComponents]
|callback = common-user-interface
|callback = common-user-interface
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MWStakeGenericTagHandlerInitTags MWStakeGenericTagHandlerInitTags]
|callback = registerTags
}}
{{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
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageBeforeHTML OutputPageBeforeHTML]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageBeforeHTML OutputPageBeforeHTML]
|callback = add-chapter-number-to-title-and-headings
|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
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation::Universal SkinTemplateNavigation::Universal]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation::Universal SkinTemplateNavigation::Universal]
|callback = addAddToBookEntry, addEditBook
|callback = addAddToBookEntry, addEditBook, addNewBook
}}
}}
}}
==Composer requirements==
{{AutoDocComposer requirements
|mwstake/mediawiki-component-wikitext = ~7
|all-packages = mwstake/mediawiki-component-wikitext
}}
}}


Latest revision as of 10:30, 21 November 2025

DescriptionMsg

Enables BlueSpice to manage and export hierarchical collections of articles.

License

GPL-3.0-only

Requirements

  • MediaWiki: 1.43.0
  • BlueSpiceFoundation: 5.0.0
  • MenuEditor: 3.0.0
  • VueJsPlus: 1.0.0

IntegratesInto

  • BlueSpiceBookshelf
  • BlueSpiceExtendedSearch
  • BlueSpiceSMWConnector
  • BlueSpiceVisualEditorConnector
  • ContentDroplets
  • MWStakeContentProvisioner
  • MenuEditor
  • NotifyMe
  • PDFCreator

SpecialPages

  • Books

Permissions

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
BookshelfDefaultBookTemplate 'StandardBookPDF'
BookshelfMainLinksBookshelf true
BookshelfPrependPageTOCNumbers true
BookshelfSupressBookNS false
BookshelfTitleDisplayText true
BookshelfToolbarOffset 153

ApiModules

API Modules

  • bs-book-chapters-store
  • bs-books-overview-store
  • bs-bookshelf-bookstore
  • bs-bookshelf-manage
  • bs-bookshelf-mass-add-page-store
  • bs-bookshelf-page-collection-store
  • bs-bookshelf-store

Hooks

Hooks

Composer requirements

all-packages mwstake/mediawiki-component-wikitext
Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=AutoDoc:BlueSpiceBookshelf&oldid=13354"