From Settlement AtWork Wiki
Jump to: navigation, search
[edit] [purge] Template documentation

This template grabbed from here: http://en.wikipedia.org/wiki/Template:Ambox


This template is one of 8 broad template of templates for wiki-maintenance. This template supports alert messages that are placed on wiki pages alerting users of a concern, upcoming change, or suggested modification to be made to the page.

It is used to build article message box templates such as {{draft}} etc. 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.


  • Activate SVG viewing
  • Many others to do:
    • ambox (t)
    • tmbox (t)
    • imbox (t)
    • cmbox (t)
    • ombox (t)
    • mbox (t)
    • fmbox (t)
    • dmbox (t)


Simple usage example:

{{ambox | text = Some text.}}

Complex example:

| type      = style
| image     = [[Image:Emblem-question-yellow.svg.png|40px]]
| style     = width: 400px; 
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body 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.


Some other parameter combinations.


List of all parameters:

| type  = delete / content / style / notice / move / protection
| image = none / blank / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = CSS values
| textstyle = CSS values
| text  = The message body text. 


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


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. 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:
image = [[Image:Unbalanced scales.svg|40px]]
none = Means that no image is used.
blank = Means that no image is used but an empty area the same size as a default image is used, which means that text in the message box gets aligned well with other article message boxes. (See the "special" examples above.)


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:
imageright = [[Image:Nuvola apps bookcase.png|40px]]
Anything = Any other object that you want to show on the right side.


Optional CSS values used by the entire message box table. Without quotation marks " " but with the ending semicolons ;. For example:
style = margin-bottom: 0.5em;


Optional CSS values used by the text cell. For example:
textstyle = text-align: center;


The message body text.

Technical details

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

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

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.

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 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 links below. Since this template works almost exactly like {{tmbox}}, {{cmbox}} and {{ombox}} their talk pages and related pages might also contain more details.

For more information, go to: http://en.wikipedia.org/wiki/Template:Ambox

The above documentation is transcluded from Template:Ambox/doc. (edit | history)
Editors can experiment in this template's sandbox (create) and testcases (create) pages.
Please add categories and interwikis to the /doc subpage. Subpages of this template.