Template:Mbox/doc: Difference between revisions

ArrowHead294 (talk | contribs)
Make documentation page
 
Ganaram inukshuk (talk | contribs)
Usage: removed unused params
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{dochead}}
{{Dochead|header=metatemplate}}{{Wikipedia}}{{templatestyles}}
The '''Mbox''' template is a metatemplate which is used to create message boxes which are placed at the top of a page. It is intended to be used in other templates for messages which are expected to be used on multiple pages.
 
=== Usage ===
=== Usage ===
The template accepts three parameters:
The template accepts the following parameters:
* <code>type</code>: Choose between <span style="color: #B32424">''delete''</span>, <span style="color: #F28500">''content''</span>, <span style="color: #FFCC33">''style''</span>, <span style="color: #3366CC">''notice''</span>, <span style="color: DarkOrchid">''move''</span> and <span style="color: #A2A9B1">''protection''</span>. Defaults to <span style="color: #3366CC">''notice''</span>. The type defines the color of the left border; the type should be chosen according to context, not for aesthetic reasons.
* <code>type</code>: Defines the color of the left border; the type should be chosen according to context, not for aesthetic reasons. Types are described in the next section.
* <code>text</code>: Message to be displayed in the box.
* <code>text</code>: Message to be displayed in the box.
* <code>icon</code>: Icon to be displayed in the box, if provided. Icons appear on the left side of the message box.
* <code>icon</code>: Icon to be displayed in the box, if provided. Icons appear on the left side of the message box.
* <code>icon size</code>: Size of the icon displayed. Default is 60px.
{{clear}}
=== Types and examples ===
{{Mbox|text=Messagebox of '''delete''' type. Typically used for pages whose content is deprecated or to be deleted.|type=delete}}
{{Mbox|text=Messagebox of '''content''' type. Typically used for pages whose content requires verification or rewriting.|type=content}}
{{Mbox|text=Messagebox of '''style''' type. Typically used for pages whose writing deviates from the wiki's standards.|type=style}}
{{Mbox|text=Messagebox of '''ready''' type. Used to denote wiki features (such as templates) that are ready for use.|type=ready}}
{{Mbox|text=Messagebox of '''notice''' type. Used to denote general notices. Most messageboxes are of this type.|type=notice}}
{{Mbox|text=Messagebox of '''move''' type. Denotes pages that are to be moved.|type=move}}
{{Mbox|text=Messagebox of '''protection''' type. Denotes pages that are protected from editing.|type=protection}}
=== See also ===
* [[Template: Alert]]