Template:Tmbox/doc

About this template

This is the tmbox (talk page message box) meta-template. It is used in talk pages and is called by other templates to give a consistent structure and appearance to boilerplate messages used on talk pages across the project.

Usage

{{tmbox|text=Text goes here.}}

would produce this:

{{tmbox
| type      = style
| image     = [[File:Emblem-question-yellow.svg|40px|link=|alt=]]
| style     = width: 400px; 
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}

yields:

Parameters

List of all parameters:

{{tmbox
| name = name of the template
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[File:Some image.svg|40px]]
| imageright = [[File:Some image.svg|40px]]
| style = CSS values
| textstyle = CSS values
| plainlinks = no
| text  = The message body text. 
| small = {{{small|}}} / yes
| smallimage = none / [[File:Some image.svg|30px]]
| smallimageright = none / [[File:Some image.svg|30px]]
| smalltext  = A shorter message body text.
}}

name

(Optional) Name of the template. This adds a CSS class with name box-name to the HTML element, for use by bots or scripts.

type

If no type parameter is given the template defaults to type notice. That means it gets a gray border.

image

No parameter = If no image parameter is given the template uses a default image. Which default image it uses depends on the type parameter.

An image = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:

image = [[File:Crystal package settings.png|40px]]

none = Means that no image is used.

imageright

No parameter = If no imageright parameter is given then no image is shown on the right side.

An image = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:

imageright = [[File:Nuvola apps bookcase.png|40px]]

Anything = Any other object that you want to show on the right side.

style

Optional CSS values used by the entire message box table. Without quotation marks " " but with the ending semicolons ;. For example:

style = margin-bottom: 0.5em;

textstyle

Optional CSS values used by the text cell. For example:

textstyle = text-align: center;

plainlinks

Normally on Wikipedia, external links have an arrow icon next to them, like this: Example.com. However, in message boxes, the arrow icon is suppressed by default, like this: Example.com. To get the normal style of external link with the arrow icon, use |plainlinks=no.

text

The message body text.

The small parameters

small

yes = Makes it a smaller right floating message box. This also makes the default images smaller. Note that any data fed to the smallimage, smallimageright and smalltext parameters is only used if "small=yes". To make it so your template also understands the small parameter you can use this code:

small =

smallimage

No parameter = If no smallimage parameter is given then this template falls back to use the image parameter. If the image parameter also is empty then a small default image is used.

An image = Should be an image with usual wiki notation. 30px width is usually about right. For example:

smallimage = [[File:Crystal package settings.png|30px]]

none = Means that no image is used. This overrides any image fed to image, when "small=yes".

smallimageright

No parameter = If no smallimageright parameter is given then this template falls back to use the imageright parameter. If the imageright parameter also is empty then no image is shown on the right side.

An image = Should be an image with usual wiki notation. 30px width is usually about right. For example:

smallimageright = [[File:Nuvola apps bookcase.png|30px]]

Anything = Any other object that you want to show on the right side.

none = Means that no right side image is used. This overrides any image fed to imageright, when "small=yes".

smalltext

A shorter version of the message body text. If no smalltext parameter is given then this template falls back to use the text parameter.