AutoDoc:BlueSpiceArticlePreviewCapture and AutoDoc:BlueSpiceBookshelf: Difference between pages

(Difference between pages)
hw>Unknown user
No edit summary
 
hw>Unknown user
No edit summary
 
Line 1: Line 1:
==DescriptionMsg==
==DescriptionMsg==
{{AutoDocDescriptionMsg
{{AutoDocDescriptionMsg
|name = BlueSpiceArticlePreviewCapture
|name = BlueSpiceBookshelf
|desc = {{int:bs-articlepreviewcapture-desc
|desc = {{int:bs-bookshelf-extension-description
}}
}}
}}
}}
Line 18: Line 18:
|name = BlueSpiceFoundation
|name = BlueSpiceFoundation
|version = 4.0
|version = 4.0
}}
}}
==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>
}}
}}
}}
}}
Line 23: Line 68:
{{AutoDocConfig
{{AutoDocConfig
|config = {{AutoDocOption
|config = {{AutoDocOption
|name = ArticlePreviewCapturePhantomJSBackend
|name = BookShelfDefaultCoverImage
|value = <nowiki>'native-shell-exec'</nowiki>
|value = <nowiki>'resources/images/assets/coverimage/dummy.png'</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
|name = ArticlePreviewCapturePhantomJSBaseUrl
|name = BookShelfShowChapterNavigationPagerAfterContent
|value = <nowiki>NULL</nowiki>
|value = <nowiki>false</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
|name = ArticlePreviewCapturePhantomJSEscapeShellCommand
|name = BookShelfShowChapterNavigationPagerBeforeContent
|value = <nowiki>false</nowiki>
}}
{{AutoDocOption
|name = BookshelfPrependPageTOCNumbers
|value = <nowiki>true</nowiki>
|value = <nowiki>true</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
|name = ArticlePreviewCapturePhantomJSExecutable
|name = BookshelfSupressBookNS
|value = <nowiki>'/usr/local/bin/phantomjs'</nowiki>
|value = <nowiki>true</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
|name = ArticlePreviewCapturePhantomJSOptions
|name = BookshelfTitleDisplayText
|value = <nowiki>array (
|value = <nowiki>true</nowiki>
  0 => '--ignore-ssl-errors',
}}
  1 => 'true',
}}
)</nowiki>
==ApiModules==
{{AutoDocApiModules
|APIModules = {{AutoDocCallback
|name = bs-bookshelf-bookstore
|callback = ApiBookshelfBookStore
}}
}}
{{AutoDocOption
{{AutoDocCallback
|name = ArticlePreviewCapturePhantomJSServiceURL
|name = bs-bookshelf-manage
|value = <nowiki>NULL</nowiki>
|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
}}
}}
}}
}}
Line 53: Line 118:
{{AutoDocHooks
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SetupAfterCache SetupAfterCache]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfGetBookData BSBookshelfGetBookData]
|callback = \BlueSpice\ArticlePreviewCapture\Hook\SetupAfterCache\AddForeignFileRepo::callback
|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/BlueSpiceDiscoveryTemplateDataProviderAfterInit BlueSpiceDiscoveryTemplateDataProviderAfterInit]
|callback = discovery-skin
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ChameleonSkinTemplateOutputPageBeforeExec ChameleonSkinTemplateOutputPageBeforeExec]
|callback = BlueSpice\Bookshelf\Hook\ChameleonSkinTemplateOutputPageBeforeExec\SetBookContentModelActions::callback, BlueSpice\Bookshelf\Hook\ChameleonSkinTemplateOutputPageBeforeExec\AddChapterPager::callback, BlueSpice\Bookshelf\Hook\ChameleonSkinTemplateOutputPageBeforeExec\AddBookshelfUI::callback, BlueSpice\Bookshelf\Hook\ChameleonSkinTemplateOutputPageBeforeExec\AddToBookTool::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/MWStakeCommonUIRegisterSkinSlotComponents MWStakeCommonUIRegisterSkinSlotComponents]
|callback = common-user-interface
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation::Universal SkinTemplateNavigation::Universal]
|callback = BlueSpice\Bookshelf\Hook\SkinTemplateNavigationUniversal\AddAddToBookEntry::callback, BlueSpice\Bookshelf\Hook\SkinTemplateNavigationUniversal\AddEditBook::callback
}}
}}
}}
}}



Revision as of 11:53, 14 December 2021

DescriptionMsg

Enables BlueSpice to manage and export hierarchical collections of articles.

License

GPL-3.0-only

Requirements

  • MediaWiki: 1.35.0
  • BlueSpiceFoundation: 4.0

IntegratesInto

  • BlueSpiceBookshelf

SpecialPages

  • Bookshelf
  • BookshelfBookEditor
  • BookshelfBookManager

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
BookshelfPrependPageTOCNumbers true
BookshelfSupressBookNS true
BookshelfTitleDisplayText true

ApiModules

API Modules

  • bs-bookshelf-bookstore
  • bs-bookshelf-manage
  • bs-bookshelf-mass-add-page-store
  • bs-bookshelf-page-collection-store
  • bs-bookshelf-store

Hooks

Hooks

No categories assignedEdit

Discussions