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.

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 image 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 image 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:

{{imbox | text = Some text.}}

Some text.

Complex example:

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

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

type=delete – Deletion templates such as {{ifd}}.

type=content – Major warnings and problems, such as {{non-free reduce}}.

type=style – Minor warnings and problems, such as {{cleanup-image}}.

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

type=move – Move and rename messages and proposals, such as {{rename media}}.

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

type=featured – Featured image templates such as {{FeaturedPicture}}.

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.

type = style
image = [[Image:Gnome-dev-camera.svg|42px]]
This image is used for {{cleanup-image}}.

type = move
image = [[Image:To Commons.svg|52px]]
This image is used for {{copy to Wikimedia Commons}}.

Special

Some other parameter combinations.

No type and no image given (default)

No type and image=none – No image is used and the text uses the whole message box area.

Parameters

List of all parameters:

{{imbox
| 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
| 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 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:Gnome-dev-camera.svg|40px]]

none = Means that no image is used.

bigimage

yes = If the image above needs to be bigger then 52px, add this parameter to the template; it causes the image cell to adapt it's width to the image instead of using a static width of 52px.

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:

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