Template:Mbox/doc: Difference between revisions
No edit summary |
→Usage: removed unused params |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{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. | 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 | The template accepts the following parameters: | ||
* <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>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. | * <code>icon size</code>: Size of the icon displayed. Default is 60px. | ||
{{clear}} | {{clear}} | ||
=== Types and examples === | === 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 '''delete''' type. Typically used for pages whose content is deprecated or to be deleted.|type=delete}} | ||
| Line 27: | Line 25: | ||
{{Mbox|text=Messagebox of '''protection''' type. Denotes pages that are protected from editing.|type=protection}} | {{Mbox|text=Messagebox of '''protection''' type. Denotes pages that are protected from editing.|type=protection}} | ||
=== See also === | |||
* [[Template: Alert]] | |||