Template:WarnAlt: Difference between revisions
(add message argument) |
(testing) |
||
| Line 2: | Line 2: | ||
{{#switch: {{{severity| {{{1|}}} }}} | {{#switch: {{{severity| {{{1|}}} }}} | ||
| #default = The severity argument is required. | | #default = The severity argument is required. | ||
| note|1 = {{User:lyiriyah/sandbox/warn/note| {{{size| {{{2|}}} }}} | {{{message {{{3|}}} }}} }} | | note|1 = {{User:lyiriyah/sandbox/warn/note| {{{size| {{{2|}}} }}} | {{{message| {{{3|}}} }}} }} | ||
| caution|2 = {{User:lyiriyah/sandbox/warn/caution| {{{size| {{{2|}}} }}} | {{{message {{{3|}}} }}} }} | | caution|2 = {{User:lyiriyah/sandbox/warn/caution| {{{size| {{{2|}}} }}} | {{{message| {{{3|}}} }}} }} | ||
| warning|3 = {{User:lyiriyah/sandbox/warn/warning| {{{size| {{{2|}}} }}} | {{{message {{{3|}}} }}} }} | | warning|3 = {{User:lyiriyah/sandbox/warn/warning| {{{size| {{{2|}}} }}} | {{{message| {{{3|}}} }}} }} | ||
| danger|4 = {{User:lyiriyah/sandbox/warn/danger| {{{size| {{{2|}}} }}} | {{{message {{{3|}}} }}} }} | | danger|4 = {{User:lyiriyah/sandbox/warn/danger| {{{size| {{{2|}}} }}} | {{{message| {{{3|}}} }}} }} | ||
}} | }} | ||
<noinclude> | <noinclude> | ||
{{User:lyiriyah/sandbox/warn/doc}} | {{User:lyiriyah/sandbox/warn/doc}} | ||
</noinclude> | </noinclude> | ||
Revision as of 14:38, 11 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 |