Vorlage:Ombox/Doku: Unterschied zwischen den Versionen
Adding documentation of the small parameters. And some other fixes.
imported>Happy-melon (navbox) |
imported>Davidgothberg (Adding documentation of the small parameters. And some other fixes.) |
||
| Zeile 81: | Zeile 81: | ||
Some examples using the "notice" style: | Some examples using the "notice" style: | ||
{{ombox | |||
| text = No type and no image given ('''default''') | |||
}} | |||
{{ombox | |||
| image = none | |||
| text = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area. | |||
}} | |||
{{ombox | |||
| image = [[Image:Gnome globe current event.svg|42px]] | |||
| imageright = [[Image:Nuvola apps bookcase.svg|40px]] | |||
| text = image = <nowiki>[[Image:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki> | |||
}} | |||
{{ombox | {{ombox | ||
| Zeile 105: | Zeile 118: | ||
| image = none / [[Image:Some image.svg|40px]] | | image = none / [[Image:Some image.svg|40px]] | ||
| imageright = [[Image:Some image.svg|40px]] | | imageright = [[Image:Some image.svg|40px]] | ||
| style = CSS | | style = CSS values | ||
| textstyle = CSS | | textstyle = CSS values | ||
| text = The message body text. | | text = The message body text. | ||
| small = {{{small|}}} / yes | |||
| smallimage = none / [[Image:Some image.svg|30px]] | |||
| smallimageright = none / [[Image:Some image.svg|30px]] | |||
| smalltext = A shorter message body text. | |||
}} | }} | ||
</pre> | </pre> | ||
| Zeile 127: | Zeile 144: | ||
'''style''' | '''style''' | ||
: | :Optional [[Cascading Style Sheets|CSS]] values used by the entire message box table. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example: | ||
::<code>style = margin-bottom: 0.5em;</code> | ::<code>style = margin-bottom: 0.5em;</code> | ||
'''textstyle''' | '''textstyle''' | ||
: | :Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example: | ||
::<code>textstyle = text-align: center;</code> | ::<code>textstyle = text-align: center;</code> | ||
'''text''' | '''text''' | ||
:The message body text. | :The message body text. | ||
==== The small parameters ==== | |||
{{ombox | |||
| small = yes | |||
| text = small = yes | |||
}} | |||
{{ombox | |||
| type = style | |||
| small = yes | |||
| text = type = style <br> small = yes | |||
}} | |||
'''small''' | |||
:'''yes''' = Makes it a smaller right floating message box. This also makes the default images smaller. Note that any data fed to the '''smallimage''', '''smallimageright''' and '''smalltext''' parameters is only used if "small=yes". To make it so your template also understands the small parameter you can use this code: | |||
::<code><nowiki>small = {{{small|}}}</nowiki></code> | |||
{{ombox | |||
| small = yes | |||
| image = [[Image:Nuvola apps bookcase.png|50px]] | |||
| smallimage = [[Image:Nuvola apps bookcase.png|30px]] | |||
| text = | |||
small = yes <br> image = <nowiki>[[Image:Nuvola apps bookcase.png|50px]]</nowiki> <br> smallimage = <nowiki>[[Image:Nuvola apps bookcase.png|30px]]</nowiki> | |||
}} | |||
'''smallimage''' | |||
:'''No parameter''' = If no '''smallimage''' parameter is given then this template falls back to use the '''image''' parameter. If the '''image''' parameter also is empty then a small default image is used. | |||
:'''An image''' = Should be an image with usual wiki notation. 30px width are usually about right. For example: | |||
::<code><nowiki>image = [[Image:Crystal package settings.png|30px]]</nowiki></code> | |||
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=yes". | |||
{{ombox | |||
| small = yes | |||
| imageright = [[Image:Nuvola apps bookcase.png|50px]] | |||
| smallimageright = none | |||
| text = | |||
small = yes <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.png|50px]]</nowiki> <br> smallimageright = none | |||
}} | |||
'''smallimageright''' | |||
:'''No parameter''' = If no '''smallimageright''' parameter is given then this template falls back to use the '''imageright''' parameter. If the '''imageright''' parameter also is empty then no image is shown on the right side. | |||
:'''An image''' = Should be an image with usual wiki notation. 30px width are usually about right. For example: | |||
::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|30px]]</nowiki></code> | |||
:'''Anything''' = Any other object that you want to show on the right side. | |||
:'''none''' = Means that no right side image is used. This overrides any image fed to '''imageright''', when "small=yes". | |||
'''smalltext''' | |||
:A shorter version of the message body text. If no '''smalltext''' parameter is given then this template falls back to use the '''text''' parameter. | |||
=== Technical details === | === Technical details === | ||
| Zeile 160: | Zeile 222: | ||
This template uses the ombox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable. | This template uses the ombox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable. | ||
This template calls {{tl|ombox/core}} which holds most of the code for {{tl|ombox}}, while {{tl|ombox}} itself does parameter preprocessing. | |||
Internally this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and special characters in parameters. | Internally this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and special characters in parameters. | ||
| Zeile 165: | Zeile 229: | ||
The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent background that MediaWiki renders for svg images. The png images here have hand optimised transparent background colour so they look good in all browsers. Note that svg icons only look somewhat bad in the old browsers, thus such hand optimisation is only worth the trouble for very widely used icons. | The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent background that MediaWiki renders for svg images. The png images here have hand optimised transparent background colour so they look good in all browsers. Note that svg icons only look somewhat bad in the old browsers, thus such hand optimisation is only worth the trouble for very widely used icons. | ||
For more technical details see the [[Template talk:Ombox|talk page]]. Since this template works almost exactly like {{tl| | For more technical details see the [[Template talk:Ombox|talk page]]. Since this template works almost exactly like {{tl|ambox}}, {{tl|tmbox}}, {{tl|imbox}} and {{tl|cmbox}} their talk pages and related pages might also contain more details. | ||
=== See also === | === See also === | ||
| Zeile 176: | Zeile 240: | ||
* {{tl|ombox}} – For other pages message boxes. | * {{tl|ombox}} – For other pages message boxes. | ||
* {{tl|mbox}} – Has namespace detection, for message boxes that are used on several types of pages and thus need to change style depending on what page they are used on. | * {{tl|mbox}} – Has namespace detection, for message boxes that are used on several types of pages and thus need to change style depending on what page they are used on. | ||
* {{tl|fmbox}} – For header and footer message boxes. | |||
<includeonly> | <includeonly> | ||