You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "AutoDoc:BlueSpiceUEModuleBookPDF"
m (1 revision imported) |
m (1 revision imported) |
Contents
DescriptionMsg[edit source]
Enables BlueSpice export hierarchical collections of articles to Adobe® Portable Document Format (PDF).
License[edit source]
GPL-3.0-only
Requirements[edit source]
- MediaWiki: ~11.31
- BlueSpiceFoundationBlueSpiceBookshelf: ~33.2
BlueSpiceUniversalExportBlueSpiceFoundation: ~33.2 BlueSpiceBookshelfBlueSpiceUEModulePDF: ~33.2 BlueSpiceUEModulePDFBlueSpiceUniversalExport: ~33.2
IntegratesInto[edit source]
- BlueSpiceFoundation
- BlueSpiceUniversalExport
Permissions[edit source]
Permissions
| Name | Description | Role |
|---|---|---|
| uemodulebookpdf-export | Export a page to PDF as part of a book | reader |
Config[edit source]
Configuration[edit source]
| Name | Value |
|---|---|
| UEModuleBookPDFBookExportTOC | 'only-articles' |
| UEModuleBookPDFDefaultTemplate | 'BlueSpice Book' |
| UEModuleBookPDFTemplatePath | 'extensions/BlueSpiceUEModuleBookPDF/data/PDFTemplates' |
| UEModuleBookPDFDefaultTemplate | 'BlueSpice Book' |
Hooks[edit source]
Hooks[edit source]
- BeforePageDisplayBSBookshelfGetBookData
- BSMigrateSettingsFromDeviatingNames
- BeforePageDisplay
- SkinTemplateOutputPageBeforeExec
- BSBookshelfGetBookData
==DescriptionMsg==
{{AutoDocDescriptionMsg
|name = BlueSpiceUEModuleBookPDF
|desc = {{int:bs-uemodulebookpdf-extension-description
}}
}}
==License==
{{AutoDocLicense
|name = GPL-3.0-only
}}
==Requirements==
{{AutoDocRequirements
|mediawiki = {{AutoDocVersion
|name = MediaWiki
|version = ~11.31
}}
|extensions = {{AutoDocVersion
|name = BlueSpiceFoundationBlueSpiceBookshelf
|version = ~33.2
}}
{{AutoDocVersion
|name = BlueSpiceUniversalExportBlueSpiceFoundation
|version = ~33.2
}}
{{AutoDocVersion
|name = BlueSpiceBookshelfBlueSpiceUEModulePDF
|version = ~33.2
}}
{{AutoDocVersion
|name = BlueSpiceUEModulePDFBlueSpiceUniversalExport
|version = ~33.2
}}
}}
==IntegratesInto==
{{AutoDocIntegratesInto
|into = {{AutoDocListItem
|item = BlueSpiceFoundation
}}
{{AutoDocListItem
|item = BlueSpiceUniversalExport
}}
}}
==Permissions==
{{AutoDocPermissions
|permissions = {{AutoDocPermission
|name = uemodulebookpdf-export
|type = namespace
|roles = reader
|desc = {{int:right-uemodulebookpdf-export
}}
}}
}}
==Config==
{{AutoDocConfig
|config = {{AutoDocOption
|name = UEModuleBookPDFBookExportTOC
|value = <nowiki>'only-articles'</nowiki>
}}
{{AutoDocOption
|name = UEModuleBookPDFTemplatePathUEModuleBookPDFDefaultTemplate
|value = <nowiki>'extensions/BlueSpiceUEModuleBookPDF/data/PDFTemplatesBlueSpice Book'</nowiki>
}}
{{AutoDocOption
|name = UEModuleBookPDFDefaultTemplateUEModuleBookPDFTemplatePath
|value = <nowiki>'BlueSpice Bookextensions/BlueSpiceUEModuleBookPDF/data/PDFTemplates'</nowiki>
}}
}}
==Hooks==
{{AutoDocHooks
|Hooks = {{AutoDocCallback
|name = BeforePageDisplay
[https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfGetBookData BSBookshelfGetBookData]
|callback = \BlueSpice\UEModuleBookPDF\Hook\BeforePageDisplay\AddResourcesBSBookshelfGetBookData\AddTemplateMetaData::callback
}}
{{AutoDocCallback
|name = BSMigrateSettingsFromDeviatingNames
[https://www.mediawiki.org/wiki/Manual:Hooks/BSMigrateSettingsFromDeviatingNames BSMigrateSettingsFromDeviatingNames]
|callback = \BlueSpice\UEModuleBookPDF\Hook\BSMigrateSettingsFromDeviatingNames\SkipServiceSettings::callback
}}
{{AutoDocCallback
|name = SkinTemplateOutputPageBeforeExec
|callback = BlueSpice\UEModuleBookPDF\Hook\SkinTemplateOutputPageBeforeExec\AddBookExportAction::callback,BlueSpice\UEModuleBookPDF\Hook\SkinTemplateOutputPageBeforeExec\AddBookExportActionBookPage::callback
}}
{{AutoDocCallback
|name = BSBookshelfGetBookData
|callback = \BlueSpice\UEModuleBookPDF\Hook\BSBookshelfGetBookData\AddTemplateMetaData[https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
|callback = \BlueSpice\UEModuleBookPDF\Hook\BeforePageDisplay\AddResources::callback
}}
{{AutoDocCallback
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec]
|callback = BlueSpice\UEModuleBookPDF\Hook\SkinTemplateOutputPageBeforeExec\AddBookExportAction::callback, BlueSpice\UEModuleBookPDF\Hook\SkinTemplateOutputPageBeforeExec\AddBookExportActionBookPage::callback
}}
}}| Line 4: | Line 4: | ||
|desc = {{int:bs-uemodulebookpdf-extension-description | |desc = {{int:bs-uemodulebookpdf-extension-description | ||
}} | }} | ||
| + | }} | ||
| + | ==License== | ||
| + | {{AutoDocLicense | ||
| + | |name = GPL-3.0-only | ||
}} | }} | ||
==Requirements== | ==Requirements== | ||
| Line 9: | Line 13: | ||
|mediawiki = {{AutoDocVersion | |mediawiki = {{AutoDocVersion | ||
|name = MediaWiki | |name = MediaWiki | ||
| − | |version = | + | |version = 1.31 |
}} | }} | ||
|extensions = {{AutoDocVersion | |extensions = {{AutoDocVersion | ||
| − | |name = | + | |name = BlueSpiceBookshelf |
| − | |version = | + | |version = 3.2 |
}} | }} | ||
{{AutoDocVersion | {{AutoDocVersion | ||
| − | |name = | + | |name = BlueSpiceFoundation |
| − | |version = | + | |version = 3.2 |
}} | }} | ||
{{AutoDocVersion | {{AutoDocVersion | ||
| − | |name = | + | |name = BlueSpiceUEModulePDF |
| − | |version = | + | |version = 3.2 |
}} | }} | ||
{{AutoDocVersion | {{AutoDocVersion | ||
| − | |name = | + | |name = BlueSpiceUniversalExport |
| − | |version = | + | |version = 3.2 |
}} | }} | ||
}} | }} | ||
| Line 31: | Line 35: | ||
{{AutoDocIntegratesInto | {{AutoDocIntegratesInto | ||
|into = {{AutoDocListItem | |into = {{AutoDocListItem | ||
| − | |||
| − | |||
| − | |||
|item = BlueSpiceUniversalExport | |item = BlueSpiceUniversalExport | ||
}} | }} | ||
| Line 52: | Line 53: | ||
|name = UEModuleBookPDFBookExportTOC | |name = UEModuleBookPDFBookExportTOC | ||
|value = <nowiki>'only-articles'</nowiki> | |value = <nowiki>'only-articles'</nowiki> | ||
| + | }} | ||
| + | {{AutoDocOption | ||
| + | |name = UEModuleBookPDFDefaultTemplate | ||
| + | |value = <nowiki>'BlueSpice Book'</nowiki> | ||
}} | }} | ||
{{AutoDocOption | {{AutoDocOption | ||
|name = UEModuleBookPDFTemplatePath | |name = UEModuleBookPDFTemplatePath | ||
|value = <nowiki>'extensions/BlueSpiceUEModuleBookPDF/data/PDFTemplates'</nowiki> | |value = <nowiki>'extensions/BlueSpiceUEModuleBookPDF/data/PDFTemplates'</nowiki> | ||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
}} | }} | ||
| Line 65: | Line 66: | ||
{{AutoDocHooks | {{AutoDocHooks | ||
|Hooks = {{AutoDocCallback | |Hooks = {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfGetBookData BSBookshelfGetBookData] |
| − | |callback = \BlueSpice\UEModuleBookPDF\Hook\ | + | |callback = \BlueSpice\UEModuleBookPDF\Hook\BSBookshelfGetBookData\AddTemplateMetaData::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = BSMigrateSettingsFromDeviatingNames | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSMigrateSettingsFromDeviatingNames BSMigrateSettingsFromDeviatingNames] |
|callback = \BlueSpice\UEModuleBookPDF\Hook\BSMigrateSettingsFromDeviatingNames\SkipServiceSettings::callback | |callback = \BlueSpice\UEModuleBookPDF\Hook\BSMigrateSettingsFromDeviatingNames\SkipServiceSettings::callback | ||
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay] |
| − | |callback = | + | |callback = \BlueSpice\UEModuleBookPDF\Hook\BeforePageDisplay\AddResources::callback |
}} | }} | ||
{{AutoDocCallback | {{AutoDocCallback | ||
| − | |name = | + | |name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateOutputPageBeforeExec SkinTemplateOutputPageBeforeExec] |
| − | |callback = \BlueSpice\UEModuleBookPDF\Hook\ | + | |callback = BlueSpice\UEModuleBookPDF\Hook\SkinTemplateOutputPageBeforeExec\AddBookExportAction::callback, BlueSpice\UEModuleBookPDF\Hook\SkinTemplateOutputPageBeforeExec\AddBookExportActionBookPage::callback |
}} | }} | ||
}} | }} | ||