Difference between revisions of "Template:Cmbox/doc"
m |
m |
||
| Line 121: | Line 121: | ||
| image = [[File:Gnome globe current event.svg|42px]] | | image = [[File:Gnome globe current event.svg|42px]] | ||
| imageright = [[File:Shuttle.svg|20px]] | | imageright = [[File:Shuttle.svg|20px]] | ||
| − | | text = '''This category lists articles about current and recent [[spaceflight]]s.'''<br />It is populated by the {{tl|Current spaceflight}} template. | + | | text = '''This category lists articles about current and recent [[w:spaceflight]]s.'''<br />It is populated by the {{tl|Current spaceflight}} template. |
}} | }} | ||
Latest revision as of 16:11, 7 March 2020
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This is a documentation subpage for Template:Cmbox. It contains usage information, categories and other content that is not part of the original template page. |
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This template is used on a very large number of pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing changes on the talk page before implementing them. |
 |
This template uses material from the Wikipedia template Template:Cmbox/doc, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors). | Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
| Message box meta-templates |
|---|
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.
Contents
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.}}
 |
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.
}}
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
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.
 |
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}}. |
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
type=style – Minor warnings and problems such as {{Underpopulated 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. |
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.
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
type = style image = [[File:Sub-arrows.svg|40px]] This image is used for {{Very large}} and {{Category diffuse}}. |
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
type = move image = [[File:Redirect arrow.svg|52px]] This image is used for {{Category redirect}}. |
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. |
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
image = [[File:Gnome globe current event.svg|42px]] imageright = [[File:Nuvola apps bookcase.svg|40px]] |
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This category lists articles about current and recent w:spaceflights. It is populated by the {{Current spaceflight}} template. |
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
Parameters
List of all parameters:
{{cmbox
| 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
| 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 is 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:Sub-arrows.svg|40px]]
- For example:
- none = Means that no image is used.
imageright
- No parameter = If no imageright parameter is given, no image is shown on the right side.
- An image = Should be an image with usual wiki notation. 40px - 50px width is 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]]
- For example:
- 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;
- For example:
textstyle
- An optional CSS value used by the text cell.
- For example:
textstyle = text-align: center;
- For example:
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>
}}
|
|
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
There are seven metatemplates in the Message box family:
- {{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.
