View source for Template:Imbox/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{High-use| 850,000+ }}
{{Lua|Module:Message box}}
{{Mbox templates (small)}}

This is the {{tl|Imbox}} (['''I''']mage ['''m''']essage ['''box''']) [[WP:MTM|metatemplate]].

It is used to build message box templates for file (image) pages, such as {{tl|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 {{tl|Ambox}} and uses the same parameters.
<!--
===We are deploying!===
After long discussion on the [[Template talk:Imbox|talk page]] of this template and at other places we are finally deploying this template. Feel free to convert any message boxes used on file 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:
<pre>
{{Imbox |text=Some text.}}
</pre>
{{Imbox |text=Some text.}}

Complex example:
<pre>
{{Imbox
| type = style
| style = width:400px;
| image = [[File:Emblem-question-yellow.svg|40px]]
| textstyle = font-style:italic; font-weight:bold; color:red; 
| text = The message body text.
}}
</pre>
{{Imbox
| type = style
| style = width:400px;
| image = [[File:Emblem-question-yellow.svg|40px]]
| textstyle = font-style:italic; font-weight:bold; color:red; 
| 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.

{{Imbox
| type = speedy
| text = type=<u>speedy</u> – Speedy deletion templates such as {{tl|isd}}.
}}
{{Imbox
| type = delete
| text = type=<u>delete</u> – Deletion templates such as {{tl|ifd}}.
}}
{{Imbox
| type = content
| text = type=<u>content</u> – Major warnings and problems, such as {{tl|non-free reduce}}.
}}
{{Imbox
| type = style
| text = type=<u>style</u> – Minor warnings and problems, such as {{tl|cleanup-image}}.
}}
{{Imbox
| type = notice
| text = type=<u>notice</u> – 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}}.
}}
{{Imbox
| type = protection
| text = type=<u>protection</u> – Protection templates such as {{tl|pp-protected}} when shown on an image page.
}}
{{Imbox
| type = license
| text = type=<u>license</u> – License templates such as {{tl|GFDL}}.
}}
{{Imbox
| type = featured
| text = type=<u>featured</u> – Featured image templates such as {{tl|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.

{{Imbox
| type = style
| image = [[File:Camera-photo.svg|40px]]
| text = type = style<br/>image = <nowiki>[[File:Gnome-dev-camera.svg|42px]]</nowiki><br/>This image is used for {{tl|cleanup-image}}.
}}
{{Imbox
| type = move
| image = [[File:To Commons.svg|52px]]
| text = type = move<br/>image = <nowiki>[[File:To Commons.svg|52px]]</nowiki><br/>This image is used for {{tl|copy to Wikimedia Commons}}.
}}
{{Imbox
| type = license
| image = [[File:Heckert GNU white.svg|48px]]
| text = type = license<br/>image = <nowiki>[[File:Heckert GNU white.svg|48px]]</nowiki><br/>This image is used for the GFDL license templates such as {{tl|GFDL}}.
}}

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

{{Imbox
| text = 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.
}}
{{Imbox
| type = license
| image = [[File:Imbox license.svg|40px]]<br/>[[File:Ambox warning yellow.svg|40px]]
| imageright = [[File:Shuttle.svg|30px]]
| text = type = license<br/>image = <nowiki>[[File:Imbox license.svg|40px]]&lt;br/>[[File:Ambox warning yellow.svg|40px]]</nowiki><br/>imageright = <nowiki>[[File:Shuttle.svg|30px]]</nowiki>
}}
{{Imbox
| type = license
| image = [[File:Imbox license.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.
}}
{{Imbox
| type = license
| image = [[File:Imbox license.svg|40px]]
| text =
type = license<br/>image = <nowiki>[[File:Imbox license.svg|40px]]</nowiki><br/>below = <nowiki>{{Imbox |type=content |text='''This license tag is deprecated!'''}}</nowiki>
| below = {{Imbox |type=content |text='''This license tag is deprecated!'''}}
}}

===Parameters===
List of all parameters:

<pre>
{{Imbox
| name = name of the template
| 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
}}
</pre>

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

'''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:
::<code><nowiki>image = [[File:Gnome-dev-camera.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.
:'''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:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.

'''style'''
:An optional [[Cascading Style Sheets|CSS]] value used by the entire message box table. Without quotation marks <code>" "</code>. For example:
::<code>style = margin-bottom: 0.5em;</code>

'''textstyle'''
:An optional [[Cascading Style Sheets|CSS]] value used by the text cell. For example:
::<code>textstyle = text-align: center;</code>

'''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:
::<code><nowiki>below = {{Imbox |type=content |text=This license tag is deprecated.}}</nowiki></code>

'''plainlinks'''
:Defaults to yes. If external link arrows - [[File:External.svg|10px]] - are desired, specify:
::<code><nowiki>plainlinks = no</nowiki></code>

===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:
<syntaxhighlight lang="tid">
{{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>
}}
</syntaxhighlight>
{{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>
}}

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 [[m:Help: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 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.

For more technical details see the [[Template talk:Imbox|talk page]]. Since this template works almost exactly like the other mboxes their talk pages and related pages might also contain more details, see the "See also" section below.

===See also===
{{Mbox templates see also}}

<includeonly>{{Sandbox other|
| <!-- CATEGORIES BELOW THIS LINE, PLEASE -->
[[Category:Mbox and messagebox templates]]
[[Category:File namespace templates|*]]
}}</includeonly>