View source for Template:Cmbox/doc

{{Documentation subpage}}
{{Lua|Module:Message box}}
__NOTOC__

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

It is used to build message box templates such as {{tl|Tracking category}} 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 ===
{{tj|cmbox|text {{=}} Some text.}}

{{cmbox|text = Some text.}}

=== Complex example ===
{{tj|cmbox
  | type: style
  | image: {{!(n(}}File:Content.png{{!}}40px]]
  | style: width: 400px; 
  | textstyle: color: red; font-weight: bold; font-style: italic;
  | text: The message body text.
}}

{{cmbox
| type = style
| image = [[File:Content.png|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
| nocat= true
| type = speedy
| text = type=<u>speedy</u> – Speedy deletion templates.
}}

{{cmbox
| nocat= true
| type = delete
| text = type=<u>delete</u> – Deletion templates.
}}

{{cmbox
| nocat= true
| type = content
| text = type=<u>content</u> – Major warnings and problems.
}}

{{cmbox
| nocat= true
| type = style
| text = type=<u>style</u> – Minor warnings and problems.
}}

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

{{cmbox
| nocat= true
| type = move
| text = type=<u>move</u> – Move, merge, and split messages.
}}

{{cmbox
| nocat= true
| 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
| type  = style
| image = [[File:Cd.png|40px]]
| text  = type = style<br />image = <nowiki>[[File:CD.png|40px]]</nowiki>.
}}

{{cmbox
| type  = move
| image = [[File:Redirect.png|52px]]
| text  = type = move<br />image = <nowiki>[[File:redirect.png|52px]]</nowiki>.
}}


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

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

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

{{cmbox
| image = [[File:Cd.png|42px]]
| imageright = [[File:Sound Wave.png|40px]]
| text  = image = <nowiki>[[File:Cd.png|42px]]</nowiki><br />imageright = <nowiki>[[File:Sound Wave.png|40px]]</nowiki>
}}

{{cmbox
| image = [[File:Cd.png|42px]]
| imageright = [[File:Speaker.png|20px]]
| text  = '''This category lists BLCD titles released in 2008.'''
}}


== Parameters ==

=== List of all parameters ===

{{tj|cmbox
| name: name of the template
| type: speedy / delete / content / style / notice / move / protection
| image: none / {{!(n(}}File:Some image.png{{!}}40px]]
| imageright: {{!(n(}}File:Some image.png{{!}}40px]]
| class: A custom CSS class to apply to the box
| style: CSS values
| textstyle: CSS values
| plainlinks: no
| text: The message body text.
}}

; {{para|name}} : (Optional) Name of the template. This adds a CSS class with name <code>box-''name''</code> to the HTML element, for use by bots or scripts.

; {{para|type}} : If no '''type''' parameter is given the template defaults to type '''notice'''. That means it gets a gray border.

; {{para|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: 
:: <code><nowiki>image = [[File:Redirect.png|40px]]</nowiki></code>
: '''none''' = Means that no image is used.

; {{para|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: 
:: <code><nowiki>imageright = [[File:Sound Wave.png|40px]]</nowiki></code>
: '''Anything''' = Any other object that you want to show on the right side.

; {{para|style}}
: Optional [[Wikipedia:Cascading Style Sheets|CSS]] values used by the entire message box table. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
:: <code>style = margin-bottom: 0.5em;</code>

; {{para|textstyle}}
: Optional [[Wikipedia:Cascading Style Sheets|CSS]] values used by the text cell. For example:
:: <code>textstyle = text-align: center;</code>

; {{para|plainlinks}}
: Normally, 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}}.

; {{para|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 <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 gets it CSS from the [[Module:Message box/cmbox.css|Message box Module]] 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 [[mw: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 [[Wikipedia: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 Also ==
* {{tl|Ambox}}
* {{tl|Ombox}}

<includeonly>{{sandbox other||{{testcases other||

<!-- Categories below this line, please -->
[[Category:Templates]]
[[Category:Mbox templates]]
}}}}</includeonly>