Template:Ambox/doc

This is the Ambox ([A]rticle [m]essage [box]) metatemplate.

It is used to build article message box templates such as Underlinked. It offers several different colours, uses default images if no image parameter is given, and has 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.

name
The name parameter specifies the name of the template, without the Template namespace prefix. For example Underlinked specifies 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 left on an article:

Otherwise the standard format will be produced:

Other variations:
 * For templates which should never be small, specify no or do not pass the small parameter at all.
 * For templates which should always be small, just specify left.
 * For templates which should default to small, try small. This will allow an editor to override by using no on an article.

See, below, for 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 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 Manual of Style/Images.) Widths of 40-50px are typical. For example:


 * POV specifies Unbalanced scales.svg and looks like this:


 * underlinked specifies Ambox wikify.svg and looks like this:

Please note:
 * If no image is specified then the default image corresponding to the type is used. (See above.)
 * If 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 "linkalt" 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: list, table, "In popular culture" material, etc.

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

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

, and this is recommended. The following ready-to-use code:

enables the following:
 * Any positive value that can detect will be used with the named parameter in the ambox-based template to get "section" instead of "article": y, 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, list, 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:

(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 left), the issue is the only text that will be displayed. For example, Citation style defines

When used stand-alone it produces the whole text:

But when used inside Multiple issues or with 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

This parameter may then be used by an editor as follows:
 * SECTION HEADING - the link will point to the specified section on the article's talk page, e.g. Foo
 * FULL PAGE NAME - the template will link to the page specified (which may include a section anchor), e.g. 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.
 * 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 CATEGORY then:
 * articles will be placed in Category:CATEGORY from DATE if DATE is specified.
 * articles will be placed in Category:CATEGORY if the date is not specified.

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

The cat parameter should not be linked, nor should the prefix  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  be used.

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.

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 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.
 * all2 and all3 provide additional categories into which all articles are placed, just like.

Technical notes
&lt;/nowiki>. And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki>. }} . And now a pipe and end braces |}}. }}
 * 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:


 * The  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.

Ver também
Other pages:
 * Ambox CSS classes – Describes how to use the ambox CSS classes directly in wikitables and HTML tables.
 * Article message boxes – The style guideline for creating article message boxes.
 * Wikipedia talk:Article message boxes – For discussion about these matters.