Last edited 4 months ago
by Margit Link-Rodrigue

AutoDoc:BlueSpiceBookshelf and AutoDoc:BlueSpiceUEModuleBookPDF: Difference between pages

(Difference between pages)
VisualWikitext
hw>Unknown user
No edit summary
 
m (1 revision imported)
 
Line 1: Line 1:
==DescriptionMsg==
==DescriptionMsg==
{{AutoDocDescriptionMsg
{{AutoDocDescriptionMsg
|name = BlueSpiceBookshelf
|name = BlueSpiceUEModuleBookPDF
|desc = {{int:bs-bookshelf-extension-description
|desc = {{int:bs-uemodulebookpdf-extension-description
}}
}}
}}
}}
Line 16: Line 16:
}}
}}
|extensions = {{AutoDocVersion
|extensions = {{AutoDocVersion
|name = BlueSpiceBookshelf
|version = 4.0
}}
{{AutoDocVersion
|name = BlueSpiceFoundation
|name = BlueSpiceFoundation
|version = 4.0
}}
{{AutoDocVersion
|name = BlueSpiceUEModulePDF
|version = 4.0
}}
{{AutoDocVersion
|name = BlueSpiceUniversalExport
|version = 4.0
|version = 4.0
}}
}}
Line 23: Line 35:
{{AutoDocIntegratesInto
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|into = {{AutoDocListItem
|item = BlueSpiceBookshelf
|item = BlueSpiceUniversalExport
}}
}}
==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
}}
}}
}}
}}
Line 44: Line 41:
{{AutoDocPermissions
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|permissions = {{AutoDocPermission
|name = bookshelf-viewspecialpage
|name = uemodulebookpdf-export
|type = global
|type = namespace
|roles = reader
|desc = {{int:right-bookshelf-viewspecialpage
}}
}}
{{AutoDocPermission
|name = bookshelfbookmanager-viewspecialpage
|type = global
|roles = reader
|roles = reader
|desc = {{int:right-bookshelfbookmanager-viewspecialpage
|desc = {{int:right-uemodulebookpdf-export
}}
}}
}}
}}
==DefaultUserOptions==
{{AutoDocDefaultUserOptions
|options = {{AutoDocOption
|name = bs-bookshelf-defaultview
|value = <nowiki>'gridviewpanel'</nowiki>
}}
}}
}}
}}
Line 68: Line 51:
{{AutoDocConfig
{{AutoDocConfig
|config = {{AutoDocOption
|config = {{AutoDocOption
|name = BookShelfDefaultCoverImage
|name = UEModuleBookPDFBookExportTOC
|value = <nowiki>'resources/images/assets/coverimage/dummy.png'</nowiki>
|value = <nowiki>'only-articles'</nowiki>
}}
{{AutoDocOption
|name = BookShelfShowChapterNavigationPagerAfterContent
|value = <nowiki>false</nowiki>
}}
{{AutoDocOption
|name = BookShelfShowChapterNavigationPagerBeforeContent
|value = <nowiki>false</nowiki>
}}
{{AutoDocOption
|name = BookshelfPrependPageTOCNumbers
|value = <nowiki>true</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
|name = BookshelfSupressBookNS
|name = UEModuleBookPDFDefaultTemplate
|value = <nowiki>true</nowiki>
|value = <nowiki>'BlueSpice Book'</nowiki>
}}
}}
{{AutoDocOption
{{AutoDocOption
|name = BookshelfTitleDisplayText
|name = UEModuleBookPDFTemplatePath
|value = <nowiki>true</nowiki>
|value = <nowiki>'extensions/BlueSpiceUEModuleBookPDF/data/PDFTemplates'</nowiki>
}}
}}
==ApiModules==
{{AutoDocApiModules
|APIModules = {{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
}}
}}
}}
}}
Line 118: Line 66:
{{AutoDocHooks
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|Hooks = {{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfGetBookData BSBookshelfGetBookData]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfBookManager BSBookshelfBookManager]
|callback = \BlueSpice\Bookshelf\Hook\BSBookshelfGetBookData\RunLegacyHook::callback
|callback = \BlueSpice\UEModuleBookPDF\Hook\BSBookshelfBookManager\AddDependencies::callback
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSInsertMagicAjaxGetData BSInsertMagicAjaxGetData]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfGetBookData BSBookshelfGetBookData]
|callback = \BlueSpice\Bookshelf\Hook\BSInsertMagicAjaxGetData\AddBookshelfTag::callback, \BlueSpice\Bookshelf\Hook\BSInsertMagicAjaxGetData\AddBookmetaTag::callback, \BlueSpice\Bookshelf\Hook\BSInsertMagicAjaxGetData\AddBooklistTag::callback
|callback = \BlueSpice\UEModuleBookPDF\Hook\BSBookshelfGetBookData\AddTemplateMetaData::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFAfterFindFiles BSUEModulePDFAfterFindFiles]
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFAfterFindFiles\AddAttachments::callback
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFbeforeGetPage BSUEModulePDFbeforeGetPage]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSMigrateSettingsFromDeviatingNames BSMigrateSettingsFromDeviatingNames]
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFbeforeGetPage\AdaptPageTitle::callback
|callback = \BlueSpice\UEModuleBookPDF\Hook\BSMigrateSettingsFromDeviatingNames\SkipServiceSettings::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
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\Bookshelf\Hook\BeforePageDisplay\AddResources::callback
|callback = \BlueSpice\UEModuleBookPDF\Hook\BeforePageDisplay\AddResources::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BlueSpiceDiscoveryTemplateDataProviderAfterInit BlueSpiceDiscoveryTemplateDataProviderAfterInit]
|callback = discovery-skin
}}
}}
{{AutoDocCallback
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ChameleonSkinTemplateOutputPageBeforeExec ChameleonSkinTemplateOutputPageBeforeExec]
|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
|callback = BlueSpice\UEModuleBookPDF\Hook\ChameleonSkinTemplateOutputPageBeforeExec\AddBookExportAction::callback, BlueSpice\UEModuleBookPDF\Hook\ChameleonSkinTemplateOutputPageBeforeExec\AddBookExportActionBookPage::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 12:51, 14 December 2021

DescriptionMsg

Enables BlueSpice export hierarchical collections of articles to Adobe® Portable Document Format (PDF).

License

GPL-3.0-only

Requirements

  • MediaWiki: 1.35.0
  • BlueSpiceBookshelf: 4.0

BlueSpiceFoundation: 4.0 BlueSpiceUEModulePDF: 4.0 BlueSpiceUniversalExport: 4.0

IntegratesInto

  • BlueSpiceUniversalExport

Permissions

Permissions

Name Description Role
uemodulebookpdf-export Export a page to PDF as part of a book reader

Config

Configuration

Name Value
UEModuleBookPDFBookExportTOC 'only-articles'
UEModuleBookPDFDefaultTemplate 'BlueSpice Book'
UEModuleBookPDFTemplatePath 'extensions/BlueSpiceUEModuleBookPDF/data/PDFTemplates'

Hooks

Hooks

Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=AutoDoc:BlueSpiceBookshelf&oldid=212"
No categories assignedEdit

Discussions