Template:Ivory messagebox/doc
 | This is a documentation subpage for Template:Ivory messagebox. It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 84,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
 | This template is used in system messages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. Please discuss any changes on the talk page before implementing them. |
The ivory messagebox 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 |1=Lorem ipsum [etc…] instead of merely |Lorem ipsum [etc…]:
{{Ivmbox|Lorem ipsum [etc…]}} which gives:
The template can display an image to the left of the text content. By default, the image will be 25px in width:
{{Ivmbox|Lorem ipsum [etc…]|Ambox notice.svg}}
 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
The image can be made smaller or larger using the |imagesize= parameter:
{{Ivmbox|Lorem ipsum [etc…]|Ambox notice.svg|imagesize=40px}}
| Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Curabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra, est eros bibendum elit, nec luctus magna felis sollicitudin mauris. Integer in mauris eu nibh euismod gravida. Duis ac tellus et risus vulputate vehicula. Donec lobortis risus a elit. Etiam tempor. Ut ullamcorper, ligula eu tempor congue, eros est euismod turpis, id tincidunt sapien risus a quam. Maecenas fermentum consequat mi. Donec fermentum. Pellentesque malesuada nulla a mi. Duis sapien sem, aliquet nec, commodo eget, consequat quis, neque. Aliquam faucibus, elit ut dictum aliquet, felis nisl adipiscing sapien, sed malesuada diam lacus eget erat. Cras mollis scelerisque nunc. Nullam arcu. Aliquam consequat. Curabitur augue lorem, dapibus quis, laoreet et, pretium ac, nisi. Aenean magna nisl, mollis quis, molestie eu, feugiat in, orci. In hac habitasse platea dictumst. |
Advanced use
By default, if an icon is used with Ivmbox, the icon will not be clickable (in MediaWiki image nomenclature, |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:
|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:
|image caption=Lorem ipsum
The background of an Ivmbox is the off-white X11 colour 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 |bg=; for example:
|bg=salmon for a salmon message box
|bg=#90EE90 for a #90EE90 (light green) message box.
See also
There are seven metatemplates in the Module:Message box family:
- {{Ambox}}, for messageboxes on article pages.
- {{Cmbox}}, for messageboxes on category pages.
- {{Imbox}}, for messageboxes on file (image) pages.
- {{Tmbox}}, for messageboxes on talk pages.
- {{Fmbox}}, for header and footer messageboxes.
- {{Ombox}}, for messageboxes on other types of page.
- {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.
Closely related metatemplates:
- {{Asbox}}, for messageboxes in article stubs.
- {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
- {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.
