Template:Tmbox/doc: Difference between revisions

m
101 revisions imported: Importing Template:Tmbox, with templates.
No edit summary
m (101 revisions imported: Importing Template:Tmbox, with templates.)
 
(32 intermediate revisions by 24 users not shown)
Line 1:
{{documentationDocumentation subpage}}
{{highHigh-risk| 1,000,000+2553167 |all-pages = yes}}
{{Lua|Module:Message box}}
<!-- PLEASE ADD CATEGORIES ANDWHERE INTERWIKISINDICATED AT THE BOTTOM OF THIS PAGE -->
{{mboxMbox templates (small)}}
This is the {{tl|tmbox}}, or '''talk page message box''', meta-template. 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 is the {{tl|tmboxTmbox}}, or (['''talkT''']alk page message['''m''']essage ['''box''',]) meta-templatemetatemplate. 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.
 
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 ===
Line 36 ⟶ 31:
{{tmbox
| type = style
| image = [[ImageFile:Emblem-question-yellow.svg|40px]]
| style = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
Line 45 ⟶ 40:
{{tmbox
| type = style
| image = [[ImageFile:Emblem-question-yellow.svg|40px]]
| style = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
Line 94 ⟶ 89:
}}
{{tmbox
| image = [[ImageFile:Gnome globe current event.svg|42px]]
| imageright = [[ImageFile:Nuvola apps bookcase.svg|40px]]
| text = image = <nowiki>[[ImageFile:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[ImageFile:Nuvola apps bookcase.svg|40px]]</nowiki>
}}
 
Line 104 ⟶ 99:
<pre>
{{tmbox
| name = name of the template
| type = speedy / delete / content / style / notice / move / protection
| image = none / [[ImageFile:Some image.svg|40px]]
| imageright = [[ImageFile:Some image.svg|40px]]
| style = CSS values
| textstyle = CSS values
| plainlinks = no
| text = The message body text.
| small = {{{small|}}} / yes
| smallimage = none / [[ImageFile:Some image.svg|30px]]
| smallimageright = none / [[ImageFile:Some image.svg|30px]]
| 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 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 = [[ImageFile: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 = [[ImageFile:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.
 
Line 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 159 ⟶ 162:
{{tmbox
| small = yes
| image = [[ImageFile:Nuvola apps bookcase.pngsvg|40px]]
| smallimage = [[ImageFile:Nuvola apps bookcase.pngsvg|30px]]
| text =
small = yes <br> image = <nowiki>[[ImageFile:Nuvola apps bookcase.pngsvg|40px]]</nowiki> <br> smallimage = <nowiki>[[ImageFile: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 = [[ImageFile: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 = [[ImageFile:Nuvola apps bookcase.pngsvg|40px]]
| text =
small = yes <br> imageright = <nowiki>[[ImageFile:Nuvola apps bookcase.pngsvg|40px]]</nowiki>
}}
{{tmbox
| small = yes
| imageright = [[ImageFile:Nuvola apps bookcase.pngsvg|30px]]
| smallimageright = none
| text =
small = yes <br> imageright = <nowiki>[[ImageFile:Nuvola apps bookcase.pngsvg|40px]]</nowiki> <br> smallimageright = none
}}
 
Line 187 ⟶ 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 = [[ImageFile: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".
Line 217 ⟶ 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 {{tl|tmbox/core}}[[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.
 
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:
Line 232 ⟶ 235:
 
WikiProject banners:
* {{tl|WikiProjectBannerShellWikiProject banner shell}} and {{tl|WPBannerMeta}} – A system for collapsing, wrapping and creating WikiProject banners.
* {{tl|WikiProjectBanners}} – Another system for collapsing WikiProject banners.
 
<includeonly>{{Sandbox other|
| <!-- CATEGORIES ANDBELOW INTERWIKISTHIS HERELINE, THANKSPLEASE: -->
[[Category:WikipediaMbox metatemplates|{{PAGENAME}}and messagebox templates]]
[[Category:Talk namespace templates| ]]
}}</includeonly>
 
[[as:Template:Tmbox]]
[[ba:Ҡалып:Tmbox]]
[[ca:Plantilla:Metacaixa d'avís discussió]]
[[eo:Ŝablono:DiskutaMesaĝokesto]]
[[hsb:Předłoha:Tmbox]]
[[ia:Patrono:Tmbox]]
[[ja:Template:Tmbox]]
[[mn:Загвар:Tmbox]]
[[no:Mal:Tmbox]]
[[fa:الگو:Tmbox]]
[[pl:Szablon:Tmbox]]
[[pt:Predefinição:Tmbox]]
[[ro:Format:Meta-casetămd]]
[[uk:Шаблон:Tmbox]]
[[ur:Template:Tmbox]]
[[zh:Template:Tmbox]]
</includeonly>