Template:Ambox/doc
{{#if: |
{{#if:x||
}} |{{#ifeq: doc | doc
|
{{
#ifeq: show | show | Template:Mbox }}{{ #if: | | {{#ifeq:Template|Template|}} }}
| }} }} This is the Template:Tl or message box meta-template.
It is used to build message box templates. It offers several different colours, uses default images if no image parameter is given and it has some other features.
This meta-template uses the mbox CSS classes in MediaWiki:Common.css.
Usage
Simple usage example:
{{mbox | text = Some text.}}
Complex example:
{{mbox | type = style | small = left | image = [[File:Emblem-question-yellow.png|40px|alt=Question mark]] | smallimage = [[File:Emblem-question-yellow.png|20px|alt=Question mark]] | textstyle = color: red; font-weight: bold; font-style: italic; | text = Text for a big box, for the top of articles. | smalltext = Text for the top of article sections. }}
But you are not really supposed to use red bold italic text.
Message box types
The following examples use different type parameters but use no image parameters thus they use the default images for each type.
Template:Mbox Template:Mbox Template:Mbox Template:Mbox Template:Mbox Template:Mbox Template:Mbox Template:Mbox Template:Mbox
Parameters
List of all parameters:
{{mbox | type = critical / serious / warning / notice / / move / protection | image = none / [[File:...|40px|...]] | imagewidth = width of image section / default is 52px | imageright = [[File:...|40px|...]] | imagerightwidth = width of right image section / default is 52px | style = CSS values | textstyle = CSS values | text = The message body text. | small = {{{small|}}} / left | smallimage = none / [[File:...|20px|...]] | smallimageright = none / [[File:...|20px|...]] | smalltext = A shorter message body text. }}
type
- If no type parameter is given the template has a 'blank' style.
image
- No parameter = If no image parameter is given the template uses a default image. Which default image it uses depends on the type parameter.
- An image = Should be an image with usual wiki notation. Widths of 40px - 50px are usually about right. (Images over 52 pixels wide will cause padding problems, unless you also set imagewidth.)
- Often an icon is purely decorative in the W3C sense that it repeats the text. To improve accessibility, it is desirable to not have it be announced by screen readers, as well as to avoid it linking to an irrelevant page. If (and only if) the image license allows this, it can be marked with "Template:ParaTemplate:Para". For example:
image = [[File:Unbalanced scales.svg|40px|link=|alt=]]
- Conversely, an icon that does not use "Template:ParaTemplate:Para", and which therefore is announced to visually impaired readers, should use an "Template:Para" parameter that describes the icon. With no Template:Para parameter (using the default link), the alt text should describe the icon's visual appearance. For example:
image = [[File:Gnome globe current event.svg|40px|alt=Clock over a larger globe]]
- With a nonempty "Template:Para" the alt text should describe the icon's function. For example:
image = [[File:Purple question mark.svg|40px|link=Special:Random|alt=Random article]]
- An icon whose license requires attribution may have alt text, but must keep the default link. Although public domain images do not require a link, many licenses do require one. Please see Purely decorative images for more information about licensing.
- Often an icon is purely decorative in the W3C sense that it repeats the text. To improve accessibility, it is desirable to not have it be announced by screen readers, as well as to avoid it linking to an irrelevant page. If (and only if) the image license allows this, it can be marked with "Template:ParaTemplate:Para". For example:
- none = Means that no image is used.
blank= This parameter is now deprecated. If you see it in use, change it to "image=none".
imagewidth
- Optional CS] value used to set width of image's div section. Allowing you to use images wider than the default 52px wide.
- Example
imagewidth=100px
imageright
- No parameter = If no imageright parameter is given then no image is shown on the right side.
- An image = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (Images over 52 pixels width will cause padding problems, unless you also set imagerightwidth.) For example:
imageright = File:Nuvola apps bookcase.png|40px|alt=Three stacked books
- Anything = Any other object that you want to show on the right side.
imagerightwidth
- Optional CSS value used to set width of image's div section. Allowing you to use images wider than the default 52px wide.
- Example
imagerightwidth=100px
style
- Optional CSS values used by the entire message box table. Without quotation marks
" "
but with the ending semicolons;
. For example:style = margin-bottom: 0.5em;
textstyle
- Optional CSS values used by the text cell. For example:
textstyle = text-align: center;
text
- The message body text.
The small parameters
The small article message boxes are meant for the top of sections. Normally they should only contain one or two lines of text.
small
- left = Makes it a smaller left aligned 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=left". To make it so your template also understands the small parameter you can use this code:
small = {{{small|}}}
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. 20px width is usually about right for boxes with one line of text, while 25px width is usually about right for boxes with two lines of text. For example:
smallimage = [[File:Ambox important.png|20px|alt=Clock over a larger globe]]
- none = Means that no image is used. This overrides any image fed to image, when "small=left".
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. 20px - 25px width is usually about right. For example:
smallimageright = [[File::Ambox important.png|20px|alt=Three stacked books]]
- 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=left".
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
If you need to use special characters in the text parameter then you need to escape them like this:
{{mbox | text = <div> Equal sign = and a start and end brace { } work fine as they are. But here is a pipe | and two end braces <nowiki>}}</nowiki>. And now a pipe and end braces <nowiki>|}}</nowiki>. </div> }}
The <div>
tags that surround the text in the example above are usually not needed. But if the text contains line breaks then sometimes we get weird line spacing. This especially happens when using vertical dotted lists. Then use the div tags to fix that.
This template uses CSS classes in Common.css for most of its looks, thus it is fully skinnable.
This template calls Template:Tl which holds most of the code for Template:Tl, while Template:Tl itself does parameter preprocessing.
Internally this meta-template uses HTML wikimarkup instead of wikimarkup for the table code. That is the usual way we make meta-templates since wikimarkup has several drawbacks. For instance it makes it harder to use parser functions and some special characters in parameters.