Template:Tmbox/doc: Difference between revisions
(→See also: Adding or fixing interwiki to Mongolian Wikipedia.) |
m (101 revisions imported: Importing Template:Tmbox, with templates.) |
||
(45 intermediate revisions by 35 users not shown) | |||
Line 1: | Line 1: | ||
{{ |
{{Documentation subpage}} |
||
{{ |
{{High-risk| 2553167 |all-pages = yes}} |
||
{{Lua|Module:Message box}} |
|||
<!-- PLEASE ADD CATEGORIES |
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> |
||
{{ |
{{Mbox templates (small)}} |
||
This is the {{tl|tmbox}} or '''talk page message box''' meta-template. |
|||
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. |
|||
It is used to build message box templates for talk pages, such as {{tl|central}} etc. It offers several different colours, uses default images if no image parameter is given and it has some other features. |
|||
This template should |
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. |
||
This template works similarly to {{tl|ambox}} and uses the same parameters. |
|||
=== We are deploying! === |
|||
After discussions on the [[Template talk:Tmbox|talk page]] of this template and announcing it at several places for some time we are now deploying this template. Feel free to convert any message boxes used on talk pages to use this meta-template. If you find any tricky cases then list them on the talk page of this template and you'll get help. |
|||
When this template is used to build talk page message boxes those boxes should contain explanatory texts just like before. (The same texts as before or new improved texts.) If there are more specific images in the boxes or you know a better image, then use them instead of the default images shown here. |
|||
=== Suggested style standard === |
=== 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: |
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]]. |
* '''speedy''' should ''only'' be used for [[:Category:Speedy deletion templates|speedy deletion templates]]. |
||
Line 27: | Line 18: | ||
=== Usage === |
=== Usage === |
||
Simple usage example: |
Simple usage example: |
||
Line 35: | Line 25: | ||
{{tmbox | text = Some text.}} |
{{tmbox | text = Some text.}} |
||
Complex example: |
Complex example: |
||
Line 42: | Line 31: | ||
{{tmbox |
{{tmbox |
||
| type = style |
| type = style |
||
| image = [[ |
| image = [[File:Emblem-question-yellow.svg|40px]] |
||
| style = width: 400px; |
| style = width: 400px; |
||
| textstyle = color: red; font-weight: bold; font-style: italic; |
| textstyle = color: red; font-weight: bold; font-style: italic; |
||
Line 51: | Line 40: | ||
{{tmbox |
{{tmbox |
||
| type = style |
| type = style |
||
| image = [[ |
| image = [[File:Emblem-question-yellow.svg|40px]] |
||
| style = width: 400px; |
| style = width: 400px; |
||
| textstyle = color: red; font-weight: bold; font-style: italic; |
| textstyle = color: red; font-weight: bold; font-style: italic; |
||
Line 58: | Line 47: | ||
=== Talk page message box types === |
=== 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. |
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type. |
||
Line 91: | Line 79: | ||
=== Special === |
=== Special === |
||
Some other parameter combinations. |
Some other parameter combinations. |
||
Line 102: | Line 89: | ||
}} |
}} |
||
{{tmbox |
{{tmbox |
||
| image = [[ |
| image = [[File:Gnome globe current event.svg|42px]] |
||
| imageright = [[ |
| imageright = [[File:Nuvola apps bookcase.svg|40px]] |
||
| text = image = <nowiki>[[ |
| text = image = <nowiki>[[File:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki> |
||
}} |
}} |
||
=== Parameters === |
=== Parameters === |
||
List of all parameters: |
List of all parameters: |
||
<pre> |
<pre> |
||
{{tmbox |
{{tmbox |
||
| name = name of the template |
|||
| type = speedy / delete / content / style / notice / move / protection |
| type = speedy / delete / content / style / notice / move / protection |
||
| image = none / [[ |
| image = none / [[File:Some image.svg|40px]] |
||
| imageright = [[ |
| imageright = [[File:Some image.svg|40px]] |
||
| style = CSS values |
| style = CSS values |
||
| textstyle = CSS values |
| textstyle = CSS values |
||
| plainlinks = no |
|||
| text = The message body text. |
| text = The message body text. |
||
| small = {{{small|}}} / yes |
| small = {{{small|}}} / yes |
||
| smallimage = none / [[ |
| smallimage = none / [[File:Some image.svg|30px]] |
||
| smallimageright = none / [[ |
| smallimageright = none / [[File:Some image.svg|30px]] |
||
| smalltext = A shorter message body text. |
| smalltext = A shorter message body text. |
||
}} |
}} |
||
</pre> |
</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''' |
'''type''' |
||
Line 132: | Line 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. |
:'''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: |
:'''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 = [[ |
::<code><nowiki>image = [[File:Crystal package settings.png|40px]]</nowiki></code> |
||
:'''none''' = Means that no image is used. |
:'''none''' = Means that no image is used. |
||
'''imageright''' |
{{Anchor|imageright}}'''imageright''' |
||
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side. |
:'''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: |
:'''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 = [[ |
::<code><nowiki>imageright = [[File:Nuvola apps bookcase.png|40px]]</nowiki></code> |
||
:'''Anything''' = Any other object that you want to show on the right side. |
:'''Anything''' = Any other object that you want to show on the right side. |
||
Line 148: | Line 139: | ||
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example: |
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example: |
||
::<code>textstyle = text-align: center;</code> |
::<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''' |
'''text''' |
||
Line 153: | Line 147: | ||
==== The small parameters ==== |
==== The small parameters ==== |
||
{{tmbox |
{{tmbox |
||
| small = yes |
| small = yes |
||
Line 169: | Line 162: | ||
{{tmbox |
{{tmbox |
||
| small = yes |
| small = yes |
||
| image = [[ |
| image = [[File:Nuvola apps bookcase.svg|40px]] |
||
| smallimage = [[ |
| smallimage = [[File:Nuvola apps bookcase.svg|30px]] |
||
| text = |
| text = |
||
small = yes <br> image = <nowiki>[[ |
small = yes <br> image = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki> <br> smallimage = <nowiki>[[File:Nuvola apps bookcase.png|30px]]</nowiki> |
||
}} |
}} |
||
'''smallimage''' |
'''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. |
:'''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: |
:'''An image''' = Should be an image with usual wiki notation. 30px width is usually about right. For example: |
||
::<code><nowiki>smallimage = [[ |
::<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". |
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=yes". |
||
{{tmbox |
{{tmbox |
||
| small = yes |
| small = yes |
||
| imageright = [[ |
| imageright = [[File:Nuvola apps bookcase.svg|40px]] |
||
| text = |
| text = |
||
small = yes <br> imageright = <nowiki>[[ |
small = yes <br> imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki> |
||
}} |
}} |
||
{{tmbox |
{{tmbox |
||
| small = yes |
| small = yes |
||
| imageright = [[ |
| imageright = [[File:Nuvola apps bookcase.svg|30px]] |
||
| smallimageright = none |
| smallimageright = none |
||
| text = |
| text = |
||
small = yes <br> imageright = <nowiki>[[ |
small = yes <br> imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki> <br> smallimageright = none |
||
}} |
}} |
||
Line 197: | Line 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. |
:'''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: |
:'''An image''' = Should be an image with usual wiki notation. 30px width is usually about right. For example: |
||
::<code><nowiki>smallimageright = [[ |
::<code><nowiki>smallimageright = [[File:Nuvola apps bookcase.png|30px]]</nowiki></code> |
||
:'''Anything''' = Any other object that you want to show on the right side. |
:'''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". |
:'''none''' = Means that no right side image is used. This overrides any image fed to '''imageright''', when "small=yes". |
||
Line 205: | Line 198: | ||
=== Technical details === |
=== Technical details === |
||
If you need to use special characters in the text parameter then you need to escape them like this: |
If you need to use special characters in the text parameter then you need to escape them like this: |
||
Line 228: | Line 220: | ||
This template uses the tmbox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable. |
This template uses the tmbox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable. |
||
This template calls |
This template calls [[Module:Message box]] 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. |
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: | Line 227: | ||
=== See also === |
=== See also === |
||
Similar templates: |
|||
* {{tl|Notice}} |
|||
{{Mbox templates see also}} |
{{Mbox templates see also}} |
||
Line 242: | Line 235: | ||
WikiProject banners: |
WikiProject banners: |
||
* {{tl| |
* {{tl|WikiProject banner shell}} and {{tl|WPBannerMeta}} – A system for collapsing, wrapping and creating WikiProject banners. |
||
* {{tl|WikiProjectBanners}} – Another system for collapsing WikiProject banners. |
* {{tl|WikiProjectBanners}} – Another system for collapsing WikiProject banners. |
||
<includeonly> |
<includeonly>{{Sandbox other| |
||
<!-- CATEGORIES |
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> |
||
[[Category: |
[[Category:Mbox and messagebox templates]] |
||
[[Category:Talk namespace templates| ]] |
[[Category:Talk namespace templates| ]] |
||
⚫ | |||
[[eo:Ŝablono:DiskutaMesaĝokesto]] |
|||
[[hsb:Předłoha:Tmbox]] |
|||
[[ja:Template:Tmbox]] |
|||
[[mn:Загвар:Tmbox]] |
|||
[[no:Mal:Tmbox]] |
|||
[[pt:Predefinição:Tmbox]] |
|||
[[ro:Format:Meta-casetămd]] |
|||
[[uk:Шаблон:Tmbox]] |
|||
[[zh:Template:Tmbox]] |
|||
⚫ |
Latest revision as of 18:39, 22 June 2020
Template:Strong for Template:Tmbox. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 2,720,000 pages, or roughly 44329% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
Message box meta-templates | |
---|---|
template | context |
{{Ambox}} | article |
{{Cmbox}} | category |
{{Imbox}} | image |
{{Tmbox}} | talk |
{{Fmbox}} | footer / header |
{{Ombox}} | other pages |
{{Mbox}} | auto-detect |
{{Asbox}} | article stub |
{{Dmbox}} | disambiguation |
This is the {{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 {{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[edit]
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 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[edit]
Simple usage example:
{{tmbox | text = Some text.}}
Some text. |
Complex example:
{{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. }}
The message body text. |
Talk page message box types[edit]
The following examples use different type parameters but use no image parameters thus they use the default images for each type.
type=speedy – Speedy deletion templates. |
type=delete – Deletion templates. |
type=content – Major warnings and problems. |
type=style – Minor warnings and problems. |
type=notice – Notices and messages of any kind, both permanent and temporary. |
type=move – Merge, split, rename and transwiki messages and proposals. |
type=protection – Protection templates. |
Special[edit]
Some other parameter combinations.
No type and no image given (default) |
No type and image=none – No image is used and the text uses the whole message box area. |
image = [[File:Gnome globe current event.svg|42px]] imageright = [[File:Nuvola apps bookcase.svg|40px]] |
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|}}}
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 MediaWiki:Common.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.
See also[edit]
Similar templates:
- {{Notice}}
- {{Ambox}}, for messageboxes on article pages.
- {{Cmbox}}, for messageboxes on category pages.
- {{Imbox}}, for messageboxes on file (image) pages.
- {{Tmbox}}, for messageboxes on talk pages.
- {{Fmbox}}, for header and footer messageboxes.
- {{Ombox}}, for messageboxes on other types of page.
- {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.
Closely related metatemplates:
- {{Asbox}}, for messageboxes in article stubs.
- {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
- {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.
Templates intended to be used in conjunction with Mboxes:
- {{Ombox/shortcut}}, an alternative to {{Shortcut}} for use in Mbox templates
Other pages:
- Wikipedia:Talk page templates – The guideline specifying the styles for talk page message boxes.
WikiProject banners:
- {{WikiProject banner shell}} and {{WPBannerMeta}} – A system for collapsing, wrapping and creating WikiProject banners.
- {{WikiProjectBanners}} – Another system for collapsing WikiProject banners.