Vorlage:Cmbox/Doku: Unterschied zwischen den Versionen

{{mbox templates}}

This is the {{tl|cmbox}} or '''category message box''' meta-template.

=== We are deploying! ===

After long discussion on the [[Template talk:Cmbox|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.

=== Usage ===

Simple usage example:

{{cmbox | text = Some text.}}

Complex example:

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

| type = content

}}

{{cmbox

| text = type=<u>style</u> – Minor warnings and problems, such as {{tl|popcat}}.

}}

{{cmbox

| type = notice

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

=== Special ===

Some other parameter combinations.

=== Parameters ===

List of all parameters:

| image = none / [[Image:Some image.svg|40px]]

| imageright = [[Image:Some image.svg|40px]]

| text  = The message body text.  

}}

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

::<code><nowiki>image = [[Image:Sub-arrows.svg|40px]]</nowiki></code>

:'''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.

::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code>

:'''Anything''' = Any other object that you want to show on the right side.

=== Technical details ===

If you need to use special characters in the text parameter then you need to escape them like this:  

</div>

}}

This template uses the cmbox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.

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.

=== See also ===

<includeonly>

</includeonly>