Template:Ambox/doc
Basic usage
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 =
}}
Full usage
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.
| 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 =
}}
|
Common parameters
name
The name parameter specifies the name of the template, without the Template namespace prefix. For example Template:Tl specifies Template:Para.
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. 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 Template:Para on an article: Template:Ambox/small Otherwise the standard format will be produced:
 | This is the standard Ambox format. |
Other variations:
- For templates which should never be small, specify Template:Para or do not pass the small parameter at all.
- For templates which should always be small, just specify Template:Para.
- For templates which should default to small, try Template:Para. This will allow an editor to override by using Template:Para on an article.
To use a small box that adjusts its width to match the text, use Template:Para and Template:Para together: Template:Ambox/small
See Template:Section link below for more information on how to limit Template:Para 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.
 | type=speedy – Speedy deletion issues, such as Template:Tl and Template:Tl. |
 | type=delete – Deletion issues, such as Template:Tl and Template:Tl. |
 | type=content – Content issues, such as Template:Tl and Template:Tl. |
| type=style – Style issues, such as Template:Tl and Template:Tl. |
| type=notice – Article notices, such as Template:Tl and Template:Tl. |
| type=move – Merge, split and transwiki proposals, such as Template:Tl and Template:Tl. |
 | type=protection – Protection notices, such as Template:Tl and Template:Tl. |
If no type parameter is given the template defaults to Template:Para.
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:
- Template:Tl specifies Template:Para and looks like this:
- Template:Tl specifies Template:Para 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 Template:Para 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 "Template:ParaTemplate:Para" 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: Template:Para, Template:Para, Template:Para, etc.
A common way to facilitate this functionality is to pass Template:Para. This will allow editors to type section, for example, as the first unnamed parameter of the template to change the wording. For example, Template:Tlx produces: Template:Advert Another approach is to pass Template:Para to provide a named value. Another is to use Template:Tlx to parse the value for a positive, and pass Template:Para if true.
Template:Em, and this is recommended. The following ready-to-use code: Template:Block indent enables the following:
- Any positive value that Template:Tlx can detect will be used with the named parameter in the ambox-based template to get "section" instead of "article": Template:Para, Template:Para, etc. It is recommended to allow both Template:Para and Template:Para 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": Template:Para, Template:Para, Template:Para, Template:Para, etc.
It is also advisable to restrict use of the Template:Para 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: Template:Block indent (In this case, any value of Template:Para or Template:Para will trigger the small, left display, as long as some value of Template:Para 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 Template:Tl) or small form (when using Template:Para), the issue is the only text that will be displayed. For example, Template:Tl defines
- <syntaxhighlight lang="text" inline>|issue=This article has an unclear citation style.</syntaxhighlight>
- <syntaxhighlight lang="text" inline>|fix=The references used may be made clearer with a different or consistent style of citation, footnoting, or external linking.</syntaxhighlight>
When used stand-alone it produces the whole text: Template:Citation style
But when used inside Template:Tl or with Template:Para it displays only the issue: Template:Multiple issues Template:Citation style
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. Template:Para
This parameter may then be used by an editor as follows:
- Template:Para – the link will point to the specified section on the article's talk page, e.g. Template:Para
- Template:Para – the template will link to the page specified (which may include a section anchor), e.g. Template:Para
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 Template:Para.
- 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 Template:Tl.
removalnotice
If you specify Template:Para, 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 Template:Tl.
cat
This parameter defines a monthly cleanup category. If Template:Para then:
- articles will be placed in Category:CATEGORY from DATE if Template:Para is specified.
- articles will be placed in Category:CATEGORY if the date is not specified.
For example, Template:Tl specifies Template:Para and so an article with the template Template:Tlx 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.
Additional parameters
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 Template:Para 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 Template:Para.
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
- If you need to use special characters in the text parameter then you need to escape them like this:
<syntaxhighlight lang="xml">
| Equal sign = and a start and end brace { } work fine as they are. But here is a pipe | and two end braces }}. And now a pipe and end braces |}}. |
</syntaxhighlight>
| Equal sign = and a start and end brace { } work fine as they are. But here is a pipe | and two end braces }}. And now a pipe and end braces |}}. |
- 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. - 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 Template:Tl, Template:Tl, Template:Tl and Template:Tl their talk pages and related pages might also contain more details.
TemplateData
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Template Name | name | The name parameter specifies the name of the template, without the Template namespace prefix. | String | optional |
| subst | subst | no description | Unknown | optional |
| Small Mode | 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.
| String | optional |
| type | type | no description | Unknown | optional |
| image | image | no description | Unknown | optional |
| sect | sect | no description | Unknown | optional |
| issue | issue | no description | Unknown | optional |
| fix | fix | no description | Unknown | optional |
| talk | talk | no description | Unknown | optional |
| date | date | no description | Unknown | optional |
| 1 | 1 | no description | Unknown | optional |
| info | info | no description | Unknown | optional |
| removalnotice | removalnotice | no description | Unknown | optional |
| cat | cat | no description | Unknown | optional |
| all | all | no description | Unknown | optional |
| imageright | imageright | no description | Unknown | optional |
| class | class | no description | Unknown | optional |
| text | text | no description | Unknown | optional |
| plainlinks | plainlinks | no description | Unknown | optional |
| smallimage | smallimage | no description | Unknown | optional |
| smallimageright | smallimageright | no description | Unknown | optional |
| textstyle | textstyle | no description | Unknown | optional |
| style | style | no description | Unknown | optional |
| smalltext | smalltext | no description | Unknown | optional |
| cat2 | cat2 | no description | Unknown | optional |
| cat3 | cat3 | no description | Unknown | optional |
| all2 | all2 | no description | Unknown | optional |
| all3 | all3 | no description | Unknown | optional |
See also
- Wikipedia:Manual of Style/Article message boxes – The historical style guideline for creating article message boxes.
