Difference between revisions of "Template:Ambox/doc"
KimPegasus (talk | contribs) (Created page with "An ambox, short for '''a'''rticle '''m'''essage '''box''', is a metatemplate (a template that is used by other templates) for messaging templates in the main article namespace...") |
KimPegasus (talk | contribs) m (Not stub, actually.) |
||
| Line 1: | Line 1: | ||
| − | An ambox, short for '''a'''rticle '''m'''essage '''box''', is a metatemplate (a template that is used by other templates) for messaging templates in the main article namespace. Examples of common amboxes include {{[[:Template: | + | An ambox, short for '''a'''rticle '''m'''essage '''box''', is a metatemplate (a template that is used by other templates) for messaging templates in the main article namespace. Examples of common amboxes include {{[[:Template:Merge|merge]]}}, {{[[:Template:Cleanup|cleanup]]}}, and {{[[:Template:Unreferenced|unreferenced]]}}. |
== Usage == | == Usage == | ||
Latest revision as of 01:15, 4 October 2020
An ambox, short for article message box, is a metatemplate (a template that is used by other templates) for messaging templates in the main article namespace. Examples of common amboxes include {{merge}}, {{cleanup}}, and {{unreferenced}}.
Usage[edit source]
Amboxes should never be used directly within an article. Instead, it should be used to create templates appropriate to the need.
Amboxes accept these parameters:
classes - Additional CSS classes to apply to the ambox. Most commonly used to apply color themes.
date - The date the ambox was added to the page. Preferably in YYYY-MM-DD format.
icon - An image file to display within the ambox. The surrounding wikicode and File: prefix are not required, only the image's filename.
message - The text the ambox displays. This is unformatted text by default, allowing templates to bold, italicise and add links where useful.
section - Whether this ambox only applies to a section, rather than at the top of an article page. This is a boolean property. If it evaluates to true, a smaller, left-aligned variant of the ambox will be used. It is false by default.