Vorlage:Imbox/Doku

This is the {{imbox}} or image message box meta-template.

It is used to build message box templates for image pages, such as {{cleanup-image}} 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.

Suggested style standard

The styles of image space message boxes and the usage of this template is currently being standardised and discussed on the talk page of this template. Thus don't use this meta-template for real image message boxes yet, but feel free to use it for testing.

When this template is used to build actual image message boxes they should contain the same (long) texts as before, with links to explanations and they can use more specific images than the default images shown here.

Usage

Simple usage example:

{{imbox | text = Some text.}}

Some text.

Complex example:

{{imbox
| type  = style
| image = [[Image:Emblem-question-yellow.svg|38px]]
| style = width: 400px; color: red; font-weight: bold; font-style: italic;
| text  = The message body text.
}}

The message body text.

Image 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

type=delete – Deletion templates such as

type=content – Major warnings and problems, such as

type=style – Minor warnings and problems, such as

type=notice – Notices and messages of any kind, both permanent and temporary.

type=move – Move and rename messages and proposals, such as

type=protection – Protection templates such as {{pp-protected}} when shown on an image page.

type=featured – Featured image templates such as

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.

(Under construction, come back in an hour.)

Special

Some other parameter combinations.

(Under construction, come back in an hour.)

Parameters

List of all parameters:

{{cmbox
| type  = speedy / delete / content / style / notice / 
          move / protection / license / featured
| image = none / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = CSS value
| text  = The message body text. 
| textstyle = CSS value
}}

type

If no type parameter is given the template defaults to type notice. That means it gets a blue border.

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;

text

The message body text.

textstyle

An optional CSS value used by the text cell. For example:

textstyle = text-align: center;

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:

{{imbox
| 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 |}}.

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 {{cmbox}} their talk pages and related pages might also contain more details.

See also

• {{ambox}} – The meta-template for article message boxes.
• {{cmbox}} – The meta-template for category message boxes.