View source for Template:Tmbox/doc

{{Documentation subpage}}
{{High-risk|2,000,000+}}
{{Lua|Module:Message box}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
{{Mbox templates (small)}}

This is the {{tl|Tmbox}} (['''T''']alk page ['''m''']essage ['''box''']) metatemplate.  This template is called by other templates to give a consistent structure and appearance to boilerplate messages used on talk pages across the project.  It ''may'' be called directly on a talk page in order to present a one-off message in the same format as boilerplate messages, but this is non-standard (if a message is important enough to be presented in this form, you should consider creating a separate template so that it is easily available to other editors).  Tmbox offers several different colors for different purposes, provides default images if no image parameter is given, and has some other pleasant features. This template works similarly to {{tl|Ambox}} and uses the same parameters.

This template should not be used for WikiProject banners. Such banners have special programming constraints that merit their own meta-templates. See the "See also" section below for links.

=== Suggested style standard ===
The types of talkpage messageboxes follow the same naming convention as the boxes for all other namespaces, but the type of any particular talkpage messagebox may not be as obvious as in other namespaces.  When deciding on the type to use for a talkpage messagebox, please consider the following guidelines:
* '''speedy''' should ''only'' be used for [[:Category:Speedy deletion templates|speedy deletion templates]].
* '''delete''' should ''only'' be used for templates relating to ''ongoing'' deletion discussions.  Please do ''not'' use this type just to get a red border for a messagebox.
* '''content''' and '''style''' should be used for warnings and alerts.  Use '''content''' (which has an orange border) for more important and immediate alerts, and '''style''' (yellow border) for less important warnings.  Messageboxes of these types should ideally be ''transitory'': they should not be expected to remain on a talkpage indefinitely.  
* '''move''' and '''protection''' should only be used for messageboxes relating to moves and merges, and page protection, respectively. 
* The '''notice''' type should be used for the majority of talkpage messageboxes; those that are intended to convey or summarise information.  If a talkpage messagebox does not obviously fit into one of the other types, it is probably a notice type.

=== Usage ===
Simple usage example:

<pre>
{{tmbox | text = Some text.}}
</pre>

{{tmbox | text = Some text.}}

Complex example:

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

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

=== Talk page message box types ===
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type.

{{tmbox
| type = speedy
| text = type=<u>speedy</u> – Speedy deletion templates.
}}
{{tmbox
| type = delete
| text = type=<u>delete</u> – Deletion templates.
}}
{{tmbox
| type = content
| text = type=<u>content</u> – Major warnings and problems.
}}
{{tmbox
| type = style
| text = type=<u>style</u> – Minor warnings and problems.
}}
{{tmbox
| type = notice
| text = type=<u>notice</u> – Notices and messages of any kind, both permanent and temporary.
}}
{{tmbox
| type = move
| text = type=<u>move</u> – Merge, split, rename and transwiki messages and proposals.
}}
{{tmbox
| type = protection
| text = type=<u>protection</u> – Protection templates.
}}

=== Special ===
Some other parameter combinations.

{{tmbox
| text  = No type and no image given ('''default''')
}}
{{tmbox
| image = none
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}
{{tmbox
| image = [[File:Gnome globe current event.svg|42px]]
| imageright = [[File:Nuvola apps bookcase.svg|40px]]
| text  = image = <nowiki>[[File:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki>
}}

=== Parameters ===
List of all parameters:

<pre>
{{tmbox
| 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.
}}
</pre>

'''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: 
::<code><nowiki>image = [[File:Crystal package settings.png|40px]]</nowiki></code>
:'''none''' = Means that no image is used.

{{Anchor|imageright}}'''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: 
::<code><nowiki>imageright = [[File:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.

'''style'''
:Optional [[Cascading Style Sheets|CSS]] values used by the entire message box table. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
::<code>style = margin-bottom: 0.5em;</code>

'''textstyle'''
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
::<code>textstyle = text-align: center;</code>

'''plainlinks'''
:Normally on Wikipedia, external links have an arrow icon next to them, like this: [http://www.example.com Example.com]. However, in message boxes, the arrow icon is suppressed by default, like this: <span class="plainlinks">[http://www.example.com Example.com]</span>. To get the normal style of external link with the arrow icon, use {{para|plainlinks|no}}.

'''text'''
:The message body text.

==== The small parameters ====
{{tmbox
| small = yes
| text = small = yes
}}
{{tmbox
| type = style
| small = yes
| text = type = style <br> 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:
::<code><nowiki>small = {{{small|}}}</nowiki></code>

{{tmbox
| small = yes
| image      = [[File:Nuvola apps bookcase.svg|40px]]
| smallimage = [[File:Nuvola apps bookcase.svg|30px]]
| text = 
small = yes <br> image = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki> <br> smallimage = <nowiki>[[File:Nuvola apps bookcase.png|30px]]</nowiki>
}}
'''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: 
::<code><nowiki>smallimage = [[File:Crystal package settings.png|30px]]</nowiki></code>
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=yes".

{{tmbox
| small = yes
| imageright = [[File:Nuvola apps bookcase.svg|40px]]
| text = 
small = yes <br> imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki>
}}
{{tmbox
| small = yes
| imageright = [[File:Nuvola apps bookcase.svg|30px]]
| smallimageright = none
| text = 
small = yes <br> imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki> <br> 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: 
::<code><nowiki>smallimageright = [[File:Nuvola apps bookcase.png|30px]]</nowiki></code>
:'''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 ===
If you need to use special characters in the text parameter then you need to escape them like this: 

<pre>
{{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 &lt;nowiki>}}&lt;/nowiki>. 
And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki>.
</div>
}}
</pre>

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

This template uses the tmbox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.

This template calls {{tl|tmbox/core}} which holds most of the code for {{tl|tmbox}}, while {{tl|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 [[m:Help:ParserFunctions|parser functions]] and special characters in parameters. 

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

=== See also ===
Similar templates:  
* {{tl|Notice}}
{{Mbox templates see also}}

Other pages:
* [[Wikipedia:Talk page templates]] – The guideline specifying the styles for talk page message boxes.

WikiProject banners:
* {{tl|WikiProject banner shell}} and {{tl|WPBannerMeta}} – A system for collapsing, wrapping and creating WikiProject banners.
* {{tl|WikiProjectBanners}} – Another system for collapsing WikiProject banners.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Mbox and messagebox templates]]
[[Category:Talk namespace templates| ]]
}}</includeonly>