Template:Mbox/doc: Difference between revisions
More actions
use {{TemplateBox}}; "textalign" parameter changed to "textstyle" |
|||
| Line 1: | Line 1: | ||
{{ | {{TemplateBox | ||
|1 = text | |||
|1d-en = The text to be displayed. | |||
|1label = <!-- A (very) brief name for the parameter. --> | |||
|1aliases = <!-- List of aliases, separated by / (a slash) --> | |||
|1type = string/line | |||
|1def = <!-- default value for the parameter --> | |||
|1stat = <!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample --> | |||
= | |2 = type | ||
|2d-en = Changes the color depending on the message needed. Each has its own preset image. | |||
|2label = <!-- A (very) brief name for the parameter. --> | |||
|2aliases = <!-- List of aliases, separated by / (a slash) --> | |||
|2type = string | |||
|2def = notice | |||
|2stat = <!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample --> | |||
|3 = image | |||
|3d-en = Override the image ("none" for no image). | |||
|3label = <!-- A (very) brief name for the parameter. --> | |||
|3aliases = <!-- List of aliases, separated by / (a slash) --> | |||
|3type = string/wiki-page-name | |||
|3def = depend on style | |||
|1stat = <!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample --> | |||
|4 = imageright | |||
|4d-en = Show an image on the right side. | |||
|4label = <!-- A (very) brief name for the parameter. --> | |||
|4aliases = <!-- List of aliases, separated by / (a slash) --> | |||
|4type = string/wiki-page-name | |||
|4def = <!-- default value for the parameter --> | |||
|4stat = <!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample --> | |||
- | |||
|5 = textstyle | |||
|5d-en = Override default style of text (e.g. centering - "align:left" / "align:right" / "align:center"). | |||
|5label = <!-- A (very) brief name for the parameter. --> | |||
|5aliases = <!-- List of aliases, separated by / (a slash) --> | |||
|5type = string | |||
|5def = <!-- default value for the parameter --> | |||
|5stat = <!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample --> | |||
|6 = style | |||
|6d-en = Override in custom style overrides for the template using CSS. | |||
|6label = <!-- A (very) brief name for the parameter. --> | |||
|6aliases = <!-- List of aliases, separated by / (a slash) --> | |||
|6type = string | |||
|6def = <!-- default value for the parameter --> | |||
|6stat = <!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample --> | |||
|7 = lang | |||
|7d-en = Set the language of the text – it's important for right-to-left languages: their image is on the right and imageright is on the left. | |||
|7label = <!-- A (very) brief name for the parameter. --> | |||
|7aliases = <!-- List of aliases, separated by / (a slash) --> | |||
|7type = string | |||
|7def = <!-- default value for the parameter --> | |||
|7stat = optional- | |||
|name = Mbox | |||
|desc = This is used to create message boxes. | |||
|namespace = all | |||
|usergroup = all | |||
|placement = | |||
|usage-notes = | |||
|type = | |||
|example = | |||
|example-value = | |||
|i18n-method = - | |||
|i18n-desc = | |||
|i18n-mediawiki-msg = | |||
|i18n-subpage = | |||
|seealso = | |||
|setscats = | |||
|print = multi | |||
|shorthand = | |||
|relieson = | |||
|mustbesubst = | |||
|useTemplateData = 1 | |||
}} | |||
==Examples== | ==Examples== | ||
Revision as of 09:02, 5 January 2014
This is used to create message boxes.
Usage
{{Mbox
|text =
|type =
|image =
|imageright =
|textstyle =
|style =
}}
Template parameters
| Parameter | Description | Default | Status | |
|---|---|---|---|---|
text | The text to be displayed. | empty | optional | |
type | Changes the color depending on the message needed. Each has its own preset image. | notice | optional | |
image | Override the image ("none" for no image). | depend on style | optional | |
imageright | Show an image on the right side. | empty | optional | |
textstyle | Override default style of text (e.g. centering - "align:left" / "align:right" / "align:center"). | empty | optional | |
style | Override in custom style overrides for the template using CSS. | empty | optional | |
lang | Set the language of the text – it's important for right-to-left languages: their image is on the right and imageright is on the left. | empty | optional | |
|
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard. Existing template documentation Newly created template documentation and imports Wikipedia's help about TemplateData • Commons-specific information This is used to create message boxes.
| ||||||||||||||||||||||||||||||||||||||||
Additional information
The template is intended to be used in the following namespaces: all namespaces
The template is intended to be used by the following user groups: all users
Localization
This template is not intended to be localized.
Examples
 | warning - for speedy deletion and other serious notices |
 | serious - for deletion notices |
 | issue - for larger issues |
 | query - for minor issues |
 | style - for cleanup (only difference is different icon) |
 | notice |
 | license - for licenses (please note, the icon is an example, templates will still use their current icons where applicable) |
 | legal - for legal disclaimers such as {{Trademark}} |
 | protection - for protection notices |
 | honor - for honors such as featured image |
 | growth - for other "good" notices |
 | move - for move requests |
The style is different on categories. It uses {{Cmbox}} instead.