imported>Deadfire: /* Parameters */

2023-03-03T01:00:33Z

Parameters

New page

{{Documentation subpage}}

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

It is used to build message box templates for file (image) pages. 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.

===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 = delete
| text = type=delete – Deletion templates such as {{tl|Deletion}}.
}}
{{Imbox
| type = content
| text = type=content – Major warnings and problems, such as {{tl|non-free reduce}}.
}}
{{Imbox
| type = style
| text = type=style – Minor warnings and problems, such as {{tl|cleanup-image}}.
}}
{{Imbox
| type = notice
| text = type=notice – Notices and messages of any kind, both permanent and temporary.
}}
{{Imbox
| type = move
| text = type=move – Move and rename messages and proposals, such as {{tl|Requested move}}.
}}
{{Imbox
| type = protection
| text = type=protection – Protection templates such as {{tl|pp-protected}} when shown on an image page.
}}
{{Imbox
| type = license
| text = type=license – License templates such as {{tl|GFDL}}.
}}
{{Imbox
| type = featured
| text = type=featured – 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 image = <nowiki>[[File:Gnome-dev-camera.svg|42px]]</nowiki> This image is used for {{tl|cleanup-image}}.
}}
{{Imbox
| type = move
| image = [[File:To Commons.svg|52px]]
| text = type = move image = <nowiki>[[File:To Commons.svg|52px]]</nowiki> This image is used for {{tl|copy to Wikimedia Commons}}.
}}
{{Imbox
| type = license
| image = [[File:Heckert GNU white.svg|48px]]
| text = type = license image = <nowiki>[[File:Heckert GNU white.svg|48px]]</nowiki> 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]] [[File:Ambox warning yellow.svg|40px]]
| imageright = [[File:Shuttle.svg|30px]]
| text = type = license image = <nowiki>[[File:Imbox license.svg|40px]] [[File:Ambox warning yellow.svg|40px]]</nowiki> imageright = <nowiki>[[File:Shuttle.svg|30px]]</nowiki>
}}
{{Imbox
| type = license
| image = [[File:Imbox license.svg|40px]] [[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]].''' 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 image = <nowiki>[[File:Imbox license.svg|40px]]</nowiki> 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 [[w: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 [[w: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>

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

<includeonly>{{Sandbox other|
| 
[[Category:Mbox and messagebox templates]]
[[Category:File namespace templates|*]]
}}</includeonly>

Template:Imbox/doc - Revision history

imported>Deadfire: /* Parameters */