Template:Ambox/doc

File:Template-info.png Documentation

[purge]

"Ambox" is an abbreviation for Article message box. You can use amboxes in articles to indicate something important about the current page, often in the header.

Premade amboxes

Problem notice amboxes

These amboxes are used temporarily to notify other editors and visitors about a problem with an article. These amboxes support the following parameters:

• |tiny=: If set to yes, the box will have less padding and the icon will be much smaller than default.
• |class=: Any additional CSS classes to add to the ambox container element.
• |date=: The date the ambox was added to the page.
• |nocat=: If set to yes, no category will be added to the page. Use this only when creating documentation.

Note: Premade amboxes need the base {{Ambox}} template to work.

Code	Result
{{Cleanup}}
{{Delete}}
{{Merge|Example}}
{{Move|Example}}
{{Split|Example}} {{Split|Example 1|Example 2|Example 3}}
{{Stub}}

Informational amboxes

These amboxes are intended as permanent fixtures to a page, to notify visitors about some piece of information relevant to the page. These amboxes support the following parameters in addition to any listed:

• |tiny=, if set to Yes the image will be much smaller than default
• |class=, any additional classes to add to the ambox container

Code	Additional parameters	Result
{{Spoiler warning}}
{{No direct use}}
{{Uses Lua}}	|1=, a comma-separated list of modules used

Optional parameters

You can use optional parameters to further customize a premade ambox. The example below is using tiny=yes and date=01/01/2021.

Creating a custom ambox

You can create additional ambox templates as needed using the following parameters:

{{Ambox
| color = The left border color.
| icon = The icon image to be displayed.
| title = The optional title.
| message = The explanation text displayed.
| tiny = If you want the tiny version of the ambox, fill the parameter with "yes".
| date = An optional date of creation for the message.
| class = An optional CSS class for the ambox.
}}

Dependencies

For this template to work properly, you need the following:

• .ambox and any related classes, found in MediaWiki:Common.css.