Difference between revisions of "Template:Mbox/doc"

From i3Detroit
Jump to: navigation, search
(Created page with "{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> This is the {{tl|mbox}} or '''message box''' meta-template. It is used to b...")
 
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
This is the {{tl|mbox}} or '''message box''' meta-template.
 
  
It is used to build ''message box'' templates such as {{tl|security}}. It offers several different colours, uses default images if no image parameter is given and it has some other features.
+
{{Mbox templates}}
 +
This is the {{Tl|Ambox}} or '''Article message box''' meta-template.
  
This meta-template uses the mbox CSS classes in [[MediaWiki:Common.css]]. The classes can also be used directly in a [[Help:Table|wikitable]] if special functionality is needed. See the [[w:Wikipedia:Ambox CSS classes|how-to guide]] for that.
+
It is used to build ''article message box'' templates such as {{tl|wikify}}. It offers several different colours, uses default images if no image parameter is given and it has some other features.
  
=== Usage ===
+
== Common parameters ==
 
+
The box on the right shows the most common parameters that are accepted by {{tl|ambox}}. The purpose of each is described below.
Simple usage example:
+
{| class="wikitable" align="right" style="background:transparent; width=40%"
 
+
!Common parameters
<pre>
+
|-
{{mbox | text = Some text.}}
+
|<pre style="font-size:90%; width=40%">
 +
{{Ambox
 +
| name  =
 +
| subst = <includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
 +
| small = {{{small|}}}
 +
| type  =  
 +
| image =
 +
| sect  = {{{1|}}}
 +
| issue =
 +
| talk  = {{{talk|}}}
 +
| fix  =
 +
| date  = {{{date|}}}
 +
| cat  =
 +
| all  =
 +
}}<noinclude>
 +
{{Documentation}}
 +
</noinclude>
 
</pre>
 
</pre>
 +
|}
  
{{mbox | text = Some text.}}
+
=== ''name'' ===
 +
The ''name'' parameter specifies the name of the template, without the Template namespace prefix. For example {{tl|Wikify}} specifies {{para|name|Wikify}}.
  
Complex example:
+
This parameter should be updated if the template is ever moved. The purpose of this parameter is twofold:
 
+
* If incorrectly substituted, it allows the meta-template to notify the name of the template which has been substituted, which may help editors to fix the problem.
<pre>
+
* It allows the template to have a more useful display on its template page, for example to show the date even when not specified, and to apply categorisation of the template itself.
{{mbox
+
| type      = style
+
| small      = left
+
| image      = [[File:Emblem-question-yellow.svg|40px|alt=Question mark]]
+
| smallimage = [[File:Emblem-question-yellow.svg|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.
+
}}
+
</pre>
+
 
+
{{mbox
+
| type      = style
+
| small      = left
+
| image      = [[File:Emblem-question-yellow.svg|40px|alt=Question mark]]
+
| smallimage = [[File:Emblem-question-yellow.svg|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.
+
=== ''subst'' ===
 +
The ''subst'' parameter allows the meta-template to detect whether the template has been incorrectly substituted, and give an appropriate warning. It will also add such pages to [[:Category:Pages with incorrectly substituted templates]]. Just copy the code exactly as it appears in the box.
  
=== Message box types ===
+
=== ''small'' ===
 +
The ''small'' parameter should be passed through the template, as this will allow editors to use the small format by specifying {{para|small|left}} on an article:
 +
{{ambox|nocat=true|small=left|text=This is the small left-aligned ambox format.}}
 +
Otherwise the standard format will be produced:
 +
{{ambox|nocat=true|text=This is the standard ambox format.}}
  
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type.
+
Other variations:
 +
* For templates which should ''never'' be small, specify {{para|small|no}} or do not pass the small parameter at all.
 +
* For templates which should ''always'' be small, just specify {{para|small|left}}.
 +
* For templates which should ''default to small'', try {{para|small|<nowiki>{{{small|left}}}</nowiki>}}. This will allow an editor to override by using {{para|small|no}} on an article.
  
{{mbox
+
=== ''type'' ===
| type  = critical
+
The ''type'' parameter defines the colour of the left bar, and the image that is used by default. The type is chosen not on aesthetics but is based on the type of issue that the template describes. The seven available types and their default images are shown below.
| text  = type=<u>critical</u> – Urgent warnings, such as {{tlx|XSS alert}}.
+
{{Ambox
 +
|nocat=true
 +
| type  = speedy
 +
| text  = type=<u>speedy</u> – Speedy deletion issues, such as {{tl|db-g1}} and {{tl|db-g3}}.
 
}}
 
}}
{{mbox
+
{{Ambox
| type  = important
+
|nocat=true
| text  = type=<u>important</u> – Serious problems, such as {{tl|delete}}.
+
| type  = delete
 +
| text  = type=<u>delete</u> – Deletion issues, such as {{tl|afd}} and {{tl|prod}}.
 
}}
 
}}
{{mbox
+
{{Ambox
| type  = warning
+
|nocat=true
| text  = type=<u>warning</u> – Other problems, such as {{tl|deprecated}}.
+
| type  = content
 +
| text  = type=<u>content</u> – Content issues, such as {{tl|POV}} and {{tl|globalize}}.
 
}}
 
}}
{{mbox
+
{{Ambox
| type  = caution
+
|nocat=true
| text  = type=<u>caution</u> – Points of concern, but not so serious, such as {{tl|description missing}} and {{tl|inuse}}.
+
| type  = style
 +
| text  = type=<u>style</u> – Style issues, such as {{tl|cleanup}} and {{tl|wikify}}.
 
}}
 
}}
{{mbox
+
{{ambox
 +
|nocat=true
 
| type  = notice
 
| type  = notice
| text  = type=<u>notice</u> – Points of information, such as {{tl|oldupgradenotes}}.
+
| text  = type=<u>notice</u> – Article notices, such as {{tl|current}} and {{tl|inuse}}.
 
}}
 
}}
{{mbox
+
{{Ambox
| type  =  
+
|nocat=true
| text  = type=<u>(blank)</u> – Default; general 'box'.
+
}}
+
{{mbox
+
 
| type  = move
 
| type  = move
| text  = type=<u>move</u> – Merge, split and transwiki proposals, such as {{tl|move}} and {{tl|MoveToCommons}}.
+
| text  = type=<u>move</u> – Merge, split and transwiki proposals, such as {{tl|split}} and {{tl|copy to wiktionary}}.
 
}}
 
}}
{{mbox
+
{{Ambox
 +
|nocat=true
 
| type  = protection
 
| type  = protection
| text  = type=<u>protection</u> – Protection notices..
+
| text  = type=<u>protection</u> – Protection notices, such as {{tl|pp-vandalism}} and {{tl|pp-semi-protected}}.
}}
+
{{mbox
+
| type  = license
+
| text  = type=<u>license</u> – License notices, such as {{tl|Free screenshot}}
+
 
}}
 
}}
  
=== Other images ===
+
If no ''type'' parameter is given the template defaults to {{para|type|notice}}.
  
The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the '''image''' parameter to specify an image other than the default images.
+
=== ''image'' ===
 +
You can choose a specific image to use for the template by using the ''image'' parameter. Images are specified using the standard syntax for inserting files in Wikipedia (see [[Wikipedia:Manual of Style/Images#How to place an image]].) Widths of 40-50px are typical. For example:
  
{{mbox
+
* {{tl|POV}} specifies {{para|image|<nowiki>[[File:Unbalanced scales.svg|40px|link=|alt=]]</nowiki>}} and looks like this:
| type  = warning
+
{{POV}}
| image = [[File:Unbalanced scales.svg|40px|link=|alt=]]
+
| text  = type = content <br> image = <nowiki>[[File:Unbalanced scales.svg|40px|link=|alt=]]</nowiki> <br> This image is often used for {{tl|POV}} and similar issues.
+
}}
+
{{mbox
+
| type  = notice
+
| image = [[File:Wikitext.svg|50px|link=|alt=]]
+
| text  = type = style <br> image = <nowiki>[[File:Wikitext.svg|50px|link=|alt=]]</nowiki> <br> This image is often used for {{tl|wikify}} etc.
+
}}
+
{{mbox
+
| type  = move
+
| image = [[File:Merge-arrows.svg|50px|link=|alt=]]
+
| text  = type = move <br> image = <nowiki>[[File:Merge-arrows.svg|50px|link=|alt=]]</nowiki> <br> This image is used for {{tl|merge}} etc.
+
}}
+
  
=== More examples ===
+
* {{tl|Wikify}} specifies {{para|image|<nowiki>[[File:Wikitext.svg|50px|link=|alt=]]</nowiki>}} and looks like this:
 +
{{Wikify}}
  
Some other parameter combinations.
+
Please note:
 +
* If no image is specified then the default image corresponding to the ''type'' is used. (See [[#type]] above.)
 +
* If {{para|image|none}} is specified, then no image is used and the text uses the whole message box area.
 +
* If an icon is [[Wikipedia:Alternative text for images#Purely decorative images|purely decorative]] and also in the [[Wikipedia:Image use policy#Public_domain|public domain]], [[Wikipedia:Accessibility|accessibility]] can be improved by suppressing the link to the file page by adding "{{para|link}}{{para|alt}}" as seen above.
  
{{mbox
+
=== ''sect'' ===
| text  = No type and no image given ('''default''')
+
Many article message templates begin with the text '''This article ...''' and it is often desirable that this wording change to '''This section ...''' if the template is used on a section instead. Other possibilities include '''This list ...''' and '''This biographical article ...'''
}}
+
{{mbox
+
| image = none
+
| text = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
+
}}
+
  
{{mbox
+
To facilitate this functionality, pass {{para|sect|<nowiki>{{{1|}}}</nowiki>}}. This will allow editors to type '''section''' as the first unnamed parameter of the template to change the wording. For example, {{tlx|Advert|section}} produces:
| image = [[File:Gnome globe current event.svg|42px|alt=Clock over a larger globe]]
+
{{Advert|section}}
| imageright = [[File:Nuvola apps bookcase.svg|40px|alt=Three stacked books]]
+
| text  = image = <nowiki>[[File:Gnome globe current event.svg|42px|alt=Clock over a larger globe]]</nowiki> <br> imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px|alt=Three stacked books]]</nowiki>
+
}}
+
  
{{mbox
+
If using this feature, be sure to remove the first two words ("This article") from the template's text, otherwise it will be duplicated.
| image = [[File:Gnome globe current event.svg|42px|alt=Clock over a larger globe]]
+
| imageright = [[File:Shuttle.svg|20px|link=|alt=]]
+
| text  = '''This article or section documents a current [[spaceflight]].'''
+
<br>Content may change as the mission progresses.
+
}}
+
  
=== Parameters ===
+
=== ''issue'' and ''fix'' ===
 +
The ''issue'' parameter is used to describe the issue with the article. Try to keep it short and to-the-point (approximately 10-20 words) and be sure to include a link to a relevant [[Wikipedia:Policies and guidelines|policy or guideline]].
  
List of all parameters:
+
The ''fix'' parameter contains some text which describes what should be done to improve the article. It may be longer than the text in ''issue'', but should not usually be more than two sentences.
  
<pre>
+
When the template is in its compact form (when placed inside {{tl|article issues}}) or small form (when using {{para|small|left}}), the ''issue'' is the only text that will be displayed. For example, {{tl|Citation style}} defines
{{mbox
+
* {{para|issue|<nowiki>This article '''has an unclear citation style'''.</nowiki>}}
| type  = critical / serious / warning / notice / / move / protection
+
* {{para|fix|<nowiki>The references used may be made clearer with a different or consistent style of [[Wikipedia:Citing sources|citation]], [[Wikipedia:Footnotes|footnoting]], or [[Wikipedia:External links|external linking]].</nowiki>}}
| 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.
+
}}
+
</pre>
+
  
'''type'''
+
When used stand-alone it produces the whole text:
:If no '''type''' parameter is given the template has a 'blank' style.
+
{{Citation style}}
  
'''image'''
+
But when used inside {{tl|article issues}} or with {{para|small|left}} it displays only the issue:
:'''No parameter''' = If no '''image''' parameter is given the template uses a default image. Which default image it uses depends on the '''type''' parameter.
+
{{Article issues|{{Citation style}}}}
:'''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.)
+
{{Citation style|small=left}}
:: Often an icon is [[Wikipedia:Alternative text for images #Purely decorative images|purely decorative]] in the W3C sense that it repeats the text. To improve [[Wikipedia:Accessibility|accessibility]], it is desirable to not have it be announced by [[screen reader]]s, 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 "{{para|link}}{{para|alt}}". For example:
+
:::<code><nowiki>image = [[File:Unbalanced scales.svg|40px|link=|alt=]]</nowiki></code>
+
:: Conversely, an icon that does not use "{{para|link}}{{para|alt}}", and which therefore is announced to visually impaired readers, should use an "{{para|alt|<var>[[Wikipedia:Alternative text for images|alt text]]</var>}}" parameter that describes the icon. With no {{para|link}} parameter (using the default link), the alt text should describe the icon's visual appearance. For example:
+
:::<code><nowiki>image = [[File:Gnome globe current event.svg|40px|alt=Clock over a larger globe]]</nowiki></code>
+
:: With a nonempty "{{para|link|<var>Page</var>}}" the alt text should describe the icon's function. For example:
+
:::<code><nowiki>image = [[File:Purple question mark.svg|40px|link=Special:Random|alt=Random article]]</nowiki></code>
+
:: 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 ''[[Wikipedia:Alternative text for images #Purely decorative images|Purely decorative images]]'' for more information about licensing.
+
:'''none''' = Means that no image is used.
+
:<s>'''blank'''</s> = This parameter is now deprecated. If you see it in use, change it to "image=none".
+
  
'''imagewidth'''
+
=== ''talk'' ===
:Optional [[w:Cascading Style Sheets|CSS]] value used to set width of image's div section.  Allowing you to use images wider than the default 52px wide.
+
Some article message templates include a link to the talk page, and allow an editor to specify a section heading to link directly to the relevant section. To achieve this functionality, simply pass the ''talk'' parameter through, i.e. {{para|talk|<nowiki>{{{talk|}}}</nowiki>}}
:'''Example'''
+
:: <code>imagewidth=100px</code>
+
  
'''imageright'''
+
This parameter may then be used by an editor as follows:
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side.
+
* {{para|talk|SECTION HEADING}} - the link will point to the specified section on the article's talk page, e.g. {{para|talk|Foo}}
:'''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:
+
* {{para|talk|FULL PAGE NAME}} - the template will link to the page specified (which may include a [[WP:ANCHOR|section anchor]]), e.g. {{para|talk|Talk:Banana#Foo}}
::<code><nowiki>imageright = [[File:Nuvola apps bookcase.png|40px|alt=Three stacked books]]</nowiki></code>
+
:'''Anything''' = Any other object that you want to show on the right side.
+
  
'''imagerightwidth'''
+
Notes:
:Optional [[w:Cascading Style Sheets|CSS]] value used to set width of image's div section.  Allowing you to use images wider than the default 52px wide.
+
* When this parameter is used by a template, the talk page link will appear on the template itself (in order to demonstrate the functionality) but this will only display on articles if the parameter is actually defined.
:'''Example'''
+
* In order to make sure there is always a link to the talk page, you can use {{para|talk|<nowiki>{{{talk|#}}}</nowiki>}}.
:: <code>imagerightwidth=100px</code>
+
* If the talk page does not exist, there will be no link, whatever the value of the parameter.
  
'''style'''
+
=== ''date'' ===
: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:
+
Passing the ''date'' parameter through to the meta-template means that the date that the article is tagged may be specified by an editor (or more commonly a [[WP:bot|bot]]). This will be displayed after the message in a smaller font.
::<code>style = margin-bottom: 0.5em;</code>
+
  
'''textstyle'''
+
Passing this parameter also enables [[:Category:Wikipedia maintenance categories sorted by month|monthly cleanup categorisation]] when the ''cat'' parameter is also defined.
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
+
::<code>textstyle = text-align: center;</code>
+
  
'''text'''
+
=== ''cat'' ===
:The message body text.
+
This parameter defines a monthly cleanup category. If {{para|cat|CATEGORY}} then:
 +
* articles will be placed in '''Category:CATEGORY from DATE''' if  {{para|date|DATE}} is specified.
 +
* articles will be placed in '''Category:CATEGORY''' if the date is not specified.
  
==== The small parameters ====
+
For example, {{tl|no footnotes}} specifies {{para|cat|Articles lacking in-text citations}} and so an article with the template {{tlx|No footnotes|2=date=June 2010}} will be placed in [[:Category:Articles lacking in-text citations from June 2010]].
  
The small article message boxes are meant for the top of sections. Normally they should only contain one or two lines of text.
+
=== ''all'' ===
 +
The ''all'' parameter defines a category into which all articles should be placed.
  
'''small'''
+
== Other parameters ==
:'''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:
+
The box on the right shows all possible parameters for this template. However it is not recommended to copy this, because it will never be required to use all parameters simultaneously.
::<code><nowiki>small = {{{small|}}}</nowiki></code>
+
{| class="wikitable" align="right" style="background:transparent; width=40%"
{{mbox
+
!All parameters
| small = left
+
|-
| text = small = left
+
|<pre style="font-size:90%; width=40%">
}}
+
{{Ambox
{{mbox
+
| name        =
| type = style
+
| subst      = <includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
| small = left
+
| small       = {{{small|}}}
| text = type = style <br> small = left
+
| type        =
}}
+
| image      =  
 +
| imageright  =  
 +
| smallimage  =  
 +
| smallimageright =
 +
| class      =
 +
| style      =
 +
| textstyle  =
 +
| sect        = {{{1|}}}
 +
| issue      =
 +
| talk        = {{{talk|}}}
 +
| fix        =  
 +
| date        = {{{date|}}}
 +
| text       =  
 +
| smalltext  =  
 +
| cat        =
 +
| all        =
 +
| cat2        =
 +
| all2        =
 +
| cat3        =
 +
| all3        =
 +
}}<noinclude>
 +
{{Documentation}}
 +
</noinclude>
 +
</pre>
 +
|}
  
'''smallimage'''
+
=== ''imageright'' ===
:'''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 on the right side of the message box may be specified using this parameter. The syntax is the same as for the ''image'' parameter, except that the default is no image.
:'''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:
+
::<code><nowiki>smallimage = [[File:Gnome globe current event.svg|20px|alt=Clock over a larger globe]]</nowiki></code>
+
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=left".
+
{{mbox
+
| small = left
+
| image      = [[File:Replacement filing cabinet.svg|50px|link=|alt=]]
+
| smallimage = [[File:Replacement filing cabinet.svg|25px|link=|alt=]]
+
| text =
+
small = left <br> image = <nowiki>[[File:Replacement filing cabinet.svg|50px|link=|alt=]]</nowiki> <br> smallimage = <nowiki>[[File:Replacement filing cabinet.svg|25px|link=|alt=]]</nowiki>
+
}}
+
  
'''smallimageright'''
+
=== ''smallimage'' and ''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.
+
Images for the small format box may be specified using these parameters. They will have no effect unless {{para|small|left}} is specified.
:'''An image''' = Should be an image with usual wiki notation. 20px - 25px width is usually about right. For example:
+
::<code><nowiki>smallimageright = [[File:Nuvola apps bookcase.png|20px|alt=Three stacked books]]</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=left".
+
{{mbox
+
| small = left
+
| imageright = [[File:Gnome globe current event.svg|50px|alt=Clock over a larger globe]]
+
| smallimageright = none
+
| text =
+
small = left <br> imageright = <nowiki>[[File:Gnome globe current event.svg|50px|alt=Clock over a larger globe]]</nowiki> <br> smallimageright = none
+
}}
+
  
'''smalltext'''
+
=== ''class'' ===
:A shorter version of the message body text. If no '''smalltext''' parameter is given then this template falls back to use the '''text''' parameter.
+
A custom [[Cascading Style Sheets|CSS]] class to apply to the box.
  
=== Technical details ===
+
=== ''style'' and ''textstyle'' ===
 +
Optional CSS values may be defined, without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>.
 +
* ''style'' specifies the style used by the entire message box table.
 +
* ''textstyle'' relates to the text cell.
  
If you need to use special characters in the text parameter then you need to escape them like this:
+
=== ''text'' and ''smalltext'' ===
 +
Instead of specifying the ''issue'' and the ''fix'' it is possible to use the ''text'' parameter instead.
  
 +
Customised text for the small format can be defined using ''smalltext''.
 +
 +
=== Additional categorisation parameters ===
 +
* ''cat2'' and ''cat3'' provide additional monthly categories; see [[#cat]].
 +
* ''all2'' and ''all3'' provide additional categories into which all articles are placed, just like [[#all]].
 +
 +
== Technical notes ==
 +
* This meta-template uses the ambox CSS classes in [[MediaWiki:Common.css]]. The classes can also be used directly in a [[Help:Table|wikitable]] if special functionality is needed. See the [[Wikipedia:Ambox CSS classes|how-to guide]] for that.
 +
* If you need to use special characters in the text parameter then you need to escape them like this:
 
<pre>
 
<pre>
{{mbox
+
{{Ambox
 
| text  = <div>
 
| text  = <div>
 
Equal sign = and a start and end brace { } work fine as they are.
 
Equal sign = and a start and end brace { } work fine as they are.
Line 253: Line 230:
 
}}
 
}}
 
</pre>
 
</pre>
 
+
{{Ambox
{{mbox
+
|nocat=true
 
| text  = <div>
 
| text  = <div>
 
Equal sign = and a start and end brace { } work fine as they are.
 
Equal sign = and a start and end brace { } work fine as they are.
Line 262: Line 239:
 
}}
 
}}
  
The <code>&lt;div></code> 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.
+
* The <code>&lt;div></code> 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 [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.
This template uses CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.
+
* This template calls {{Tl|Ambox/core}} or {{tl|ambox/small}} which holds most of the code for {{Tl|Ambox}}, while {{Tl|Ambox}} itself does parameter preprocessing.
 
+
* Internally this meta-template uses HTML markup instead of wikimarkup for the table code. That is the usual way meta-templates are made since wikimarkup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and some special characters in parameters.
This template calls {{tl|mbox/core}} which holds most of the code for {{tl|mbox}}, while {{tl|mbox}} itself does parameter preprocessing.
+
* 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:Ambox|talk page]] and the "See also" links below. Since this template works almost exactly like {{Tl|Tmbox}}, {{Tl|Imbox}}, {{Tl|Cmbox}} and {{Tl|Ombox}} their talk pages and related pages might also contain more details.
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 [[m:Help:ParserFunctions|parser functions]] and some special characters in parameters.
+
 
+
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:mbox|talk page]] and the "See also" links below.
+
 
+
=== See also ===
+
  
 +
== See also ==
 +
{{Mbox templates see also}}
 
Other pages:
 
Other pages:
* [[w:Wikipedia:Ambox CSS classes]] – Describes how to use the ambox CSS classes directly in [[Help:Table|wikitable]]s and [[w:HTML element#Tables|HTML tables]].
+
* [[Wikipedia:Ambox CSS classes]] – Describes how to use the ambox CSS classes directly in [[Help:Table|wikitable]]s and [[HTML element#Tables|HTML tables]].
* [[w:Wikipedia:Article message boxes]] – The style guideline for creating article message boxes.
+
* [[Wikipedia:Article message boxes]] – The style guideline for creating article message boxes.
* [[w:Wikipedia talk:Article message boxes]] – For discussion about these matters.
+
* [[Wikipedia talk:Article message boxes]] – For discussion about these matters.
  
<includeonly>
+
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
</includeonly>
+
[[Category:Article message templates|*]]
 +
[[Category:Wikipedia metatemplates]]
 +
[[Category:Exclude in print]]
 +
 
 +
[[ar:قالب:صندوق رم]]
 +
[[arz:Template:Ambox]]
 +
[[as:Template:Ambox]]
 +
[[az:Şablon:Ambox]]
 +
[[bg:Шаблон:Ambox]]
 +
[[be:Шаблон:Ambox]]
 +
[[be-x-old:Шаблён:Паведамленьне]]
 +
[[bn:টেমপ্লেট:Ambox]]
 +
[[bs:Šablon:Ambox]]
 +
[[ca:Plantilla:Metacaixa d'avís article]]
 +
[[da:Skabelon:Hønsedesign]]
 +
[[dsb:Pśedłoga:Ambox]]
 +
[[es:Plantilla:Metaplantilla de avisos]]
 +
[[eo:Ŝablono:ArtikolaMesaĝokesto]]
 +
[[fa:الگو:Ambox]]
 +
[[fr:Modèle:Méta bandeau d'avertissement]]
 +
[[ko:틀:알림 상자]]
 +
[[hsb:Předłoha:Ambox]]
 +
[[hy:Կաղապար:Ambox]]
 +
[[id:Templat:Ambox]]
 +
[[is:Snið:Skilaboð]]
 +
[[it:Template:Avviso]]
 +
[[ka:თარგი:Ambox]]
 +
[[lv:Veidne:Ambox]]
 +
[[mk:Шаблон:Ambox]]
 +
[[mn:Загвар:Ambox]]
 +
[[no:Mal:Ambox]]
 +
[[ja:Template:Ambox]]
 +
[[pl:Szablon:Ambox]]
 +
[[pt:Predefinição:Ambox]]
 +
[[ro:Format:meta-casetă]]
 +
[[ru:Template:Ambox]]
 +
[[sc:Template:Ambox]]
 +
[[simple:Template:Ambox]]
 +
[[sk:Šablóna:Ambox]]
 +
[[sl:Predloga:Opozorilno polje]]
 +
[[sv:Mall:Ambox]]
 +
[[fi:Malline:Viestipohja]]
 +
[[th:แม่แบบ:Ambox]]
 +
[[tr:Şablon:Mikutusu]]
 +
[[uk:Шаблон:Ambox]]
 +
[[ur:Template:Ambox]]
 +
[[vi:Tiêu bản:Hộp thông báo]]
 +
[[zh-yue:Template:Ambox]]
 +
[[zh:Template:Ambox]]
 +
}}</includeonly>

Revision as of 15:31, 9 August 2012


This is the {{Ambox}} or Article message box meta-template.

It is used to build article message box templates such as {{wikify}}. It offers several different colours, uses default images if no image parameter is given and it has some other features.

Common parameters

The box on the right shows the most common parameters that are accepted by {{ambox}}. The purpose of each is described below.

Common parameters
{{Ambox
| name  = 
| subst = <includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
| small = {{{small|}}}
| type  = 
| image = 
| sect  = {{{1|}}}
| issue = 
| talk  = {{{talk|}}}
| fix   = 
| date  = {{{date|}}}
| cat   = 
| all   = 
}}<noinclude>
{{Documentation}}
</noinclude>

name

The name parameter specifies the name of the template, without the Template namespace prefix. For example {{Wikify}} specifies |name=Wikify.

This parameter should be updated if the template is ever moved. The purpose of this parameter is twofold:

  • If incorrectly substituted, it allows the meta-template to notify the name of the template which has been substituted, which may help editors to fix the problem.
  • It allows the template to have a more useful display on its template page, for example to show the date even when not specified, and to apply categorisation of the template itself.

subst

The subst parameter allows the meta-template to detect whether the template has been incorrectly substituted, and give an appropriate warning. It will also add such pages to Category:Pages with incorrectly substituted templates. Just copy the code exactly as it appears in the box.

small

The small parameter should be passed through the template, as this will allow editors to use the small format by specifying |small=left on an article:

Otherwise the standard format will be produced:

Other variations:

  • For templates which should never be small, specify |small=no or do not pass the small parameter at all.
  • For templates which should always be small, just specify |small=left.
  • For templates which should default to small, try |small={{{small|left}}}. This will allow an editor to override by using |small=no on an article.

type

The type parameter defines the colour of the left bar, and the image that is used by default. The type is chosen not on aesthetics but is based on the type of issue that the template describes. The seven available types and their default images are shown below.

If no type parameter is given the template defaults to |type=notice.

image

You can choose a specific image to use for the template by using the image parameter. Images are specified using the standard syntax for inserting files in Wikipedia (see Wikipedia:Manual of Style/Images#How to place an image.) Widths of 40-50px are typical. For example:

  • {{POV}} specifies |image=[[File:Unbalanced scales.svg|40px|link=|alt=]] and looks like this:
  • {{Wikify}} specifies |image=[[File:Wikitext.svg|50px|link=|alt=]] and looks like this:

Please note:

  • If no image is specified then the default image corresponding to the type is used. (See #type above.)
  • If |image=none is specified, then no image is used and the text uses the whole message box area.
  • If an icon is purely decorative and also in the public domain, accessibility can be improved by suppressing the link to the file page by adding "|link=|alt=" as seen above.

sect

Many article message templates begin with the text This article ... and it is often desirable that this wording change to This section ... if the template is used on a section instead. Other possibilities include This list ... and This biographical article ...

To facilitate this functionality, pass |sect={{{1|}}}. This will allow editors to type section as the first unnamed parameter of the template to change the wording. For example, {{Advert|section}} produces:

If using this feature, be sure to remove the first two words ("This article") from the template's text, otherwise it will be duplicated.

issue and fix

The issue parameter is used to describe the issue with the article. Try to keep it short and to-the-point (approximately 10-20 words) and be sure to include a link to a relevant policy or guideline.

The fix parameter contains some text which describes what should be done to improve the article. It may be longer than the text in issue, but should not usually be more than two sentences.

When the template is in its compact form (when placed inside {{article issues}}) or small form (when using |small=left), the issue is the only text that will be displayed. For example, {{Citation style}} defines

  • |issue=This article '''has an unclear citation style'''.
  • |fix=The references used may be made clearer with a different or consistent style of [[Wikipedia:Citing sources|citation]], [[Wikipedia:Footnotes|footnoting]], or [[Wikipedia:External links|external linking]].

When used stand-alone it produces the whole text:

But when used inside {{article issues}} or with |small=left it displays only the issue:

talk

Some article message templates include a link to the talk page, and allow an editor to specify a section heading to link directly to the relevant section. To achieve this functionality, simply pass the talk parameter through, i.e. |talk={{{talk|}}}

This parameter may then be used by an editor as follows:

  • |talk=SECTION HEADING - the link will point to the specified section on the article's talk page, e.g. |talk=Foo
  • |talk=FULL PAGE NAME - the template will link to the page specified (which may include a section anchor), e.g. |talk=Talk:Banana#Foo

Notes:

  • When this parameter is used by a template, the talk page link will appear on the template itself (in order to demonstrate the functionality) but this will only display on articles if the parameter is actually defined.
  • In order to make sure there is always a link to the talk page, you can use |talk={{{talk|#}}}.
  • If the talk page does not exist, there will be no link, whatever the value of the parameter.

date

Passing the date parameter through to the meta-template means that the date that the article is tagged may be specified by an editor (or more commonly a bot). This will be displayed after the message in a smaller font.

Passing this parameter also enables monthly cleanup categorisation when the cat parameter is also defined.

cat

This parameter defines a monthly cleanup category. If |cat=CATEGORY then:

  • articles will be placed in Category:CATEGORY from DATE if |date=DATE is specified.
  • articles will be placed in Category:CATEGORY if the date is not specified.

For example, {{no footnotes}} specifies |cat=Articles lacking in-text citations and so an article with the template {{No footnotes|date=June 2010}} will be placed in Category:Articles lacking in-text citations from June 2010.

all

The all parameter defines a category into which all articles should be placed.

Other parameters

The box on the right shows all possible parameters for this template. However it is not recommended to copy this, because it will never be required to use all parameters simultaneously.

All parameters
{{Ambox
| name        = 
| subst       = <includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
| small       = {{{small|}}}
| type        = 
| image       = 
| imageright  = 
| smallimage  = 
| smallimageright = 
| class       = 
| style       = 
| textstyle   = 
| sect        = {{{1|}}}
| issue       = 
| talk        = {{{talk|}}}
| fix         = 
| date        = {{{date|}}}
| text        = 
| smalltext   = 
| cat         = 
| all         = 
| cat2        = 
| all2        = 
| cat3        = 
| all3        = 
}}<noinclude>
{{Documentation}}
</noinclude>

imageright

An image on the right side of the message box may be specified using this parameter. The syntax is the same as for the image parameter, except that the default is no image.

smallimage and smallimageright

Images for the small format box may be specified using these parameters. They will have no effect unless |small=left is specified.

class

A custom CSS class to apply to the box.

style and textstyle

Optional CSS values may be defined, without quotation marks " " but with the ending semicolons ;.

  • style specifies the style used by the entire message box table.
  • textstyle relates to the text cell.

text and smalltext

Instead of specifying the issue and the fix it is possible to use the text parameter instead.

Customised text for the small format can be defined using smalltext.

Additional categorisation parameters

  • cat2 and cat3 provide additional monthly categories; see #cat.
  • all2 and all3 provide additional categories into which all articles are placed, just like #all.

Technical notes

  • This meta-template uses the ambox CSS classes in MediaWiki:Common.css. The classes can also be used directly in a wikitable if special functionality is needed. See the how-to guide for that.
  • If you need to use special characters in the text parameter then you need to escape them like this:
{{Ambox
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are.
But here is a pipe &#124; 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 MediaWiki:Common.css for most of its looks, thus it is fully skinnable.
  • This template calls {{Ambox/core}} or {{ambox/small}} which holds most of the code for {{Ambox}}, while {{Ambox}} itself does parameter preprocessing.
  • Internally this meta-template uses HTML markup instead of wikimarkup for the table code. That is the usual way meta-templates are made since wikimarkup has several drawbacks. For instance it makes it harder to use parser functions and some special characters in parameters.
  • 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 talk page and the "See also" links below. Since this template works almost exactly like {{Tmbox}}, {{Imbox}}, {{Cmbox}} and {{Ombox}} their talk pages and related pages might also contain more details.

See also

There are several meta-templates in the mbox family:

  • {{ambox}} – For article message boxes.
  • {{cmbox}} – For category message boxes.
  • {{imbox}} – For file (image) page message boxes.
  • {{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.
  • {{ombox}} – For other pages message boxes.
  • {{tmbox}} – For talk page message boxes.

Closely related meta-templates:

  • {{asbox}} – For article stub message boxes.
  • {{dmbox}} – For disambiguation and set index message boxes.
  • {{fmbox}} – For header and footer message boxes.


Other pages: