2,513
edits
Template:Tmbox/doc: Difference between revisions
m
101 revisions imported: Importing Template:Tmbox, with templates.
m (interwiki) |
m (101 revisions imported: Importing Template:Tmbox, with templates.) |
||
| (43 intermediate revisions by 33 users not shown) | |||
Line 1:
{{
{{
{{Lua|Module:Message box}}
<!-- PLEASE ADD CATEGORIES
{{
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
=== 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]].
Line 27 ⟶ 18:
=== Usage ===
Simple usage example:
Line 35 ⟶ 25:
{{tmbox | text = Some text.}}
Complex example:
Line 42 ⟶ 31:
{{tmbox
| type = style
| image = [[
| style = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
Line 51 ⟶ 40:
{{tmbox
| type = style
| image = [[
| style = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
Line 58 ⟶ 47:
=== 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.
Line 91 ⟶ 79:
=== Special ===
Some other parameter combinations.
Line 102 ⟶ 89:
}}
{{tmbox
| image = [[
| imageright = [[
| text = image = <nowiki>[[
}}
=== Parameters ===
List of all parameters:
<pre>
{{tmbox
| name = name of the template
| type = speedy / delete / content / style / notice / move / protection
| image = none / [[
| imageright = [[
| style = CSS values
| textstyle = CSS values
| plainlinks = no
| text = The message body text.
| small = {{{small|}}} / yes
| smallimage = none / [[
| smallimageright = none / [[
| smalltext = A shorter message body text.
}}
</pre>
'''name'''
:(Optional) Name of the template. This adds a CSS class with name <code>box-''name''</code> to the HTML element, for use by bots or scripts.
'''type'''
Line 132 ⟶ 123:
:'''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 = [[
:'''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 = [[
:'''Anything''' = Any other object that you want to show on the right side.
Line 148 ⟶ 139:
: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'''
Line 153 ⟶ 147:
==== The small parameters ====
{{tmbox
| small = yes
Line 169 ⟶ 162:
{{tmbox
| small = yes
| image = [[
| smallimage = [[
| text =
small = yes <br> image = <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 = [[
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=yes".
{{tmbox
| small = yes
| imageright = [[
| text =
small = yes <br> imageright = <nowiki>[[
}}
{{tmbox
| small = yes
| imageright = [[
| smallimageright = none
| text =
small = yes <br> imageright = <nowiki>[[
}}
Line 197 ⟶ 190:
:'''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 = [[
:'''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".
Line 205 ⟶ 198:
=== Technical details ===
If you need to use special characters in the text parameter then you need to escape them like this:
Line 228 ⟶ 220:
This template uses the tmbox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.
This template calls
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.
Line 235 ⟶ 227:
=== See also ===
Similar templates:
* {{tl|Notice}}
{{Mbox templates see also}}
Line 242 ⟶ 235:
WikiProject banners:
* {{tl|
* {{tl|WikiProjectBanners}} – Another system for collapsing WikiProject banners.
<includeonly>{{Sandbox other|
| <!-- CATEGORIES
[[Category:
[[Category:Talk namespace templates| ]]
}}</includeonly>▼
▲</includeonly>
| |||