Template:Ambox/doc
This is a documentation subpage for Template:Ambox. It contains usage information, categories and other content or metadata that is not part of the original template. |
{{Ambox}} stands for Article message box. This template is used in many pages.
History
This template is a derived work. It is, however, NOT exactly the same as Wikipedia's template of the same name! All CSS has been integrated into the template, and therefore some features are not available. However it is still a very useful template!
Usage instructions
Example to display a notice:
{{Ambox | type = notice | text = Hello world! }}
The code above should return:
Hello world! |
There are lots more examples of ambox use on the Wiki labels page.
type
Amboxes are divided into various types. Each type should have a corresponding colour code. The colour-coding helps to inform of the severity of the issues at a glance, so you can use the following parameters to change the colour of your ambox.
|type= danger , deletion and other serious warnings, concerns, and serious issues such as {{Delete}} and {{Delete proposal}} |
|type= warning , important concerns and notes, major issues such as {{Delete proposal}} |
|type= caution , recommended operations, moderate to fairly major issues, such as {{Cleanup}} |
|type= detail , minor to fairly moderate issues such as {{OutOfDate}} |
|type= proposal , move, transwiki and copy to Wikimedia Commons proposals such as {{Move}} |
|type= protection , page is protected against edits. |
|type= notice , general notices and minor issues such as {{Stub}} |
|type= approval , done operations such as {{Cleaned}} |
|type= info , information that is directly part of the article |
Stacked
To display multiple boxes stacked on top of each other (without anything else between them), you may set the optional stacked=
parameter to any non-empty value for all successive occurrences of the box (except the first one), as in the examples above.
imageright
You can display a modified additional small image (icon) on the right hand side of the box by passing an 'imageright' parameter with an image reference. For example:
imageright = [[File:Broom icon.svg|40px|link=WikiProject Cleanup]]
(This adds the little sweeping broom icon on the right which you see on Template:Cleanup)
See also
- {{Merge}} – warning & proposal to for merging two different article pages
- {{Wfmessage}} – "webpage flow message" based on the style of the homepage
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
language | lang | message language
| Line | optional |
small | small | no description | Unknown | optional |
Stacked | stacked | Set to any non-empty value if you want to display multiple boxes on top of each other (without anything else between them).
| Line | optional |
Message type | type | Amboxes are divided into various types. Each type should have a corresponding colour code. The colour-coding helps to inform of the severity of the issues at a glance.
| Line | suggested |
style | style | no description | Unknown | optional |
Image | image | Icon to be displayed in message box. | File | optional |
textstyle | textstyle | no description | Unknown | optional |
edit | edit | no description | Unknown | optional |
Message text | text | Text of message. | Content | required |
imageright | imageright | no description | Unknown | optional |
imagerightwidth | imagerightwidth | no description | Unknown | optional |