Template:WarnAlt: Difference between revisions

From Caps Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 47: Line 47:
"custom_label": {
"custom_label": {
"label": "Custom Label",
"label": "Custom Label",
"description": "A custom label to be displayed before the message in boldface. This parameter must be placed after the severity, message, and size.",
"description": "A custom label to be displayed before the message in boldface. Required when ''severity'' is set to ''custom''.",
"example": "ACHTUNG",
"example": "ACHTUNG",
"type": "string",
"type": "string",
Line 54: Line 54:
"custom_icon": {
"custom_icon": {
"label": "Custom Icon",
"label": "Custom Icon",
"description": "An image file to be displayed as an icon before the label. Do not include ''File:''. Since the custom option displays in a blue theme, blue-colored icons are suggested.",
"description": "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.",
"example": "OOjs UI icon laptop-progressive.svg",
"example": "OOjs UI icon laptop-progressive.svg",
"type": "string",
"type": "string",

Revision as of 06:04, 17 February 2022

Error: The severity argument is required.

Create a warning box to get the users attention

[Edit template data]

Template parameters

ParameterDescriptionTypeStatus
Severity and Colorseverity 1

The severity of the warning that will also determine the color of the warning.

Suggested values
danger warning caution note custom
Default
caution
Stringrequired
Warning Box Sizesize 2

The size or type of the warning to be created.

Suggested values
large medium small
Default
large
Stringrequired
Displayed Textmessage 3

The text to be displayed in the warning box.

Example
Caps may retain charge after poweroff
Stringrequired
Custom Labelcustom_label

A custom label to be displayed before the message in boldface. Required when ''severity'' is set to ''custom''.

Example
ACHTUNG
Stringoptional
Custom Iconcustom_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.

Example
OOjs UI icon laptop-progressive.svg
Stringoptional