Template:Imbox/doc

Usage

This is the Template:Tl or image message box meta-template.

It is used to build message box templates for file (image) pages, such as Template:Tl 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 Template:Tl and uses the same parameters.

Usage

Simple usage example

Some text.

{{imbox | text = Some text.}}

Complex example

The message body text.

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

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.

These are some examples, and the templates linked to are mostly shortcuts. They are not included.

{{Imbox
| type = speedy
| text = type=<u>speedy</u> – Speedy deletion templates such as {{tl|isd}}.
}}

type=speedy – Speedy deletion templates such as Template:Tl.

{{Imbox
| type = delete
| text = type=<u>delete</u> – Deletion templates such as {{tl|ifd}}.
}}

type=delete – Deletion templates such as Template:Tl.

{{Imbox
| type = content
| text = type=<u>content</u> – Major warnings and problems, such as {{tl|non-free reduce}}.
}}

type=content – Major warnings and problems, such as Template:Tl.

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

type=style – Minor warnings and problems, such as Template:Tl.

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

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

{{Imbox
| type = move
| text = type=<u>move</u> – Move and rename messages and proposals, such as {{tl|Requested move}}.
}}

type=move – Move and rename messages and proposals, such as Template:Tl.

{{Imbox
| type = protection
| text = type=<u>protection</u> – Protection templates such as {{tl|pp-protected}} when shown on an image page.
}}

type=protection – Protection templates such as Template:Tl when shown on an image page.

{{Imbox
| type = license
| text = type=<u>license</u> – License templates such as {{tl|GFDL}}.
}}

type=license – License templates such as Template:Tl.

{{Imbox
| type = featured
| text = type=<u>featured</u> – Featured image templates such as {{tl|FeaturedPicture}}.
}}

type=featured – Featured image templates such as Template:Tl.

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.

{{Imbox
| type = style
| image = [[File:Camera-photo.svg|40px]]
| text = type = style<br/>image = [[File:Gnome-dev-camera.svg|42px]]<br/>This image is used for {{tl|cleanup-image}}.
}}

type = style
image = [[File:Gnome-dev-camera.svg|42px]]
This image is used for Template:Tl.

{{Imbox
| type = move
| image = [[File:To Commons.svg|52px]]
| text = type = move<br/>image = [[File:To Commons.svg|52px]]<br/>This image is used for {{tl|copy to Wikimedia Commons}}.
}}

type = move
image = [[File:To Commons.svg|52px]]
This image is used for Template:Tl.

{{Imbox
| type = license
| image = [[File:Heckert GNU white.svg|48px]]
| text = type = license<br/>image = [[File:Heckert GNU white.svg|48px]]<br/>This image is used for the GFDL license templates such as {{tl|GFDL}}.
}}

type = license
image = [[File:Heckert GNU white.svg|48px]]
This image is used for the GFDL license templates such as Template:Tl.

Special

Some other parameter combinations.

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

No type and no image given (default)

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

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

{{Imbox
| type = license
| image = [[File:PD-icon.svg|40px]]<br/>[[File:Ambox warning yellow.svg|40px]]
| imageright = [[File:Shuttle.svg|30px]]
| text = type = license<br/>image = [[File:PD-icon.svg|40px]]<br/>[[File:Ambox warning yellow.svg|40px]]<br/>imageright = [[File:Shuttle.svg|30px]]
}}

type = license
image = [[File:PD-icon.svg|40px]]<br/>[[File:Ambox warning yellow.svg|40px]]
imageright = [[File:Shuttle.svg|30px]]

{{Imbox
| type = license
| image = [[File:PD-icon.svg|40px]]<br/>[[File:Ambox warning yellow.svg|40px]]
| imageright = [[File:Shuttle.svg|30px]]
| text = '''This file is in the [[public domain]] because it was created by [[NASA]].'''<br/>Note that use of NASA logos, insignia and emblems are restricted per US law.
}}

This file is in the public domain because it was created by NASA.
Note that use of NASA logos, insignia and emblems are restricted per US law.

{{Imbox
| type = license
| image = [[File:PD-icon.svg|40px]]
| text =
type = license<br/>image = [[File:PD-icon.svg|40px]]<br/>below = {{Imbox |type=content |text='''This license tag is deprecated!'''}}
| below = {{Imbox |type=content |text='''This license tag is deprecated!'''}}
}}

type = license
image = [[File:PD-icon.svg|40px]]
below = {{Imbox |type=content |text='''This license tag is deprecated!'''}}

This license tag is deprecated!

Parameters

List of all parameters:

{{imbox
| type  = speedy / delete / content / style / notice / 
          move / protection / license / featured
| image = none / [[File:Some image.svg|40px]]
| imageright = [[File:Some image.svg|40px]]
| style = CSS value
| textstyle = CSS value
| text  = The message body text.
| below = More text or another imbox.
| plainlinks = no
}}

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. (But the message box can handle images of any size.) For example:

image = [[File:Gnome-dev-camera.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 the message box can handle images of any size.) For example:

imageright = [[File: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.

below

A full width area below the images and text area. Can take a text or any kind of object, for instance another imbox:

below = {{imbox | type = content | text = This license tag is deprecated. }}

plainlinks

Defaults to yes. If external link arrows - - are desired, specify:

plainlinks = no

Technical details

Namespace "Image:" was renamed to "File:" on 11 December 2008. This template was created long before that, and that is why it is named "imbox" as in "image message box".

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

This template uses the imbox CSS classes in 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 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 png images. For those older browsers these png images have been modified so that the color of their default backgrounds match the background color of the template. The default background that MediaWiki renders for svg images is always white. This creates a white box around the images when displayed in older browsers.