Last edited 4 months ago
by Margit Link-Rodrigue

AutoDoc:BlueSpiceBookshelf and Template:Banner: Difference between pages

(Difference between pages)
VisualWikitext
hw>Unknown user
No edit summary
 
hw>WikiSysop
No edit summary
 
Line 1: Line 1:
==DescriptionMsg==
<includeonly><templatestyles src="Banner/styles.css" /><div class="bannerbox" style="align-items:start;{{#ifeq:{{{imagealign|}}}|right|flex-direction:row-reverse;|flex-dirction:row;}}{{#if:{{{boxbgcolor|}}}|background:{{{boxbgcolor}}};|}}padding:{{{boxpadding|0px}}};">
{{AutoDocDescriptionMsg
{{#if:{{{banner-image|}}}|<div class="banner-image">[[File:{{{banner-image}}}{{!}}{{#if:{{{image-width|}}}|{{{image-width}}}x{{{image-width}}}px|200x200px}}{{!}}link=]]</div>|}}<div class="banner-content" style="padding:{{#if:{{{contentpadding|}}}|{{{contentpadding}}}"|10px}}>{{#if:{{{banner-title|}}}|<div class="banner-title"><h1 style="margin-top:0; {{#if:{{{titlesize|}}}|font-size:{{{titlesize}}};|font-size:1.6em;}}{{#if:{{{titlecolor|}}}|color:{{{titlecolor}}};|}}">{{{banner-title}}}</h1></div>|}}{{#if:{{{banner-text|}}}|<div class="banner-text" style="{{#if:{{{textcolor|}}}|color:{{{textcolor}}};|}}{{#if:{{{textsize|}}}|font-size:{{{textsize}}};|}}">{{{banner-text}}}</div>|}}</div></div></includeonly><noinclude>
|name = BlueSpiceBookshelf
This template creates an intro banner on a page. The banner should contain an image (optional), a title and 2-3 lines of text.
|desc = {{int:bs-bookshelf-extension-description
<templatedata>
}}
{
}}
"params": {
==License==
"boxbgcolor": {
{{AutoDocLicense
"label": {
|name = GPL-3.0-only
"en": "Background color (optional)",
}}
"de": "Hintergrundfarbe der Box (optional)"
==Requirements==
},
{{AutoDocRequirements
"description": {
|mediawiki = {{AutoDocVersion
"en": "Default is grey (#efefef). Replace with any hex value, (e.g. #ffffe6)",
|name = MediaWiki
"de": "Standard ist grau (#efefef). Kann mit beliebigem Hex-Wert ersetzt werden (z.B. #ffffe6)"
|version = 1.35.0
},
}}
"type": "string",
|extensions = {{AutoDocVersion
"suggested": true,
|name = BlueSpiceFoundation
"default": {
|version = 4.0
"en": "#efefef",
}}
"de": "#efefef"
}}
}
==IntegratesInto==
},
{{AutoDocIntegratesInto
"boxpadding": {
|into = {{AutoDocListItem
"label": {
|item = BlueSpiceBookshelf
"en": "Padding of the container box (optional)",
}}
"de": "Abstand des Inhalts zur Box"
}}
},
==SpecialPages==
"description": {
{{AutoDocSpecialPages
"en": "Sets the padding for the box. Default is 0.",
|SpecialPages = {{AutoDocCallback
"de": "Setzt den Abstand in Pixeln, Standard ist 0"
|name = Bookshelf
},
|callback = \BlueSpice\Bookshelf\Special\Bookshelf
"example": {
}}
"en": "e.g., 10px (default is 0)",
{{AutoDocCallback
"de": "z.B. 10px (Standard ist 0)"
|name = BookshelfBookEditor
},
|callback = \BlueSpice\Bookshelf\Special\BookshelfBookEditor
"suggested": true,
}}
"autovalue": ""
{{AutoDocCallback
},
|name = BookshelfBookManager
"contentpadding": {
|callback = \BlueSpice\Bookshelf\Special\BookshelfBookManager
"label": {
}}
"en": "Content padding (optional)",
}}
"de": "Textabstand"
==Permissions==
},
{{AutoDocPermissions
"description": {
|permissions = {{AutoDocPermission
"en": "Padding around text. Default is 10px.",
|name = bookshelf-viewspecialpage
"de": "Abstand um den Text. Standard ist 10px."
|type = global
},
|roles = reader
"type": "number",
|desc = {{int:right-bookshelf-viewspecialpage
"example": {
}}
"en": "20px",
}}
"de": "20px"
{{AutoDocPermission
},
|name = bookshelfbookmanager-viewspecialpage
"suggested": true
|type = global
},
|roles = reader
"banner-image": {
|desc = {{int:right-bookshelfbookmanager-viewspecialpage
"description": {
}}
"en": "Image name, without the File: prefix, but with namespace prefix (if it exists)",
}}
"de": "Bildname, ohne das Datei-Präfix, aber mit Namensraum-Präfix (falls es existiert)"
}}
},
==DefaultUserOptions==
"label": {
{{AutoDocDefaultUserOptions
"en": "Banner image (optional)",
|options = {{AutoDocOption
"de": "Bannergrafik (optional)"
|name = bs-bookshelf-defaultview
},
|value = <nowiki>'gridviewpanel'</nowiki>
"example": {
}}
"en": "myimage.png",
}}
"de": "meinbild.png"
==Config==
},
{{AutoDocConfig
"suggested": true
|config = {{AutoDocOption
},
|name = BookShelfDefaultCoverImage
"image-width": {
|value = <nowiki>'resources/images/assets/coverimage/dummy.png'</nowiki>
"label": {
}}
"en": "Image width",
{{AutoDocOption
"de": "Bildbreite"
|name = BookShelfShowChapterNavigationPagerAfterContent
},
|value = <nowiki>false</nowiki>
"description": {
}}
"en": "Width in pixels. Default setting is 200",
{{AutoDocOption
"de": "Breite in Pixel. Standard ist 200"
|name = BookShelfShowChapterNavigationPagerBeforeContent
},
|value = <nowiki>false</nowiki>
"suggested": true,
}}
"default": {
{{AutoDocOption
"de-formal": "200"
|name = BookshelfPrependPageTOCNumbers
},
|value = <nowiki>true</nowiki>
"example": {
}}
"de": "z.B. 300 (Standard ist 200)",
{{AutoDocOption
"en": "e.g., 300 (default is 200)"
|name = BookshelfSupressBookNS
}
|value = <nowiki>true</nowiki>
},
}}
"imagealign": {
{{AutoDocOption
"label": {
|name = BookshelfTitleDisplayText
"en": "Image alignment",
|value = <nowiki>true</nowiki>
"de": "Bildposition"
}}
},
}}
"example": {
==ApiModules==
"en": "left, right",
{{AutoDocApiModules
"de": "left, right"
|APIModules = {{AutoDocCallback
},
|name = bs-bookshelf-bookstore
"default": {
|callback = ApiBookshelfBookStore
"en": "left",
}}
"de": "left"
{{AutoDocCallback
},
|name = bs-bookshelf-manage
"suggested": true,
|callback = ApiBookshelfManage
"description": "Links oder rechts in der Box"
}}
},
{{AutoDocCallback
"banner-title": {
|name = bs-bookshelf-mass-add-page-store
"type": "string",
|callback = ApiBookshelfMassAddPageStore
"suggested": true,
}}
"label": {
{{AutoDocCallback
"en": "Heading",
|name = bs-bookshelf-page-collection-store
"de": "Überschrift"
|callback = ApiBookshelfPageCollectionStore
},
}}
"description": "Box heading"
{{AutoDocCallback
},
|name = bs-bookshelf-store
"titlesize": {
|callback = ApiBookshelfStore
"label": {
}}
"en": "Heading size",
}}
"de": "Größe der Überschrift"
==Hooks==
},
{{AutoDocHooks
"example": {
|Hooks = {{AutoDocCallback
"en": "2em, 15px",
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSBookshelfGetBookData BSBookshelfGetBookData]
"de": "2em,  15px"
|callback = \BlueSpice\Bookshelf\Hook\BSBookshelfGetBookData\RunLegacyHook::callback
},
}}
"default": {
{{AutoDocCallback
"en": "1.6em",
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSInsertMagicAjaxGetData BSInsertMagicAjaxGetData]
"de": "1.6em"
|callback = \BlueSpice\Bookshelf\Hook\BSInsertMagicAjaxGetData\AddBookshelfTag::callback, \BlueSpice\Bookshelf\Hook\BSInsertMagicAjaxGetData\AddBookmetaTag::callback, \BlueSpice\Bookshelf\Hook\BSInsertMagicAjaxGetData\AddBooklistTag::callback
},
}}
"suggested": true
{{AutoDocCallback
},
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFAfterFindFiles BSUEModulePDFAfterFindFiles]
"titlecolor": {
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFAfterFindFiles\AddAttachments::callback
"label": {
}}
"en": "Heading color",
{{AutoDocCallback
"de": "Farbe der Überschrift"
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFbeforeGetPage BSUEModulePDFbeforeGetPage]
},
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFbeforeGetPage\AdaptPageTitle::callback
"description": "Color of the heading. ",
}}
"example": {
{{AutoDocCallback
"en": "#ffffff",
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFcollectMetaData BSUEModulePDFcollectMetaData]
"de": "#ffffff"
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFcollectMetaData\SupressBookNS::callback, \BlueSpice\Bookshelf\Hook\BSUEModulePDFcollectMetaData\AddBookMeta::callback
},
}}
"suggested": true
{{AutoDocCallback
},
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BSUEModulePDFgetPage BSUEModulePDFgetPage]
"banner-text": {
|callback = \BlueSpice\Bookshelf\Hook\BSUEModulePDFgetPage\ModifyForExport::callback
"label": {
}}
"en": "Text",
{{AutoDocCallback
"de": "Text"
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay BeforePageDisplay]
},
|callback = \BlueSpice\Bookshelf\Hook\BeforePageDisplay\AddResources::callback
"description": {
}}
"en": "1-3 lines of text",
{{AutoDocCallback
"de": "1-3 Zeilen Text"
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/BlueSpiceDiscoveryTemplateDataProviderAfterInit BlueSpiceDiscoveryTemplateDataProviderAfterInit]
},
|callback = discovery-skin
"type": "content",
}}
"suggested": true
{{AutoDocCallback
},
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ChameleonSkinTemplateOutputPageBeforeExec ChameleonSkinTemplateOutputPageBeforeExec]
"textcolor": {
|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
"label": {
}}
"en": "Text color",
{{AutoDocCallback
"de": "Textfarbe"
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/ContentHandlerDefaultModelFor ContentHandlerDefaultModelFor]
},
|callback = BlueSpice\Bookshelf\Hook\ContentHandlerDefaultModelFor\GetBookContentHandler::callback
"example": {
}}
"en": "#000000",
{{AutoDocCallback
"de": "#000000"
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences GetPreferences]
},
|callback = \BlueSpice\Bookshelf\Hook\GetPreferences\BookshelfDefaultView::callback
"suggested": true
}}
},
{{AutoDocCallback
"textsize": {
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/LoadExtensionSchemaUpdates LoadExtensionSchemaUpdates]
"label": {
|callback = BlueSpice\Bookshelf\Hook\LoadExtensionSchemaUpdates\AddConvertContentModel::callback
"en": "Text size",
}}
"de": "Textgröße"
{{AutoDocCallback
},
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/MWStakeCommonUIRegisterSkinSlotComponents MWStakeCommonUIRegisterSkinSlotComponents]
"example": {
|callback = common-user-interface
"en": "12px, 1em",
}}
"de": "12px, 1em"
{{AutoDocCallback
},
|name = [https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation::Universal SkinTemplateNavigation::Universal]
"default": {
|callback = BlueSpice\Bookshelf\Hook\SkinTemplateNavigationUniversal\AddAddToBookEntry::callback, BlueSpice\Bookshelf\Hook\SkinTemplateNavigationUniversal\AddEditBook::callback
"en": "1.3em",
}}
"de": "1.3em"
}}
},
 
"suggested": true
}
},
"paramOrder": [
"banner-image",
"image-width",
"imagealign",
"banner-title",
"titlesize",
"titlecolor",
"banner-text",
"textsize",
"textcolor",
"contentpadding",
"boxpadding",
"boxbgcolor"
]
}
</templatedata>
</noinclude>

Revision as of 09:36, 25 June 2021

This template creates an intro banner on a page. The banner should contain an image (optional), a title and 2-3 lines of text.

No description.

Template parameters

ParameterDescriptionTypeStatus
Banner image (optional)banner-image

Image name, without the File: prefix, but with namespace prefix (if it exists)

Example
myimage.png
Unknownsuggested
Image widthimage-width

Width in pixels. Default setting is 200

Example
e.g., 300 (default is 200)
Unknownsuggested
Image alignmentimagealign

Links oder rechts in der Box

Default
left
Example
left, right
Unknownsuggested
Headingbanner-title

Box heading

Stringsuggested
Heading sizetitlesize

no description

Default
1.6em
Example
2em, 15px
Unknownsuggested
Heading colortitlecolor

Color of the heading.

Example
#ffffff
Unknownsuggested
Textbanner-text

1-3 lines of text

Contentsuggested
Text sizetextsize

no description

Default
1.3em
Example
12px, 1em
Unknownsuggested
Text colortextcolor

no description

Example
#000000
Unknownsuggested
Content padding (optional)contentpadding

Padding around text. Default is 10px.

Example
20px
Numbersuggested
Padding of the container box (optional)boxpadding

Sets the padding for the box. Default is 0.

Example
e.g., 10px (default is 0)
Auto value
Unknownsuggested
Background color (optional)boxbgcolor

Default is grey (#efefef). Replace with any hex value, (e.g. #ffffe6)

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

Discussions