Editing Template:Cmbox/doc

{{Mbox templates}}
{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Lua|Module:Message box{{\sandbox}}}}
{{Uses TemplateStyles|Module:Message box/ambox.css}}

This is the {{tl|Cmbox}} (['''C''']ategory ['''m''']essage ['''box''']) metatemplate.

It is used to build message box templates 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 {{tl|Ambox}} and uses the same parameters.

=== Usage ===
Simple usage example:
<pre>
{{cmbox | text = Some text.}}
</pre>

{{cmbox{{\sandbox}} | text = Some text.}}


Complex example:
<pre>
{{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.
}}
</pre>

{{cmbox{{\sandbox}}
| 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.
}}


=== 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.

{{cmbox{{\sandbox}}
| type = speedy
| text = type=<u>speedy</u> – Speedy deletion templates such as {{tl|db-c1}}.
}}

{{cmbox{{\sandbox}}
| type = delete
| text = type=<u>delete</u> – Deletion templates such as {{tl|cfd}}.
}}

{{cmbox{{\sandbox}}
| type = content
| text = type=<u>content</u> – Major warnings and problems such as {{tl|Categorization of people disputed}}.
}}

{{cmbox{{\sandbox}}
| type = style
| text = type=<u>style</u> – Minor warnings and problems such as {{tl|Underpopulated category}}.
}}

{{cmbox{{\sandbox}}
| type = notice
| text = type=<u>notice</u> – Notices and messages of any kind, both permanent and temporary.
}}

{{cmbox{{\sandbox}}
| type = move
| text = type=<u>move</u> – Move, merge, and split messages and proposals such as {{tl|Category redirect}}.
}}

{{cmbox{{\sandbox}}
| type = protection
| text = type=<u>protection</u> – Protection templates such as {{tl|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.

{{cmbox{{\sandbox}}
| type  = style
| image = [[File:Sub-arrows.svg|40px]]
| text  = type = style<br />image = <nowiki>[[File:Sub-arrows.svg|40px]]</nowiki><br />This image is used for {{tl|Very large}} and {{tl|Category diffuse}}.
}}

{{cmbox{{\sandbox}}
| type  = move
| image = [[File:Redirect arrow.svg|52px]]
| text  = type = move<br />image = <nowiki>[[File:Redirect arrow.svg|52px]]</nowiki><br />This image is used for {{tl|Category redirect}}.
}}


=== Special ===
Some other parameter combinations.

{{cmbox{{\sandbox}}
| text  = No type and no image given ('''default''')
}}

{{cmbox{{\sandbox}}
| image = none
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}

{{cmbox{{\sandbox}}
| image = [[File:Gnome globe current event.svg|42px]]
| imageright = [[File:Nuvola apps bookcase.svg|40px]]
| text  = image = <nowiki>[[File:Gnome globe current event.svg|42px]]</nowiki><br />imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki>
}}

{{cmbox{{\sandbox}}
| image = [[File:Gnome globe current event.svg|42px]]
| imageright = [[File:Shuttle.svg|20px]]
| text  = '''This category lists articles about current and recent [[w:Spaceflight|spaceflights]].'''<br />It is populated by the {{tl|Current spaceflight}} template.
}}


=== Parameters ===
List of all parameters:
<pre>
{{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
| plainlinks  = no
| text  = The message body text.
}}
</pre>

'''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: <code><nowiki>image = [[File:Sub-arrows.svg|40px]]</nowiki></code>
:'''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: <code><nowiki>imageright = [[File:Nuvola apps bookcase.svg|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.

'''style'''
:An optional [[w: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>

'''textstyle'''
:An optional [[w:Cascading Style Sheets|CSS]] value used by the text cell.
::For example: <code>textstyle = text-align: center;</code>

'''plainlinks'''
:Normally on Wikipedia, external links have an arrow icon next to them, like this: [http://www.example.com Example.com]. However, in message boxes, the arrow icon is suppressed by default, like this: <span class="plainlinks">[http://www.example.com Example.com]</span>. To get the normal style of external link with the arrow icon, use {{para|plainlinks|no}}.

'''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:
<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 &lt;nowiki>}}&lt;/nowiki>. 
And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki>.
</div>
}}
</pre>

{{cmbox{{\sandbox}}
| 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 {{Blue|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 [[Help:Extension: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|See also]] section below).

== TemplateData ==
{{Mbox/TemplateData}}
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Mbox templates{{#translation:}}]]
}}</includeonly>