This is the template sandbox page for Template:Cmbox (diff). See also the companion subpage for test cases. |
This template can only be edited by administrators because it is transcluded onto one or more cascade-protected pages. |
This template is used on approximately 452,000 pages, or roughly 1% 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. Preview message: Transclusion count updated automatically (see documentation). |
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 {{Cmbox}} ([C]ategory [m]essage [box]) metatemplate.
It is used to build message box templates such as {{Category diffuse}} for category pages. 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.
Simple usage example:
{{cmbox | text = Some text.}}
Some text. |
Complex example:
{{cmbox
| 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. |
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 such as {{db-c1}}. |
type=delete – Deletion templates such as {{cfd}}. |
type=content – Major warnings and problems such as {{Categorization of people disputed}}. |
type=style – Minor warnings and problems such as {{Overpopulated category}}. |
type=notice – Notices and messages of any kind, both permanent and temporary. |
type=move – Move, merge, and split messages and proposals such as {{Category redirect}}. |
type=protection – Protection templates such as {{pp}} when shown on a category page. |
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.
type = style image = [[File:Sub-arrows.svg|40px]] This image is used for {{Overpopulated category}} and {{Category diffuse}}. |
type = move image = [[File:Redirect arrow.svg|52px]] This image is used for {{Category redirect}}. |
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]] |
This category lists articles about current and recent spaceflights. It is populated by the {{Current spaceflight}} template. |
List of all parameters:
{{cmbox
| 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]]
| class = A custom CSS class to apply to the box
| style = CSS values
| textstyle = CSS values
| plainlinks = no
| text = The message body text.
}}
name
box-name
to the HTML element, for use by bots or scripts.type
image
image = [[File:Sub-arrows.svg|40px]]
imageright
imageright = [[File:Nuvola apps bookcase.png|40px]]
style
" "
.
style = margin-bottom: 0.5em;
textstyle
textstyle = text-align: center;
plainlinks
|plainlinks=no
.text
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>
}}
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).
Closely related metatemplates: