AutoDoc:BlueSpiceBookshelf: Difference between revisions

imported>Unknown user
No edit summary
m 1 revision imported
 
(One intermediate revision by one other user not shown)
Line 35: Line 35:
{{AutoDocListItem
{{AutoDocListItem
|item = BlueSpiceExtendedSearch
|item = BlueSpiceExtendedSearch
}}
{{AutoDocListItem
|item = BlueSpiceSMWConnector
}}
}}
{{AutoDocListItem
{{AutoDocListItem
Line 111: Line 114:
|name = BookshelfPrependPageTOCNumbers
|name = BookshelfPrependPageTOCNumbers
|value = <nowiki>true</nowiki>
|value = <nowiki>true</nowiki>
}}
{{AutoDocOption
|name = BookshelfSupressBookNS
|value = <nowiki>false</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
Line 160: Line 167:
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfPageAddedToBook BSBookshelfPageAddedToBook]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfPageAddedToBook BSBookshelfPageAddedToBook]
|callback = updateSearchIndex
|callback = queueJobs
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfPageRemovedFromBook BSBookshelfPageRemovedFromBook]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfPageRemovedFromBook BSBookshelfPageRemovedFromBook]
|callback = updateSearchIndex
|callback = queueJobs
}}
}}
{{AutoDocCallback
{{AutoDocCallback
Line 197: Line 204:
|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 226: 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