Template:Tmbox/doc
From FORwiki
(Created page with 'This is the {{tl|tmbox}} or '''talk page message box''' meta-template. It is used to build message box templates for talk pages, such as {{tl|central}} etc. It offers several di...') |
(→Parameters) |
||
Line 135: | Line 135: | ||
'''style''' | '''style''' | ||
- | :Optional | + | :Optional 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> | ::<code>style = margin-bottom: 0.5em;</code> | ||
'''textstyle''' | '''textstyle''' | ||
- | :Optional | + | :Optional CSS values used by the text cell. For example: |
::<code>textstyle = text-align: center;</code> | ::<code>textstyle = text-align: center;</code> | ||
Line 196: | Line 196: | ||
'''smalltext''' | '''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. | :A shorter version of the message body text. If no '''smalltext''' parameter is given then this template falls back to use the '''text''' parameter. | ||
- | |||
=== See also === | === See also === | ||
{{Mbox templates see also}} | {{Mbox templates see also}} |
Revision as of 00:02, 10 October 2009
This is the {{tmbox}} or talk page message box meta-template.
It is used to build message box templates for talk pages, such as {{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 normally not be used for Foresight Wiki banners. They have special needs and thus have their own meta-templates. See the "See also" section below for links.
This template works similarly to {{ambox}} and uses the same parameters.
Contents |
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 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:
{{tmbox | text = Some text.}}
![]() |
Some text. |
Complex example:
{{tmbox | type = style | image = [[Image: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
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
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 = [[Image:Gnome globe current event.svg|42px]] imageright = [[Image:Nuvola apps bookcase.svg|40px]] |
![]() |
Parameters
List of all parameters:
{{tmbox | type = speedy / delete / content / style / notice / move / protection | image = none / [[Image:Some image.svg|40px]] | imageright = [[Image:Some image.svg|40px]] | style = CSS values | textstyle = CSS values | text = The message body text. | small = {{{small|}}} / yes | smallimage = none / [[Image:Some image.svg|30px]] | smallimageright = none / [[Image:Some image.svg|30px]] | smalltext = A shorter message body text. }}
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 = [[Image: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 = [[Image: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;
text
- The message body text.
The small parameters
![]() |
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 = [[Image:Nuvola apps bookcase.png|40px]] smallimage = [[Image: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 = [[Image: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 = [[Image:Nuvola apps bookcase.png|40px]] |
![]() |
![]() |
small = yes imageright = [[Image:Nuvola apps bookcase.png|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 = [[Image: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.
See also
There are several meta-templates in the mbox family:
- {{ambox}} – For article message boxes.
- {{tmbox}} – For talk page message boxes.
- {{imbox}} – For file (image) page message boxes.
- {{cmbox}} – For category message boxes.
- {{ombox}} – For other pages message boxes.
- {{mbox}} – Has namespace detection, for message boxes that are used on several types of pages and thus need to change style depending on what page they are used on.
Closely related meta-templates: