Template:Ambox/doc

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.

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.

Usage
Simple usage example:

Complex example:

But you are not really supposed to use red bold italic text.

Article message box types
The following examples use different type parameters but use no image parameters thus they use the default images for each type.

Other images
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.

More examples
Some other parameter combinations.

Parameters
List of all parameters:

subst 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

type
 * If no type parameter is given the template defaults to type notice. That means it gets a blue side bar.

image
 * No parameter = If no image parameter is given the template uses a default image. Which default image it uses depends on the type parameter.
 * An image = Should be an image with usual wiki notation. Widths of 40px - 50px are usually about right. (Images over 52 pixels wide will cause padding problems.)
 * Often an icon is purely decorative in the W3C sense that it repeats the text. To improve accessibility, it is desirable to not have it be announced by screen readers, as well as to avoid it linking to an irrelevant page. If (and only if) the image license allows this, it can be marked with "linkalt". For example:
 * Conversely, an icon that does not use "linkalt", and which therefore is announced to visually impaired readers, should use an "alt text" parameter that describes the icon. With no link parameter (using the default link), the alt text should describe the icon's visual appearance. For example:
 * With a nonempty "Page" the alt text should describe the icon's function. For example:
 * An icon whose license requires attribution may have alt text, but must keep the default link. Although public domain images do not require a link, many licenses do require one. Please see Purely decorative images for more information about licensing.
 * none = Means that no image is used.
 * blank = This parameter is now deprecated. If you see it in use, change it to "image=none".
 * An icon whose license requires attribution may have alt text, but must keep the default link. Although public domain images do not require a link, many licenses do require one. Please see Purely decorative images for more information about licensing.
 * none = Means that no image is used.
 * blank = This parameter is now deprecated. If you see it in use, change it to "image=none".

imageright
 * No parameter = If no imageright parameter is given then no image is shown on the right side.
 * An image = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (Images over 52 pixels width will cause padding problems.) For example:
 * Anything = Any other object that you want to show on the right side.
 * Anything = Any other object that you want to show on the right side.

style
 * Optional CSS values used by the entire message box table. Without quotation marks  but with the ending semicolons  . For example:

textstyle
 * Optional CSS values used by the text cell. For example:

text

Categorisation parameters

 * date= - pass through the date parameter when using monthly cleanup categories
 * category / cat - prefix for monthly categories, e.g. Wikipedia articles needing style editing
 * preposition - preposition between category name and month; the default is from
 * all - category which all articles will be placed in, e.g. All articles needing style editing

The small parameters
The small article message boxes are meant for the top of sections. Normally they should only contain one or two lines of text.

small
 * left = Makes it a smaller left aligned message box. This also makes the default images smaller. Note that any data fed to the smallimage, smallimageright and smalltext parameters is only used if "small=left". To make it so your template also understands the small parameter you can use this code:


 * any other value, including blank and no parameter = Default-sized inlined message box. Ignores smallimage, smallimageright and smalltext.

smallimage
 * No parameter = If no smallimage parameter is given then this template falls back to use the image parameter. If the image parameter also is empty then a small default image is used.
 * An image = Should be an image with usual wiki notation. 20px width is usually about right for boxes with one line of text, while 25px width is usually about right for boxes with two lines of text. For example:
 * none = Means that no image is used. This overrides any image fed to image, when "small=left".
 * none = Means that no image is used. This overrides any image fed to image, when "small=left".

smallimageright
 * No parameter = If no smallimageright parameter is given then this template falls back to use the imageright parameter. If the imageright parameter also is empty then no image is shown on the right side.
 * An image = Should be an image with usual wiki notation. 20px - 25px width is usually about right. For example:
 * 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".
 * none = Means that no right side image is used. This overrides any image fed to imageright, when "small=left".

smalltext
 * A shorter version of the message body text. If no smalltext parameter is given then this template falls back to use the text parameter.

Technical details
If you need to use special characters in the text parameter then you need to escape them like this:

&lt;/nowiki>. And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki>. }}

. And now a pipe and end braces |}}. }}

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 Ambox/core 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 we make meta-templates since wikimarkup has several drawbacks. For instance it makes it harder to use parser functions and some special characters in parameters.

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.