Template:WarnAlt: Difference between revisions

From Caps Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 16: Line 16:
               "warning",
               "warning",
      "caution",
      "caution",
      "note"
      "note",
      "custom"
        ],
        ],
"type": "string",
"type": "string",
Line 26: Line 27:
"label": "Warning Box Size",
"label": "Warning Box Size",
"description": "The size or type of the warning to be created.",
"description": "The size or type of the warning to be created.",
            "suggestedvalues": [
      "large",
              "medium",
      "small"
        ],
"type": "string",
"type": "string",
"default": "large",
"default": "large",
"deprecated": true,
"required": true,
"required": true,
             "aliases": [ "2" ]
             "aliases": [ "2" ]
Line 39: Line 44:
"required": true,
"required": true,
             "aliases": [ "3" ]
             "aliases": [ "3" ]
},
"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.",
"example": "ACHTUNG",
"type": "string",
"required": false
},
"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.",
"example": "OOjs UI icon laptop-progressive.svg",
"type": "string",
"required": false
}
}
},
},

Revision as of 06:01, 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. This parameter must be placed after the severity, message, and size.

Example
ACHTUNG
Stringoptional
Custom Iconcustom_icon

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.

Example
OOjs UI icon laptop-progressive.svg
Stringoptional