AutoDoc:BlueSpiceBookshelf: Difference between revisions

Back to version history
Browse history interactively
← Older edit
VisualWikitext
forge>Unknown user
No edit summary
m 1 revision imported
 
(3 intermediate revisions by 3 users not shown)
Line 13: Line 13:
|mediawiki = {{AutoDocVersion
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|name = MediaWiki
|version = 1.39.0
|version = 1.43.0
}}
}}
|extensions = {{AutoDocVersion
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundation
|name = BlueSpiceFoundation
|version = 4.3
|version = 5.0.0
}}
}}
{{AutoDocVersion
{{AutoDocVersion
|name = MenuEditor
|name = MenuEditor
|version = 2.0.0
|version = 3.0.0
}}
}}
{{AutoDocVersion
{{AutoDocVersion
Line 35: Line 35:
{{AutoDocListItem
{{AutoDocListItem
|item = BlueSpiceExtendedSearch
|item = BlueSpiceExtendedSearch
}}
{{AutoDocListItem
|item = BlueSpiceSMWConnector
}}
}}
{{AutoDocListItem
{{AutoDocListItem
Line 49: Line 52:
}}
}}
{{AutoDocListItem
{{AutoDocListItem
|item = Notifications
|item = NotifyMe
}}
{{AutoDocListItem
|item = PDFCreator
}}
}}
}}
}}
Line 57: Line 63:
|name = Books
|name = Books
|callback = \BlueSpice\Bookshelf\Special\Books
|callback = \BlueSpice\Bookshelf\Special\Books
}}
{{AutoDocCallback
|name = BookshelfBookEditor
|callback = \BlueSpice\Bookshelf\Special\BookshelfBookEditor
}}
}}
}}
}}
Line 100: Line 102:
|name = BookShelfShowChapterNavigationPagerBeforeContent
|name = BookShelfShowChapterNavigationPagerBeforeContent
|value = <nowiki>false</nowiki>
|value = <nowiki>false</nowiki>
}}
{{AutoDocOption
|name = BookshelfDefaultBookTemplate
|value = <nowiki>'StandardBookPDF'</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 111: Line 117:
{{AutoDocOption
{{AutoDocOption
|name = BookshelfSupressBookNS
|name = BookshelfSupressBookNS
|value = <nowiki>true</nowiki>
|value = <nowiki>false</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 156: 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
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfPageRemovedFromBook BSBookshelfPageRemovedFromBook]
|callback = queueJobs
}}
}}
{{AutoDocCallback
{{AutoDocCallback
Line 182: Line 196:
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ContentHandlerDefaultModelFor ContentHandlerDefaultModelFor]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ContentHandlerDefaultModelFor ContentHandlerDefaultModelFor]
|callback = book-content-default-mode
|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\AddBooksTable::callback, BlueSpice\Bookshelf\Hook\LoadExtensionSchemaUpdates\AddBookChaptersTable::callback, BlueSpice\Bookshelf\Hook\LoadExtensionSchemaUpdates\AddBookMetaTable::callback, migrateBooks
|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
{{AutoDocCallback
Line 223: Line 237:
|callback = addAddToBookEntry, addEditBook, addNewBook
|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"