Template:Message box/doc: Difference between revisions
No edit summary |
No edit summary |
||
Line 3: | Line 3: | ||
This template is used to create standardised message boxes. It is most often used as the base for various types of [[:Category:Notice templates|notice templates]]. | This template is used to create standardised message boxes. It is most often used as the base for various types of [[:Category:Notice templates|notice templates]]. | ||
__TOC__ | |||
==Usage== | ==Usage== | ||
Line 16: | Line 18: | ||
|text = | |text = | ||
}}</pre> | }}</pre> | ||
===Parameters=== | |||
{| class="wikitable" | |||
! Parameter !! Description | |||
|- | |||
| <code>type</code> | |||
| Determines the colors of the message box. See {{section link||Type}} for details. | |||
|- | |||
| <code>full</code> | |||
| Set this option to <code>yes</code> to expand the message box to the full width of the page. This is used primarily for [[:Category:Editnotice templates|editnotice templates]]. | |||
|- | |||
| <code>class</code> | |||
| Additional CSS classes applied to the message box | |||
|- | |||
| <code>style</code> | |||
| Inline CSS styles applied to the message box | |||
|- | |||
| <code>image</code> | |||
| If passed the name of an image file, it will be displayed as an icon with a standard width. If passed a file link, it will be displayed as given. | |||
|- | |||
| <code>title</code> | |||
| The title displayed at the top of the message box | |||
|- | |||
| <code>text</code> | |||
| The text displayed after the title | |||
|} | |||
===Type=== | ===Type=== | ||
Line 87: | Line 115: | ||
}} | }} | ||
|- | |- | ||
| style="text-align: center;" | | | style="text-align: center;" | (default) | ||
| {{Message box | | {{Message box | ||
|image = Nuvola apps bookcase.svg | |image = Nuvola apps bookcase.svg |
Revision as of 15:09, 19 June 2023
This subpage provides documentation for Template:Message box.
This template is used to create standardised message boxes. It is most often used as the base for various types of notice templates.
Usage
All parameters are optional.
{{Message box |type = |full = |class = |style = |image = |title = |text = }}
Parameters
Parameter | Description |
---|---|
type
|
Determines the colors of the message box. See § Type for details. |
full
|
Set this option to yes to expand the message box to the full width of the page. This is used primarily for editnotice templates.
|
class
|
Additional CSS classes applied to the message box |
style
|
Inline CSS styles applied to the message box |
image
|
If passed the name of an image file, it will be displayed as an icon with a standard width. If passed a file link, it will be displayed as given. |
title
|
The title displayed at the top of the message box |
text
|
The text displayed after the title |
Type
The type
parameter determines the colors of the message box.
Type | Example |
---|---|
warning
|
This is an example of a warning notice. This type of notice should only be used for warnings that demand editors' attention. |
action
|
This is an example of an action notice. This type of notice is used to convey critical information about actions that should be taken by editors. |
content
|
This is an example of a content notice. This type of notice is typically used to provide editing instructions about the contents of a page. |
style
|
This is an example of a style notice. This type of notice is typically used to provide editing notes related to style. |
info
|
This is an example of an info notice. This type of notice is used to convey important information to readers or editors. |
proposal
|
This is an example of a proposal notice. This type of notice is typically used for editing proposals. |
lock
|
This is an example of a lock notice. This type of notice can be used for edit protection notices. It is sometimes also used to give readers historical context. |
legal
|
This is an example of a legal notice. This type of notice is typically used to display licensing and copyright information. |
(default) | This is an example of a generic notice. This type of notice can be used to provide readers or editors with supplementary information. |