Template:Cmbox/doc: Difference between revisions
(Adding more documentation. Intermediate save.) |
m (Text replacement - "\[\[Category:([^|]+)\|{{PAGENAME}}\]\]" to "Category:$1") |
||
(38 intermediate revisions by 18 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{high-use| 30,000+ }} |
|||
<includeonly>{{intricate template}}</includeonly> |
|||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
||
{{mbox templates}} |
|||
This is the {{tl|cmbox}} or '''category message box''' meta-template. |
This is the {{tl|cmbox}} or '''category message box''' meta-template. |
||
It is used to |
It is used to build message box templates for category pages, such as {{tl|CatDiffuse}} etc. It offers several different colours, uses default images if no image parameter is given and it has some other features. |
||
This template works exactly like {{tl|ambox}} and uses the same parameters |
This template works almost exactly like {{tl|ambox}} and uses the same parameters. |
||
=== |
=== We are deploying! === |
||
After long discussion on the [[Template talk:Cmbox|talk page]] of this template and at other places we are finally deploying this template. Feel free to convert any message boxes used on category 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. |
|||
The styles of category space message boxes and the usage of this template is currently being standardised and discussed on the [[{{TALKPAGENAME}}|talk page]] of this template. Thus don't use this meta-template for real category message boxes yet, but feel free to use it for testing. |
|||
When this template is used to build |
When this template is used to build category 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. |
||
=== Usage === |
=== Usage === |
||
Line 30: | Line 30: | ||
<pre> |
<pre> |
||
{{cmbox |
{{cmbox |
||
| type = style |
| type = style |
||
| image = [[Image:Emblem-question-yellow.svg| |
| image = [[Image:Emblem-question-yellow.svg|40px]] |
||
| style |
| style = width: 400px; |
||
| textstyle = color: red; font-weight: bold; font-style: italic; |
|||
| text = The message body text. |
| text = The message body text. |
||
}} |
}} |
||
</pre> |
</pre> |
||
{{cmbox |
{{cmbox |
||
| type = style |
| type = style |
||
| image = [[Image:Emblem-question-yellow.svg| |
| image = [[Image:Emblem-question-yellow.svg|40px]] |
||
| style |
| style = width: 400px; |
||
| textstyle = color: red; font-weight: bold; font-style: italic; |
|||
| text = The message body text. |
| text = The message body text. |
||
}} |
}} |
||
Line 58: | Line 60: | ||
{{cmbox |
{{cmbox |
||
| type = content |
| type = content |
||
| text = type=<u>content</u> – Major warnings and problems, such as {{tl| |
| text = type=<u>content</u> – Major warnings and problems, such as {{tl|Categorisation of people disputed}}. |
||
}} |
}} |
||
{{cmbox |
{{cmbox |
||
Line 70: | Line 72: | ||
{{cmbox |
{{cmbox |
||
| type = move |
| type = move |
||
| text = type=<u>move</u> – Move, merge and split messages and proposals, such as |
| text = type=<u>move</u> – Move, merge and split messages and proposals, such as {{tl|categoryredirect}}. |
||
}} |
}} |
||
{{cmbox |
{{cmbox |
||
Line 77: | Line 79: | ||
}} |
}} |
||
=== Other images === |
|||
The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the '''image''' parameter to specify an image other than the default images. |
The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the '''image''' parameter to specify an image other than the default images. |
||
{{cmbox |
{{cmbox |
||
| type = |
| type = style |
||
| image = [[Image:Sub-arrows.svg|40px]] |
| image = [[Image:Sub-arrows.svg|40px]] |
||
| text = type = |
| text = type = style <br> image = <nowiki>[[Image:Sub-arrows.svg|40px]]</nowiki> <br> This image is used for {{tl|verylarge}} and {{tl|CatDiffuse}}. |
||
}} |
}} |
||
{{cmbox |
{{cmbox |
||
Line 92: | Line 94: | ||
}} |
}} |
||
=== Special === |
|||
Some other parameter combinations. |
Some other parameter combinations. |
||
Line 124: | Line 126: | ||
{{cmbox |
{{cmbox |
||
| type = speedy / delete / content / style / notice / move / protection |
| type = speedy / delete / content / style / notice / move / protection |
||
| image = none |
| image = none / [[Image:Some image.svg|40px]] |
||
| imageright = [[Image:Some image.svg|40px]] |
| imageright = [[Image:Some image.svg|40px]] |
||
| style = CSS |
| style = CSS values |
||
⚫ | |||
| text = The message body text. |
| text = The message body text. |
||
⚫ | |||
}} |
}} |
||
</pre> |
</pre> |
||
Line 137: | Line 139: | ||
'''image''' |
'''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. |
:'''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. ( |
:'''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 = [[Image:Sub-arrows.svg|40px]]</nowiki></code> |
::<code><nowiki>image = [[Image:Sub-arrows.svg|40px]]</nowiki></code> |
||
:'''none''' = Means that no image is used. |
:'''none''' = Means that no image is used. |
||
Line 143: | Line 145: | ||
'''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 |
:'''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 = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code> |
::<code><nowiki>imageright = [[Image: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. |
||
'''style''' |
'''style''' |
||
:An optional [[Cascading Style Sheets|CSS]] value used by the entire |
:An optional [[Cascading Style Sheets|CSS]] value used by the entire message box table. Without quotation marks <code>" "</code>. For example: |
||
::<code>style = margin-bottom: 0.5em;</code> |
::<code>style = margin-bottom: 0.5em;</code> |
||
⚫ | |||
⚫ | |||
'''textstyle''' |
'''textstyle''' |
||
Line 158: | Line 157: | ||
::<code>textstyle = text-align: center;</code> |
::<code>textstyle = text-align: center;</code> |
||
⚫ | |||
⚫ | |||
=== Technical details === |
=== Technical details === |
||
If you need to use special characters in the text parameter then you need to escape them like this: |
|||
This template currently uses hard coded styles. Later it will use CSS classes enabling it to be skinned. |
|||
<pre> |
|||
{{cmbox |
|||
| 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> |
|||
}} |
|||
</pre> |
|||
{{cmbox |
|||
| 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 cmbox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable. |
|||
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. |
|||
The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent background that MediaWiki renders for svg images. The png images here have hand optimised transparent background colour so they look good in all browsers. Note that svg icons only look somewhat bad in the old browsers, thus such hand optimisation is only worth the trouble for very widely used icons. |
|||
For more technical details see the [[Template talk:Cmbox|talk page]]. Since this template works almost exactly like the other mboxes their talk pages and related pages might also contain more details, see the "See also" section below. |
|||
=== See also === |
=== See also === |
||
{{Mbox templates see also}} |
|||
* {{tl|ambox}} – The meta-template for article message boxes. |
|||
* {{tl|imbox}} – The meta-template for image space message boxes. |
|||
<includeonly> |
<includeonly> |
||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> |
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> |
||
[[Category:Wikipedia metatemplates |
[[Category:Wikipedia metatemplates]] |
||
[[Category:Category namespace templates| ]] |
|||
[[ca:Plantilla:Metacaixa d'avís categoria]] |
|||
[[hsb:Předłoha:Ombox]] |
|||
[[ja:Template:Cmbox]] |
|||
[[no:mal:Cmbox]] |
|||
[[mk:Шаблон:Cmbox]] |
|||
[[mn:Загвар:Cmbox]] |
|||
[[ka:თარგი:Cmbox]] |
|||
[[pt:Predefinição:Cmbox]] |
|||
[[ro:Format:Meta-casetămc]] |
|||
[[uk:Шаблон:Cmbox]] |
|||
[[vi:Bản mẫu:Cmbox]] |
|||
[[zh:Template:Cmbox]] |
|||
</includeonly> |
</includeonly> |
Latest revision as of 16:21, July 15, 2022
This is a documentation subpage for Template:Cmbox. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on 30,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Template:Mbox templates This is the {{cmbox}} or category message box meta-template.
It is used to build message box templates for category pages, such as {{CatDiffuse}} etc. It offers several different colours, uses default images if no image parameter is given and it has some other features.
This template works almost exactly like {{ambox}} and uses the same parameters.
We are deploying!
After long discussion on the talk page of this template and at other places we are finally deploying this template. Feel free to convert any message boxes used on category 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 category 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.
Usage
Simple usage example:
{{cmbox | text = Some text.}}
Page Module:Message box/cmbox.css has no content.
Some text. |
Complex example:
{{cmbox | 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. }}
Page Module:Message box/cmbox.css has no content.
The message body text. |
Category message box types
The following examples use different type parameters but use no image parameters thus they use the default images for each type.
Page Module:Message box/cmbox.css has no content.
type=speedy – Speedy deletion templates such as {{db-catempty}}. |
Page Module:Message box/cmbox.css has no content.
type=delete – Deletion templates such as {{cfd}}. |
Page Module:Message box/cmbox.css has no content.
type=content – Major warnings and problems, such as {{Categorisation of people disputed}}. |
Page Module:Message box/cmbox.css has no content.
type=style – Minor warnings and problems, such as {{popcat}}. |
Page Module:Message box/cmbox.css has no content.
type=notice – Notices and messages of any kind, both permanent and temporary. |
Page Module:Message box/cmbox.css has no content.
type=move – Move, merge and split messages and proposals, such as {{categoryredirect}}. |
Page Module:Message box/cmbox.css has no content.
type=protection – Protection templates such as {{pp-semi-protected}} when shown on a category page. |
Other images
The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the image parameter to specify an image other than the default images.
Page Module:Message box/cmbox.css has no content.
type = style image = [[Image:Sub-arrows.svg|40px]] This image is used for {{verylarge}} and {{CatDiffuse}}. |
Page Module:Message box/cmbox.css has no content.
type = move image = [[Image:Redirect arrow.svg|52px]] This image is used for {{categoryredirect}}. |
Special
Some other parameter combinations.
Page Module:Message box/cmbox.css has no content.
No type and no image given (default) |
Page Module:Message box/cmbox.css has no content.
No type and image=none – No image is used and the text uses the whole message box area. |
Page Module:Message box/cmbox.css has no content.
image = [[Image:Gnome globe current event.svg|42px]] imageright = [[Image:Nuvola apps bookcase.svg|40px]] |
Page Module:Message box/cmbox.css has no content.
This category lists articles about current and recent spaceflights.
It is populated by the {{current spaceflight}} template. |
Parameters
List of all parameters:
{{cmbox | 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. }}
type
- If no type parameter is given the template defaults to type notice. That means it gets a blue background.
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:Sub-arrows.svg|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
- An optional CSS value used by the entire message box table. Without quotation marks
" "
. For example:style = margin-bottom: 0.5em;
textstyle
- An optional CSS value used by the text cell. For example:
textstyle = text-align: center;
text
- The message body text.
Technical details
If you need to use special characters in the text parameter then you need to escape them like this:
{{cmbox | 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> }}
Page Module:Message box/cmbox.css has no content.
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 cmbox CSS classes in MediaWiki:Common.css for most of its looks, thus it is fully skinnable.
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.
The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent background that MediaWiki renders for svg images. The png images here have hand optimised transparent background colour so they look good in all browsers. Note that svg icons only look somewhat bad in the old browsers, thus such hand optimisation is only worth the trouble for very widely used icons.
For more technical details see the talk page. Since this template works almost exactly like the other mboxes their talk pages and related pages might also contain more details, see the "See also" section below.
See also
Template:Mbox templates see also