SockyPaws: Create template documentation page

2024-11-23T20:26:54Z

Create template documentation page

New page

{{Documentation subpage}}
{{Lua|Module:Message box}}
{{Mbox templates (small)}}
This is the {{Template link general|plaincode=on|Imbox}} ('''I'''mage '''m'''essage '''box''') metatemplate that is used to build message box templates for file (image) pages. It offers several different colors, uses default images if no image parameter is given and has some other features as well.

This template works near-identically to {{Template link general|plaincode=on|Ambox}} and uses the same parameters.

== Examples ==
=== Simple ===
{{Template link general|code=on|Imbox|2=text={{Var|Some text.}}}} ⮷
{{Imbox|text=Some text.}}

=== Complex ===
{{Template link general|code=on|Imbox|2=type=style|3=image=[[File:Emblem-question-yellow.svg|40px]]|4=style=width: 400px;|5=textstyle=color: #f00; font-style: italic; font-weight: 700;|6=text=The message body text.}}
{{Imbox|type=style|image=[[File:Emblem-question-yellow.svg|40px]]|style=width: 400px;|textstyle=color: #f00; font-style: italic; font-weight: 700;|text=The message body text.}}

== Usage ==
=== Image message box types ===
The following examples use different '''{{Code|type}}''' parameters but no image parameters, thus they use the default images for each type.
{{Imbox|type=speedy|text=type=speedy – the type designed to draw the most attention.}}
{{Imbox|type=delete|text=type=delete – very similar to speedy, minus the red background.}}
{{Imbox|type=content|text=type=content – for major warnings and problems.}}
{{Imbox|type=style|text=type=style – for minor warnings and problems.}}
{{Imbox|type=notice|text=type=notice a versatile type for notices and messages of any kind, both permanent and temporary.}}
{{Imbox|type=move|text=type=move – for important but short-lived situations, such as page move and rename proposals.}}
{{Imbox|type=protection|text=type=protection – ideal for long-term or permanent information about pages.}}
{{Imbox|type=license|text=type=license – for internal wiki functions, like licenses on page in File: namespace (e.g. {{Template link general|plaincode=on|GFDL}}.}}
{{Imbox|type=featured|text=type=featured – for announcements and helpful messages targeted mostly towards readers and less so fellow editors.}}

=== Custom images ===
The default images shown above are mostly for convenience. In many cases, it is more appropriate to use an image more specifically related to the message being displayed. These examples use the '''{{Code|image}}''' parameter to specify an image other than the default.
{{Imbox|type=style|image=[[File:Zoowiki zetapin logo.png|x48px]]|text=type=style image=<nowiki>[[File:Zoowiki zetapin logo.png|x48px]]</nowiki>}}
{{Imbox|type=move|image=[[File:Zeta templatelogo.png|x48px]]|text=type=move image=<nowiki>[[File:Zeta templatelogo.png|x48px]]</nowiki>}}
{{Imbox|type=license|image=[[File:Mlogo.png|48px]]|text=type=license image=<nowiki>[[File:Mlogo.png|48px]]</nowiki>}}

=== Special ===
Some other parameter combinations…
{{Imbox|text=No type and no image given ('''default''')}}
{{Imbox|image=none|text=No type and '''{{Para|image|none}}''' – No image is used and the '''{{Para|text}}''' uses the whole message box area.}}
{{Imbox|type=license|image=[[File:PD-icon.svg|x36px]] [[File:Ambox warning yellow.svg|x36px]]|imageright=[[File:Mike.png|x72px]]|text=type=license image=<nowiki>[[File:PD-icon.svg|x36px]] [[File:Ambox warning yellow.svg|x36px]]</nowiki> imageright=<nowiki>[[File:Mike.png|x72px]]</nowiki>}}
{{Imbox|type=license|image=[[File:PD-icon.svg|x40px]]|below={{Imbox|type=content|text='''This license tag is deprecated!'''}}|text=type=license image=<nowiki>[[File:PD-icon.svg|x40px]]</nowiki> below=<nowiki>{{Imbox|type=content|text='''This license tag is deprecated!'''}}</nowiki>}}

=== Parameters ===
A list of all the template parameters:
<pre style="margin-left: 3em; max-width: 37.5vw; overflow: auto;">
{{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(s)
| textstyle = CSS value(s)
| text = The message body text.
| below = More text, or another Imbox.
| plainlinks = no
}}
</pre>

; {{Para|name}} : (optional) The name of the template. This adds a CSS class with the name {{Code|box-{{Var|name}}}} to the HTML box element, for use by bots or scripts.
; {{Para|type}} : If no {{Code|type}} parameter is given, the template defaults to type '''{{Code|notice}}'''. That means it gets a blue border.
; {{Para|image}} : '''No parameter''' ⟹ If no '''image''' parameter is given, the template uses a default image. Which default image it uses depends on the {{Code|type}} parameter.
: '''An image''' ⟹ Should be an image within the usual wiki 'File:' notation; 40–50px in width is usually about right, depending on the image's aspect ratio (but the message box can handle images of any size). For example:
:: {{Code|<nowiki>image=[[File:Gnome-dev-camera.svg|40px]]</nowiki>}}
: '''{{Para|image|none}}''' ⟹ Which means that an image is used.
; {{Para|imageright}} : '''No parameter''' ⟹ If no {{Code|imageright}} parameter is given, then no image is shown on the right side.
: '''An image''' ⟹ This should be an image within the usual wiki 'File:' notation; 40–50px in width is usually about right, depending on the image's aspect ratio (but the message box can handle images of any size). For example:
:: {{Code|<nowiki>imageright=[[File:Nuvola apps bookcase.png|40px]]</nowiki>}}
: '''Anything''' ⟹ Any other object that you want to show on the right side of the message box.
; {{Para|style}} : Optional [[wikipedia:Cascading Style Sheets|CSS]] property declarations, used by the entire message box table; not enclosed in quotation marks ({{Code|" "}} but each terminated with a semicolon ({{Code|;}}). For example:
:: {{Code|1=style=margin-bottom: 0.5em;}}
; {{Para|textstyle}} : Optional [[wikipedia:Cascading Style Sheets|CSS]] property declarations, used only by the ''text'' cell of the message box table. For example:
:: {{Code|1=textstyle=text-align: center;}}
; {{Para|text}} : The message body text.
; {{Para|below}} : A full-width area below the images and text area; it can take text or any kind of object, or even another Imbox.
:: {{Code|<nowiki>below={{Imbox|type=content|text=This license tag is deprecated.}}</nowiki>}}
; {{Para|plainlinks}} : (default: {{Code|yes}}) If external link arrows ([[File:External.svg|10px]]) are desired, specify:
:: {{Para|plainlinks|no}}

== Technical details ==
The 'Image:' namespace was renamed to 'File:' on {{#formatdate:2008-12-11|mdy}}, however this template long predates that, which 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:
<pre style="margin-left: 3em; max-width: 40vw; overflow: auto;">
{{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 {{))}}.
And now a pipe and end braces {{!))}}.</div>
}}
</pre>
{{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 }}. And now a pipe and end braces |}}.</div>}}

This template uses the {{Code|imbox}} CSS classes in [[mediawikiwiki:Module:Message box/imbox.css|Module:Message box/imbox.css]] for most of its styling, 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 meta-templates are coded since wiki markup has several limitations. For instance, it makes it harder to use [[mediawikiwiki:Help:ParserFunctions|parser functions]] and special characters in parameters.

The default images for this meta-template are (mostly) in PNG format instead of the newer SVG. The main reason is that some older web browsers have trouble with the transparent SVG images. For those older browsers, these PNG images have been modified so that the color of their default background matches the background color of the template. The default background that the MediaWiki parser renders for SVG images is always pure white, and that creates a white box around the images when displayed in older browsers.

For more technical details, see the [[wikipedia:Template talk:Imbox|talk page]]. Since this template works almost exactly like the other message boxes, their talk pages and related pages might also contain useful information; see the [[#See also|§ See also]] section below.

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

<includeonly>{{Sandbox other||
[[Category:File copyright templates|{{PAGENAME}}]]
[[Category:File namespace templates|*]]
[[Category:Message box templates]]
}}</includeonly>

Template:Imbox/doc - Revision history

SockyPaws: Create template documentation page