Difference between revisions of "Template:Imbox/doc"

m (Fix wrong type names in examples)
m (Fixed type)
 
(2 intermediate revisions by the same user not shown)
Line 44: Line 44:
 
{{Imbox
 
{{Imbox
 
| type = warning
 
| type = warning
| text = type=<u>important</u><br />Use this admonition to alert the reader that the current setup will change or be altered, such as files being removed, and not to perform the operation unless fully aware of the consequences.  
+
| text = type=<u>warning</u><br />Use this admonition to alert the reader that the current setup will change or be altered, such as files being removed, and not to perform the operation unless fully aware of the consequences.  
 
}}
 
}}
  

Latest revision as of 00:33, 12 October 2016

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

Use it to highlight information.

  • Keep the statements as brief and to the point as possible.
  • Use admonitions sparingly so that they do not lose their effectiveness.



Usage

Example:

{{Imbox
| type = style
| text = The message body text.
}}



Image Message Box Types

The following examples use different type parameters:








Parameters

{{Imbox
| type  = note / important / warning / cleanup / protected
| style = CSS value
| textstyle = CSS value
| text  = The message body text.
}}

type

If no type parameter is given the template defaults to type notice. That means it gets a blue border.

style

An optional cascading style sheets (CSS) value used by the entire message box table. Without quotation marks " ". For example:
style = margin-bottom: 0.5em;

textstyle

An optional CSS value used by the text cell. For example:
textstyle = text-align: center;

text

The message body text.