Template:Tmbox/doc

Uses Lua:

Module:Message box

This is a documentation subpage for .
It contains usage information, categories and other content that is not part of the original template page.

This is the talk message box meta-template, mainly used by other templates to create consistent message boxes for discussion pages.

Usage

{{Tmbox
|type =
|image =
|imageright =
|class =
|style =
|textstyle =
|text =
|small =
|lang =
}}

Template parameters

Parameter	Description		Default	Status
`type`	type	Type of the box (speedy, delete, content, style, move, protection or notice), affects the colors and the default image of the box	notice	optional
`image` `smallimage`	main image	The image that appears on the left of the template (on the right in right-to-left context), using full image syntax (e.g. `[[File:Some image.svg\|40px]]`), or the special value `none` to completely hide the image. The default image depends on the box type (see below).	empty	optional
`imageright` `smallimageright`	secondary image	The image that appears on the right of the template (on the left in right-to-left context), using full image syntax (e.g. `[[File:Some image.svg\|40px]]`), by default nothing.	empty	optional
`class`	CSS class	Space-separated list of additional CSS classes for the whole box	empty	optional
`style`	CSS style	Semicolon-separated list of additional inline CSS rules for the whole box	empty	optional
`textstyle`	text CSS style	Semicolon-separated list of additional inline CSS rules for the text cell	empty	optional
`text` `smalltext`	text	The message itself	empty	required
`small`	small	Set to “yes” to make the box smaller and right-aligned	empty	optional
`lang`	language	Language of the box’s content, affects layout e.g. for right-to-left or East Asian languages	empty	suggested

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.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

Wikipedia's help about TemplateData • Commons-specific information

This is the talk message box meta-template, mainly used by other templates to create consistent message boxes for discussion pages.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
CSS class	`class`	Space-separated list of additional CSS classes for the whole box	Line	optional
main image	`image` `smallimage`	The image that appears on the left of the template (on the right in right-to-left context), using full image syntax (e.g. [[File:Some image.svg\|40px]]), or the special value “none” to completely hide the image. The default image depends on the box type (see on the template page).	Content	optional
secondary image	`imageright` `smallimageright`	The image that appears on the right of the template (on the left in right-to-left context), using full image syntax (e.g. [[File:Some image.svg\|40px]]), by default nothing.	Content	optional
language	`lang`	Language of the box’s content, affects layout e.g. for right-to-left or East Asian languages	Line	suggested
small	`small`	Set to “yes” to make the box smaller and right-aligned	Line	optional
CSS style	`style`	Semicolon-separated list of additional inline CSS rules for the whole box	Line	optional
text	`text` `smalltext`	The message itself	Content	required
text CSS style	`textstyle`	Semicolon-separated list of additional inline CSS rules for the text cell	Line	optional
type	`type`	Type of the box (speedy, delete, content, style, move, protection or notice), affects the colors and the default image of the box Default notice	Line	optional

Additional information

The template is intended to be used in the following namespaces: all talk namespaces and noticeboards

The template is intended to be used by the following user groups: all users

Relies on:
{{Tmbox/core}}

Example

{{Tmbox|type = speedy
 |image = [[File:Example en.svg|30px]]
 |imageright = [[File:Example.svg|30px]]
 |style = border-style:dotted
 |textstyle = font-style:italic
 |text = This is the text
 |small = yes
}}

renders as:

This is the text

⧼Seealso⧽

{{Talkbox}}
For extensive documentation, see w:Template:Tmbox/doc.

Localization

This template is not intended to be localized.

Styles

Possible styles of the template with their default images:

notice (default)

speedy

delete

content

style

move

protection

The Lab Rats 2 - Reformulate Wiki

<span class="mw-page-title-namespace">Template</span><span class="mw-page-title-separator">:</span><span class="mw-page-title-main">Tmbox/doc</span>

Contents