Template:Ivory messagebox/doc: Difference between revisions
m (→Advanced use: ce) |
No edit summary |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{Template shortcut|Ivmbox}} | {{Template shortcut|Ivmbox}} | ||
<!-- Categories at the bottom of this page, please --> | <!-- Categories at the bottom of this page, please --> | ||
Line 30: | Line 29: | ||
===Advanced use=== | ===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 | 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 D'ni Kings]], you would include the following parameter: | ||
{{para|image link|List of | {{para|image link|List of D'ni Kings}} | ||
The image, by default, also has no caption; in a similar style, the caption can be declared by including the following parameter: | The image, by default, also has no caption; in a similar style, the caption can be declared by including the following parameter: | ||
Line 38: | Line 37: | ||
{{para|image caption|Lorem ipsum}} | {{para|image caption|Lorem ipsum}} | ||
The background of an Ivmbox is the off-white | The background of an Ivmbox is the off-white 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|salmon}} for a <span style="background: salmon; padding: 1px;">salmon</span> message box<br/> |
Latest revision as of 04:17, 11 July 2016
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. |
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}}
The image can be made smaller or larger using the |imagesize=
parameter:
{{Ivmbox|Lorem ipsum [etc…]|Ambox notice.svg|imagesize=40px}}
Advanced use[edit source]
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 D'ni Kings, you would include the following parameter:
|image link=List of D'ni Kings
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 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 |bg=
; for example:
|bg=salmon
for a salmon message box
|bg=#90EE90
for a #90EE90 (light green) message box.
See also[edit source]
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.