View source for Template:Ivory messagebox/doc

{{Documentation subpage}}
{{High-use|65,000+}}
{{Template shortcut|Ivmbox}}
<!-- Categories at the bottom of this page, please -->

{| class="messagebox" style="background-color:#f3f3ff; border:1px solid; padding-left: 0.5em; padding-right: 0.5em"
| To leave an Ivmbox message with ''no'' icon:
*{{tlx|Ivmbox|Text to display in messagebox}}

To use this template ''with'' an icon, use:
* {{tlx|Ivmbox|Text to display|Ambox notice.svg}}
|}

The '''<u>iv</u>ory <u>m</u>essage<u>box</u>''' or '''Ivmbox''' is a simplistic, full-width box intended to surround important messages or notices. The ivory background of this template contrasts well to the white background used by most Wikipedia users on most Wikipedia pages (so it is noticeable enough to be used in notices or messages), but the background colour is not as garish as many other message boxes.

The basic use of the template is as follows. If the message you wish to convey using Ivmbox contains complex wiki-code or equals signs, it may be necessary to use {{para|1|Lorem ipsum [etc…]}} instead of merely {{para||Lorem ipsum [etc…]}}:

{{tlx|Ivmbox|Lorem ipsum [etc…]}} which gives:
{{Ivmbox|{{Lorem ipsum}}}}

The template can display an image to the left of the text content. By default, the image will be 25px in width:

{{tlx|Ivmbox|Lorem ipsum [etc…]|Ambox notice.svg}}
{{Ivmbox|{{Lorem ipsum}}|Ambox notice.svg}}

The image can be made smaller or larger using the {{para|imagesize}} parameter:

{{tlx|Ivmbox|Lorem ipsum [etc…]|Ambox notice.svg|imagesize{{=}}40px}}
{{Ivmbox|{{Lorem ipsum|2}}|Ambox notice.svg|imagesize=40px}}

===Advanced use===
By default, if an icon is used with Ivmbox, the icon will not be clickable (in [[Wikipedia:Extended image syntax|MediaWiki image nomenclature]], {{para|link}} will be declared but empty). If you wished, for example, clicking the image to lead to [[List of Prime Ministers of the United Kingdom]], you would include the following parameter:

{{para|image link|List of Prime Ministers of the United Kingdom}}

The image, by default, also has no caption; in a similar style, the caption can be declared by including the following parameter:

{{para|image caption|Lorem ipsum}}

The background of an Ivmbox is the off-white X11 colour [[Ivory (color)|ivory]]. If you like the functionality of Ivmbox but require it to display with a background other than the off-white ivory it uses by default, simply include the parameter {{para|bg}}; for example:

{{para|bg|salmon}} for a <span style="background: salmon; padding: 1px;">salmon</span> message box<br/>
{{para|bg|#90EE90}} for a <span style="background: #90EE90; padding: 1px;">#90EE90 (light green)</span> message box.

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

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- Categories below this line, please: -->
[[Category:Mbox and messagebox templates]]
}}</includeonly>