Difference between revisions of "Template:Ambox/doc"

From blackwiki
Jump to navigation Jump to search
m (396 revisions imported)
 
(174 intermediate revisions by 88 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!-- Please add categories to the /doc subpage, and interwikis at Wikidata (see Wikipedia:Wikidata) -->
{{mbox templates}}
+
{{High-risk| 1350227 |all-pages = yes}}
This is the {{tl|ambox}} or '''article message box''' meta-template.
+
{{Lua|Module:Message box}}
 +
{{Mbox templates (small)}}
  
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.
+
{{tl|Ambox}} stands for '''A'''rticle '''m'''essage '''box''' which is a [[Help:Metatemplating|metatemplate]]. It is used to build message boxes for templates used in '''articles''', such as {{tl|Underlinked}}. It offers several different colours, images and some other features.
 
 
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.
 
 
 
=== Usage ===
 
Simple usage example:
 
  
 +
== Common parameters ==
 +
The box below shows the most common parameters that are accepted by {{Tl|Ambox}}. The purpose of each is described below.
 
<pre>
 
<pre>
{{ambox | text = Some text.}}
+
{{Ambox
 +
| name  =  
 +
| subst = <includeonly>{{subst:substcheck}}</includeonly>
 +
| small = {{{small|}}}
 +
| type  =
 +
| image =
 +
| sect  = {{{1|}}}
 +
| issue =
 +
| talk  = {{{talk|}}}
 +
| fix  =
 +
| date  = {{{date|}}}
 +
| cat  =
 +
| all  =
 +
}}
 
</pre>
 
</pre>
  
{{ambox | text = Some text.}}
+
=== ''name'' ===
 +
The ''name'' parameter specifies the name of the template, without the Template namespace prefix. For example {{Tl|Underlinked}} specifies {{Para|name|Underlinked}}.
  
Complex example:
+
This parameter should be updated if the template is ever moved. The purpose of this parameter is twofold:
 +
* If incorrectly [[Wikipedia:Substitution|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.
  
<pre>
+
=== ''subst'' ===
{{ambox
+
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.
| subst     = <includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
+
 
| type      = style
+
=== ''small'' ===
| small      = left
+
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:
| image      = [[File:Emblem-question-yellow.svg|40px|alt=Question mark]]
+
{{Ambox|nocat=true|small=left|text=This is the small left-aligned Ambox format.}}
| smallimage = [[File:Emblem-question-yellow.svg|20px|alt=Question mark]]
+
Otherwise the standard format will be produced:
| textstyle  = color: red; font-weight: bold; font-style: italic;
+
{{Ambox|nocat=true|text=This is the standard Ambox format.}}
| text      = Text for a big box, for the top of articles.
 
| smalltext  = Text for the top of article sections.
 
| category  = A name of a category to use for monthly categories
 
| date      = {{{date|}}}
 
| all        = A category which all articles will be placed in
 
}}
 
</pre>
 
  
{{ambox
+
Other variations:
| type      = style
+
* For templates which should ''never'' be small, specify {{Para|small|no}} or do not pass the small parameter at all.
| small     = left
+
* For templates which should ''always'' be small, just specify {{Para|small|left}}.
| image      = [[File:Emblem-question-yellow.svg|40px|alt=Question mark]]
+
* 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.
| 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.
+
To use a small box that adjusts its width to match the text, use {{para|style|width: auto; margin-right: 0px;}} and {{para|textstyle|width: auto;}} together:
 +
{{Ambox|nocat=true|small=left|style=width: auto; margin-right: 0px;|textstyle=width: auto; margin-right: 0px;|text=This is the small left-aligned Ambox format with flexible width.}}
  
=== Article message box types ===
+
See {{section link||sect}} below for more information on how to limit {{para|small}} display to cases when the template is being used for a section instead of the whole article (recommended, to prevent inconsistent top-of-article display).
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type.
 
  
{{ambox
+
=== ''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.
 +
{{Ambox
 +
|nocat=true
 
| type  = speedy
 
| type  = speedy
 
| text  = type=<u>speedy</u> – Speedy deletion issues, such as {{tl|db-g1}} and {{tl|db-g3}}.
 
| text  = type=<u>speedy</u> – Speedy deletion issues, such as {{tl|db-g1}} and {{tl|db-g3}}.
 
}}
 
}}
{{ambox
+
{{Ambox
 +
|nocat=true
 
| type  = delete
 
| type  = delete
| text  = type=<u>delete</u> – Deletion issues, such as {{tl|afd}} and {{tl|prod}}.
+
| text  = type=<u>delete</u> – Deletion issues, such as {{tl|article for deletion}} and {{tl|proposed deletion}}.
 
}}
 
}}
{{ambox
+
{{Ambox
 +
|nocat=true
 
| type  = content
 
| type  = content
 
| text  = type=<u>content</u> – Content issues, such as {{tl|POV}} and {{tl|globalize}}.
 
| text  = type=<u>content</u> – Content issues, such as {{tl|POV}} and {{tl|globalize}}.
 
}}
 
}}
{{ambox
+
{{Ambox
 +
|nocat=true
 
| type  = style
 
| type  = style
| text  = type=<u>style</u> – Style issues, such as {{tl|cleanup}} and {{tl|wikify}}.
+
| text  = type=<u>style</u> – Style issues, such as {{tl|cleanup}} and {{tl|underlinked}}.
 
}}
 
}}
 
{{ambox
 
{{ambox
 +
|nocat=true
 
| type  = notice
 
| type  = notice
| text  = type=<u>notice</u> – Article notices, such as {{tl|current}} and {{tl|inuse}}.
+
| text  = type=<u>notice</u> – Article notices, such as {{tl|current}} and {{tl|in use}}.
 
}}
 
}}
{{ambox
+
{{Ambox
 +
|nocat=true
 
| type  = move
 
| type  = move
| text  = type=<u>move</u> – Merge, split and transwiki proposals, such as {{tl|split}} and {{tl|copy to wiktionary}}.
+
| text  = type=<u>move</u> – Merge, split and transwiki proposals, such as {{tl|split}} and {{tl|copy to Wiktionary}}.
 
}}
 
}}
{{ambox
+
{{Ambox
 +
|nocat=true
 
| type  = protection
 
| type  = protection
| text  = type=<u>protection</u> – Protection notices, such as {{tl|pp-vandalism}} and {{tl|pp-semi-protected}}.
+
| text  = type=<u>protection</u> – Protection notices, such as {{tl|pp-vandalism}} and {{tl|pp-protected}}.
 
}}
 
}}
  
=== 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:
 +
 
 +
* {{Tl|POV}} specifies {{Para|image|<nowiki>[[File:Unbalanced scales.svg|40px|link=|alt=]]</nowiki>}} and looks like this:
 +
{{POV|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
 +
 
 +
* {{tl|underlinked}} specifies {{para|image|<nowiki>[[File:Ambox wikify.svg|50x40px|link=|alt=]]</nowiki>}} and looks like this:
 +
{{underlinked|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
  
{{ambox
+
Please note:
| type  = content
+
* If no image is specified then the default image corresponding to the ''type'' is used. (See [[#type]] above.)
| image = [[File:Unbalanced scales.svg|40px|link=|alt=]]
+
* If {{para|image|none}} is specified, then no image is used and the text uses the whole message box area.
| 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.
+
* 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:Manual of Style/Accessibility|accessibility]] can be improved by suppressing the link to the file page by adding "{{para|link}}{{para|alt}}" as seen above.
}}
+
 
{{ambox
+
=== ''sect'' ===
| type  = style
+
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. The value of this parameter will replace the word "article". Various possibilities for use include: {{para|sect|list}}, {{para|sect|table}}, {{para|sect|"In popular culture" material}}, etc.
| 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.
+
{{em|If using this feature, be sure to remove the first two words ("This article") from the template's text, otherwise it will be duplicated.}}
}}
+
 
{{ambox
+
A common way to facilitate this functionality is to pass {{para|sect|<nowiki>{{{1|}}}</nowiki>}}. This will allow editors to type <kbd>section</kbd>, for example, as the first unnamed parameter of the template to change the wording. For example, {{tlx|Advert|section}} produces:
| type  = move
+
{{Advert|section|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
| image = [[File:Merge-arrows.svg|50px|link=|alt=]]
+
Another approach is to pass {{para|sect|<nowiki>{{{section|{{{sect|}}}}}}</nowiki>}} to provide a named value. Another is to use {{tlx|Yesno}} to parse the value for a positive, and pass {{para|sect|section}} if true.
| text  = type = move <br> image = <nowiki>[[File:Merge-arrows.svg|50px|link=|alt=]]</nowiki> <br> This image is used for {{tl|merge}} etc.
+
 
}}
+
{{em|These approaches can be combined}}, and this is recommended. The following ready-to-use code:
 +
{{block indent|1=<code><nowiki>| sect  = {{#ifeq:{{yesno|def=|1={{{sect|{{{section}}}}}} }}|yes|section|{{{sect|{{{section|{{{1|}}}}}}}}} }}</nowiki></code>}}
 +
enables the following:
 +
* Any positive value that {{tlx|Yesno}} can detect will be used with the named parameter in the ambox-based template to get "section" instead of "article": {{para|section|y}}, {{para|sect|True}}, etc.  It is recommended to allow both {{para|sect}} and {{para|section}} so that editors do not have to guess which one will work. The sample code above does this for you.
 +
* Any other value passed, in any manner, will replace "article": {{para||section and its subsections}}, {{para|1|list}}, {{para|sect|section}}, {{para|section|table}}, etc.
 +
 
 +
It is also advisable to restrict use of the {{para|small}} parameter so that it is made contingent upon the template being applied to a section (or whatever) rather than the whole article, to prevent the small version of the template being used at the top of the article where it would be inconsistent with other article-wide cleanup/dispute banners:
 +
{{block indent|1=<code><nowiki>| small = {{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}} }}</nowiki></code>}}
 +
(In this case, any value of {{para|small}} or {{para|left}} will trigger the small, left display, as long as some value of {{para|sect}} or one of its aliases in that template has also been provided.) This code can be copy-pasted and used with the above code block. See, e.g., [[Template:Trivia]] and its [[Template:Trivia/testcases]] to observe the combined functionality.
 +
 
 +
=== ''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]].
 +
 
 +
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.
  
=== More examples ===
+
When the template is in its compact form (when placed inside {{tl|multiple 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
Some other parameter combinations.
+
* <code>|issue=<nowiki>This article '''has an unclear citation style'''.</nowiki></code>
 +
* <code>|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></code>
  
{{ambox
+
When used stand-alone it produces the whole text:
| text  = No type and no image given ('''default''')
+
{{Citation style|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
}}
 
{{ambox
 
| image = none
 
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
 
}}
 
  
{{ambox
+
But when used inside {{Tl|Multiple issues}} or with {{Para|small|left}} it displays only the issue:
| image = [[File:Gnome globe current event.svg|42px|alt=Clock over a larger globe]]
+
{{Multiple issues <!-- Even though there's only one "issue", please don't remove this {{Multiple issues}} template. It is a demonstration of the formatting. --> |{{Citation style|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}}}
| imageright = [[File:Nuvola apps bookcase.svg|40px|alt=Three stacked books]]
+
{{Citation style|small=left|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
| 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>
 
}}
 
  
{{ambox
+
=== ''talk'' ===
| image = [[File:Gnome globe current event.svg|42px|alt=Clock over a larger globe]]
+
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>}}
| 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 ===
+
This parameter may then be used by an editor as follows:
List of all parameters:
+
* {{para|talk|SECTION HEADING}} – the link will point to the specified section on the article's talk page, e.g. {{para|talk|Foo}}
 +
* {{para|talk|FULL PAGE NAME}} – the template will link to the page specified (which may include a [[Help:Link#Section linking (anchors)|section anchor]]), e.g. {{para|talk|Talk:Banana#Foo}}
  
<pre>
+
Notes:
{{ambox
+
* 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.
| name        = Name of template without the Template: part
+
* In order to make sure there is always a link to the talk page, you can use {{para|talk|<nowiki>{{{talk|#}}}</nowiki>}}.
| subst      = <includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
+
* If the talk page does not exist, there will be no link, whatever the value of the parameter.
| type        = speedy / delete / content / style / notice / move / protection
 
| image      = none / [[File:...|40px|...]]
 
| imageright  = [[File:...|40px|...]]
 
| class      = A custom CSS class to apply to the box
 
| 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.
 
| category    = Prefix for monthly categories
 
| preposition = Preposition between category name and month (defaults to "from")
 
| date        = {{{date|}}}
 
| all        = Category which all articles will be placed in, if any
 
}}
 
</pre>
 
  
'''subst'''
+
=== ''date'' ===
This should be used in order to detect when the template has been incorrectly substituted. Such pages will be placed in [[:Category:Pages with incorrectly substituted templates]]
+
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 [[Wikipedia:Bots|bot]]). This will be displayed after the message in a smaller font.
  
'''type'''
+
Passing this parameter also enables [[:Category:Wikipedia maintenance categories sorted by month|monthly cleanup categorisation]] when the ''cat'' parameter is also defined.
:If no '''type''' parameter is given the template defaults to type '''notice'''. That means it gets a blue side bar.
 
  
'''image'''
+
=== ''info'' ===
:'''No parameter''' = If no '''image''' parameter is given the template uses a default image. Which default image it uses depends on the '''type''' parameter.
+
This parameter is for specifying additional information. Whatever you add here will appear after the date, and will not be displayed if the template is being wrapped in {{tl|multiple issues}}.
:'''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.)
 
:: 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".
 
  
'''imageright'''
+
=== ''removalnotice'' ===
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side.
+
If you specify {{para|removalnotice|yes}}, then the following notice will be displayed after the date and after the ''info'' text:
:'''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.) For example:
+
* <small>[[Help:Maintenance template removal|Learn how and when to remove this template message]].</small>
::<code><nowiki>imageright = [[File:Nuvola apps bookcase.png|40px|alt=Three stacked books]]</nowiki></code>
+
This will not be displayed if the template is being wrapped in {{tl|multiple issues}}.
:'''Anything''' = Any other object that you want to show on the right side.
 
  
'''style'''
+
=== ''cat'' ===
: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:
+
This parameter defines a monthly cleanup category. If {{para|cat|CATEGORY}} then:
::<code>style = margin-bottom: 0.5em;</code>
+
* 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.
  
'''textstyle'''
+
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]].
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
 
::<code>textstyle = text-align: center;</code>
 
  
'''text'''
+
The ''cat'' parameter should not be linked, nor should the prefix <code>Category:</code> be used.
  
==== Categorisation parameters ====
+
=== ''all'' ===
*'''category''' - prefix for monthly categories, e.g. ''Wikipedia articles needing style editing''
+
The ''all'' parameter defines a category into which all articles should be placed.
*'''preposition''' - preposition between category name and month; the default is ''from''
 
*'''date'''= {{{date|}}} - pass through the date parameter when using monthly cleanup categories
 
*'''all''' - category which all articles will be placed in, e.g. ''All articles needing style editing''
 
  
==== The small parameters ====
+
The ''all'' parameter should not be linked, nor should the prefix <code>Category:</code> be used.
The small article message boxes are meant for the top of sections. Normally they should only contain one or two lines of text.
 
  
'''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:
+
{| class="wikitable" align="right" style="background:transparent; width=25%;"
::<code><nowiki>small = {{{small|}}}</nowiki></code>
+
!All parameters
{{ambox
+
|-
| small = left
+
|<pre style="font-size:85%">
| text = small = left
+
{{Ambox
}}
+
| name        =
{{ambox
+
| subst      = <includeonly>{{subst:substcheck}}</includeonly>
| type = style
+
| small       = {{{small|}}}
| small = left
+
| type        =  
| text = type = style <br> small = left
+
| image      =  
}}
+
| imageright  =  
:'''any other value, including blank and no parameter''' = Default-sized inlined message box. Ignores '''smallimage''', '''smallimageright''' and '''smalltext'''.
+
| smallimage  =  
'''smallimage'''
+
| smallimageright =  
:'''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.
+
| class      =  
:'''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:
+
| style      =  
::<code><nowiki>smallimage = [[File:Gnome globe current event.svg|20px|alt=Clock over a larger globe]]</nowiki></code>
+
| textstyle  =  
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=left".
+
| sect        = {{{1|}}}
{{ambox
+
| issue      =  
| small = left
+
| talk        = {{{talk|}}}
| image      = [[File:Replacement filing cabinet.svg|50px|link=|alt=]]
+
| fix        =  
| smallimage = [[File:Replacement filing cabinet.svg|25px|link=|alt=]]
+
| date        = {{{date|}}}
| text =
+
| 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>
+
| smalltext  =  
 +
| plainlinks  = no
 +
| removalnotice =
 +
| cat        =  
 +
| all        =  
 +
| cat2        =  
 +
| all2        =  
 +
| cat3        =  
 +
| all3        =  
 
}}
 
}}
 +
</pre>
 +
|}
 +
 +
The "All parameters" box 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.
 +
 +
=== ''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 {{para|small|left}} is specified.
 +
 +
=== ''class'' ===
 +
Custom [[Cascading Style Sheets|CSS]] classes to apply to the box. If adding multiple classes, they should be space-separated.
 +
 +
=== ''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. This can be used to do things such as modifying the width of the box.
 +
* ''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.
  
'''smallimageright'''
+
Customised text for the small format can be defined using ''smalltext''.
:'''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:
 
::<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".
 
{{ambox
 
| 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'''
+
=== ''plainlinks'' ===
:A shorter version of the message body text. If no '''smalltext''' parameter is given then this template falls back to use the '''text''' parameter.
+
Normally on Wikipedia, external links have an arrow icon next to them, like this: [http://www.example.com Example.com]. However, in message boxes, the arrow icon is suppressed by default, like this: <span class="plainlinks">[http://www.example.com Example.com]</span>. To get the normal style of external link with the arrow icon, use {{para|plainlinks|no}}.
  
=== Technical details ===
+
=== ''cat2'', ''cat3'', ''all2'', and ''all3'' ===
If you need to use special characters in the text parameter then you need to escape them like this:
+
* ''cat2'' and ''cat3'' provide for additional monthly categories; see [[#cat]].
 +
* ''all2'' and ''all3'' provide for 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 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>
{{ambox
+
{{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 246: Line 256:
 
}}
 
}}
 
</pre>
 
</pre>
 
+
{{Ambox
{{ambox
+
|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 255: Line 265:
 
}}
 
}}
  
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 calls [[Module:Message box]] 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.
 +
* 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.
  
This template uses CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.
+
== Mbox family ==
 
 
This template calls {{tl|ambox/core}} 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 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: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.
 
 
 
=== See also ===
 
 
{{Mbox templates see also}}
 
{{Mbox templates see also}}
  
Other pages:
+
== See also ==
* [[Wikipedia:Ambox CSS classes]] – Describes how to use the ambox CSS classes directly in [[Help:Table|wikitable]]s and [[HTML element#Tables|HTML tables]].
+
* [[Wikipedia:Ambox CSS classes|Wikipedia:Ambox CSS classes]] – Describes how to use the ambox CSS classes directly in [[Help:Table|wikitables]] and [[HTML element#Tables|HTML tables]].
* [[Wikipedia:Article message boxes]] – The style guideline for creating article message boxes.
+
* [[Wikipedia:Article message boxes|Wikipedia:Article message boxes]] – The style guideline for creating article message boxes.
* [[Wikipedia talk:Article message boxes]] – For discussion about these matters.
+
* [[Wikipedia talk:Article message boxes|Wikipedia talk:Article message boxes]] – For discussion about these matters.
 
 
<includeonly>
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
[[Category:Wikipedia metatemplates|Ambox]]
 
[[Category:Exclude in print|{{PAGENAME}}]]
 
  
[[ar:قالب:صندوق رم]]
+
<includeonly>{{sandbox other||
[[arz:Template:Ambox]]
+
<!-- Add categories below this line, and interwikis at Wikidata -->
[[az:Şablon:Ambox]]
+
[[Category:Article message templates| ]]
[[bg:Шаблон:Ambox]]
+
[[Category:Mbox and messagebox templates]]
[[be:Шаблон:Ambox]]
+
[[Category:Exclude in print]]
[[be-x-old:Шаблён:Паведамленьне]]
+
}}</includeonly>
[[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]]
 
[[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>
 

Latest revision as of 13:18, 20 October 2020

Message box
meta-templates
templatecontext
{{Ambox}}article
{{Cmbox}}category
{{Imbox}}image
{{Tmbox}}talk
{{Fmbox}}footer / header
{{Ombox}}other pages
{{Mbox}}auto-detect
{{Asbox}}article stub
{{Dmbox}}disambiguation

{{Ambox}} stands for Article message box which is a metatemplate. It is used to build message boxes for templates used in articles, such as {{Underlinked}}. It offers several different colours, images and some other features.

Common parameters

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

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

name

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

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.

To use a small box that adjusts its width to match the text, use |style=width: auto; margin-right: 0px; and |textstyle=width: auto; together:

See Script error: No such module "Section link". below for more information on how to limit |small= display to cases when the template is being used for a section instead of the whole article (recommended, to prevent inconsistent top-of-article display).

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:

Template:POV

  • {{underlinked}} specifies |image=[[File:Ambox wikify.svg|50x40px|link=|alt=]] and looks like this:

Template:Underlinked

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. The value of this parameter will replace the word "article". Various possibilities for use include: |sect=list, |sect=table, |sect="In popular culture" material, etc.

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

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

Another approach is to pass |sect={{{section|{{{sect|}}}}}} to provide a named value. Another is to use {{Yesno}} to parse the value for a positive, and pass |sect=section if true.

These approaches can be combined, and this is recommended. The following ready-to-use code:

| sect = {{#ifeq:{{yesno|def=|1={{{sect|{{{section}}}}}} }}|yes|section|{{{sect|{{{section|{{{1|}}}}}}}}} }}

enables the following:

  • Any positive value that {{Yesno}} can detect will be used with the named parameter in the ambox-based template to get "section" instead of "article": |section=y, |sect=True, etc. It is recommended to allow both |sect= and |section= so that editors do not have to guess which one will work. The sample code above does this for you.
  • Any other value passed, in any manner, will replace "article": |section and its subsections, |1=list, |sect=section, |section=table, etc.

It is also advisable to restrict use of the |small= parameter so that it is made contingent upon the template being applied to a section (or whatever) rather than the whole article, to prevent the small version of the template being used at the top of the article where it would be inconsistent with other article-wide cleanup/dispute banners:

| small = {{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}} }}

(In this case, any value of |small= or |left= will trigger the small, left display, as long as some value of |sect= or one of its aliases in that template has also been provided.) This code can be copy-pasted and used with the above code block. See, e.g., Template:Trivia and its Template:Trivia/testcases to observe the combined functionality.

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 {{multiple 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 {{Multiple issues}} or with |small=left it displays only the issue: Template:Multiple issues

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.

info

This parameter is for specifying additional information. Whatever you add here will appear after the date, and will not be displayed if the template is being wrapped in {{multiple issues}}.

removalnotice

If you specify |removalnotice=yes, then the following notice will be displayed after the date and after the info text:

This will not be displayed if the template is being wrapped in {{multiple issues}}.

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.

The cat parameter should not be linked, nor should the prefix Category: be used.

all

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

The all parameter should not be linked, nor should the prefix Category: be used.

Other parameters

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

The "All parameters" box 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.

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

Custom CSS classes to apply to the box. If adding multiple classes, they should be space-separated.

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. This can be used to do things such as modifying the width of the box.
  • 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.

plainlinks

Normally on Wikipedia, external links have an arrow icon next to them, like this: Example.com. However, in message boxes, the arrow icon is suppressed by default, like this: Example.com. To get the normal style of external link with the arrow icon, use |plainlinks=no.

cat2, cat3, all2, and all3

  • cat2 and cat3 provide for additional monthly categories; see #cat.
  • all2 and all3 provide for 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 Module:Message box 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.

Mbox family

There are seven metatemplates in the Module:Message box family:
  • {{Ambox}}, for messageboxes on article pages.
  • {{Cmbox}}, for messageboxes on category pages.
  • {{Imbox}}, for messageboxes on file (image) pages.
  • {{Tmbox}}, for messageboxes on talk pages.
  • {{Fmbox}}, for header and footer messageboxes.
  • {{Ombox}}, for messageboxes on other types of page.
  • {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.

Closely related metatemplates:

  • {{Asbox}}, for messageboxes in article stubs.
  • {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
  • {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.

Templates intended to be used in conjunction with Mboxes:

See also