Template:Cmbox/doc: Difference between revisions
(→Usage: Complex example: Moved the text styling to the "textstyle" parameter.) |
(Ah well, perhaps {{verylarge}} and {{CatDiffuse}} should not be "move" purple.) |
||
Line 72: | 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 84: | Line 84: | ||
{{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 |
Revision as of 13:44, May 10, 2008
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 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 {{CategorisationDisputedPeople}}. |
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 value | textstyle = CSS value | 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. (Images over 52 pixels width will cause padding problems.) 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 on this side 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
This template currently uses hard coded styles. Later it will use CSS classes enabling it to be skinned.
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 |}}. |
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.
For more technical details see the talk page. Since this template works almost exactly like {{ambox}} and {{imbox}} their talk pages and related pages might also contain more details.
See also
- {{ambox}} – The meta-template for article message boxes.
- {{imbox}} – The meta-template for image space message boxes.