Template:Ambox/doc

Documentation

[purge]

An article message box, or ambox, can be added to notify users of specific messages regarding the article. The {{cleanup}} template is an example of an ambox.

Usage

{{Ambox
| background =
| color = 
| icon = 
| sound = 
| quote = 
| subject = 
| optional = 
| footnote = 
}}

Example

{{Ambox
| color = orange
| icon = Icon-stub.png{{!}}48px
| sound = C'Thun, the Shattered Play 02.mp3
| quote = My awakening brings upon a new age.
| subject = This subject of article/section.
| optional = This is optimal supplementary text.
| footnote = Value information what to do now. For example [[Template:Ambox/doc|improve]] the documentation.
}}

Result

TemplateData

No description.

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
Background	background	Defines the background color. Example #fdf0d9	String	suggested
Color	color	Defines the highlight color. Example orange	String	suggested
icon	icon	Places an image on the left of the message box. Must include size. Example Stub.png{{!}}48px	File	suggested
format	format	Image format, alternative use if no size is included. Example tiny	File	suggested
Sound	sound	A soundfile that fits the theme. Example Imp Patron Play 01.mp3	File	suggested
Quote	quote	Soundfile's quote.	String	suggested
Subject	subject type	The main topic this message is about.	String	required
Optional	optional info	Some optional text that may or may not be used.	String	suggested
Foornote	footnote	Some space for a small sized foot note.	String	suggested

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.