Template:WarnAlt: Difference between revisions
(spacing not needed) Tag: Manual revert |
m (Add templatedata on parameters) |
||
Line 9: | Line 9: | ||
<noinclude> | <noinclude> | ||
{{WarnAlt/doc}} | {{WarnAlt/doc}} | ||
</noinclude> | <templatedata> | ||
{ | |||
"params": { | |||
"Size": { | |||
"label": "Warning Box Size", | |||
"description": "The size or type of the warning to be created", | |||
"example": "Full, Small, Line", | |||
"type": "string", | |||
"default": "Full", | |||
"deprecated": true, | |||
"required": true | |||
}, | |||
"Severity": { | |||
"label": "Severity and Color", | |||
"description": "The severity of the warning that will also determine the color of the warning. ", | |||
"example": "Danger, Caution, Note", | |||
"type": "string", | |||
"default": "Caution", | |||
"required": true | |||
}, | |||
"Message": { | |||
"label": "Displayed Text", | |||
"description": "The text to be displayed in the warning box", | |||
"example": "Caps may retain charge after poweroff", | |||
"type": "string", | |||
"required": true | |||
} | |||
}, | |||
"description": "Create a warning box to get the users attention" | |||
} | |||
</templatedata></noinclude> |
Revision as of 14:51, 13 February 2022
The severity argument is required.
Documentation
This template is an intended replacement for the {{warn}}
template. It has four different severity levels and three different sizes, which are demonstrated here.
Syntax
For the source editor, the syntax is {{WarnAlt|<note|caution|warning|danger>|<large|medium/med|small>|<message>}}
.
The visual editor provides a nice popup box where you can fill in all the data, but the same arguments apply.
TemplateData
Create a warning box to get the users attention
Parameter | Description | Type | Status | |
---|---|---|---|---|
Severity and Color | severity 1 | The severity of the warning that will also determine the color of the warning.
| String | required |
Warning Box Size | size 2 | The size or type of the warning to be created.
| String | required |
Displayed Text | message 3 | The text to be displayed in the warning box.
| String | required |
Custom Label | custom_label | A custom label to be displayed before the message. Required when ''severity'' is set to ''custom''.
| String | optional |
Custom Icon | custom_icon | An image file to be displayed as an icon before the label. Required when ''severity'' is set to ''custom''. Do not include ''File:''. Since the custom option displays in a blue theme, blue-colored icons are suggested.
| String | optional |
Create a warning box to get the users attention
Parameter | Description | Type | Status | |
---|---|---|---|---|
Warning Box Size | Size | The size or type of the warning to be created
| String | deprecated |
Severity and Color | Severity | The severity of the warning that will also determine the color of the warning.
| String | required |
Displayed Text | Message | The text to be displayed in the warning box
| String | required |