Template:Mbox/doc: Difference between revisions

Revision as of 19:34, 13 June 2015

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Mbox.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

This is used to create message boxes.

Usage

Template parameters

Parameter	Description	Default	Status
`text`	The text to be displayed.	empty	required
`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).	depends on style	optional
`imageright`	Show an image on the right side.	empty	optional
`textstyle`	Override default style of text (e.g. alignment - text-align:left; / text-align:right; / text-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

Template data

Parameter text is empty

TemplateData

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
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Wikipedia's help about TemplateData • Commons-specific information

This is used to create message boxes.

Template parameters
This template prefers block formatting of parameters.
	Description	Type	Status
`image`	Override the image (none for no image). Default depends on style	Page name	optional
`imageright`	Show an image on the right side.	Page name	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.	String	optional
`style`	Override in custom style overrides for the template using CSS.	String	optional
`text`	The text to be displayed.	Line	required
`textstyle`	Override default style of text (e.g. alignment - text-align:left; / text-align:right; / text-align:center;).	String	optional
`type`	Changes the color depending on the message needed. Each has its own preset image. Default notice	String	optional

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)

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

message

notice (default)

@@ Line 6: / Line 6: @@
   |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 -->
+  |1stat    = required
   |2        = type
@@ Line 14: / Line 14: @@
   |2type    = string
   |2def     = notice
-  |2stat    = <!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->
+  |2stat    = optional
   |3        = image
@@ Line 22: / Line 22: @@
   |3aliases = <!-- List of aliases, separated by / (a slash) -->
   |3type    = string/wiki-page-name
-  |3def     = depend on style
+  |3def     = depends on style
-  |3stat    = <!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->
+  |3stat    = optional
   |4        = imageright
@@ Line 31: / Line 31: @@
   |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 -->
+  |4stat    = optional
   -
   |5        = textstyle
@@ Line 38: / Line 38: @@
   |5aliases = <!-- List of aliases, separated by / (a slash) -->
   |5type    = string
- |5def     = <!-- default value for the parameter -->
+  |5stat    = optional-
-  |5stat    = <!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->
   |6        = style
@@ Line 46: / Line 45: @@
   |6aliases = <!-- List of aliases, separated by / (a slash) -->
   |6type    = string
- |6def     = <!-- default value for the parameter -->
+  |6stat    = optional-
-  |6stat    = <!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->
   |7        = lang
@@ Line 54: / Line 52: @@
   |7aliases = <!-- List of aliases, separated by / (a slash) -->
   |7type    = string
- |7def     = <!-- default value for the parameter -->
   |7stat    = optional-
@@ Line 134: / Line 131: @@
 |type=
 }}
-=={{int:Seealso}}==
-* {{tl|cmbox}} – use for '''''categories''''' instead (the style is different).
-* {{tl|cleanupbox}} – use for ''files'' (is based on this, mainly for template layout)
 <includeonly>

commons>FDMS4