User:Mathglot/sandbox/Templates/Tmboxw

Aliquam vehicula sem ut pede. Cras purus lectus, egestas eu, vehicula at, imperdiet sed, nibh. Morbi consectetuer luctus felis. Donec vitae nisi. Aliquam tincidunt feugiat elit.

Documentation[view] [edit] [history] [purge]

Error: {{Template rating}} must be placed in the Template namespace. This template is a workaround designed to replace {{tmbox}} in order to enable mobile users to view tmboxes that are otherwise hidden from them due to mobile bug T257394. Replacing an existing {{tmbox}} invocation by {{tmboxw}} should not affect desktop viewers.

Usage[edit]

Simple usage example:

{{tmboxw | text = Some text.}}

Some text.

Complex example:

{{tmboxw
| 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.
}}

The message body text.

Note: examples below are transcluded from {{tmbox/doc}}; in place of 'tmbox' on the rest of this page, please use 'tmboxw' instead.

Tip: mobile users may achieve better results in landscape mode on small devices, which will, for example, satisfactorily render {{Talk header}} templates which would be clipped in portrait mode.

Parameters[edit]

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[edit]

small = yes

type = style
small = yes

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 =

small = yes
image = [[File:Nuvola apps bookcase.svg|40px]]
smallimage = [[File:Nuvola apps bookcase.png|30px]]

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".

small = yes
imageright = [[File:Nuvola apps bookcase.svg|40px]]

small = yes
imageright = [[File:Nuvola apps bookcase.svg|40px]]
smallimageright = none

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.

Technical details[edit]

If you need to use special characters in the text parameter then you need to escape them like this:

{{tmbox
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are. 
But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>. 
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
}}

Equal sign = and a start and end brace { } work fine as they are. But here is a pipe | and two end braces }}. And now a pipe and end braces |}}.

This template uses the tmbox CSS classes in Module:Message box/tmbox.css for most of its looks, thus it is fully skinnable.

This template calls Module:Message box which holds most of the code for {{tmbox}}, while {{tmbox}} itself does parameter preprocessing.

Internally this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use parser functions and special characters in parameters.

For more technical details see the talk page. Since this template works almost exactly like {{ambox}}, {{imbox}}, {{cmbox}} and {{ombox}} their talk pages and related pages might also contain more details.

TemplateData[edit]

A meta-template called by other templates to produce consistently formatted talk page message boxes.

Template parameters
Parameter		Description	Type	Status
name	`name`	Name of the template. This adds a CSS class to the HTML element, for use by bots or scripts	Line	suggested
type	`type`	Formats the box based on its type Suggested values `speedy` `delete` `content` `style` `notice` `move` `protection` Default notice	Unknown	suggested
image	`image`	Replaces the default left-side image	File	suggested
imageright	`imageright`	Adds an image on the right	File	optional
style	`style`	Optional CSS values used by the entire message box table	Unknown	optional
textstyle	`textstyle`	Optional CSS values used by the text cell	Unknown	optional
plainlinks	`plainlinks`	Set to "no" to show the external link icon for external links Default yes	Boolean	optional
text	`text`	The message body text	Unknown	suggested
small	`small`	Makes it a smaller right floating message box	Boolean	optional
Small image	`smallimage`	Left-side image used for the small version of the box	File	optional
Small image right	`smallimageright`	Right-side image used for the small version of the box	File	optional
Small text	`smalltext`	Text used for the small version of the box	Unknown	optional

Usage[edit]

Parameters[edit]

The small parameters[edit]

Technical details[edit]

TemplateData[edit]

See also[edit]