Template:Error/doc

This meta template returns a state of error (recognized as such by a wiki parser function), and optionally an error-message text in red (visible for the user). It is used by other templates to signal an error, for example invalid input, which can then either be displayed to the editor or caught and handled by other templates.

Usage

• {{error|An exemplary error}} →
• {{error|message=An exemplary error}} →
• Compare, used in a Parser Function: {{#expr:Foo}} →
• {{#iferror:{{error|Foo}} | {{y}} | {{n}} }} → Y

Tag option

The tag to contain the error message can be given through the tag parameter, but it will only accept span, div, p, and strong, since those are the only tags recognized by the {{#iferror}} parser function. It defaults to strong, the tag generated e.g. by {{#expr}}. To prevent strong message, use one of the other tags, e.g. tag=span.

• ABC {{error|An exemplary error demo no tag (default)}} XYZ → ABC XYZ
• ABC {{error|An exemplary error demo span|tag=span}} XYZ → ABC XYZ
• ABC {{error|An exemplary error demo div|tag=div}} XYZ → ABC XYZ
• ABC {{error|An exemplary error demo p|tag=p}} XYZ → ABC XYZ
• ABC {{error|An exemplary error demo strong|tag=strong}} XYZ → ABC XYZ

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Error

<TemplateData> {

       "description": "The template returns a state of error (recognized as such by a wiki parser function), and optionally an error-message text in red (visible for the user)",
       "params": {
               "1": {
                       "label": "Message",
                       "description": "Error message text in red",
                       "type": "string",
                       "required": false
               },
               "tag": {
                       "label": "Tag",
                       "description": "The tag to contain the error message; will only accept span, div, p, and strong, since those are the only tags recognized by the #iferror parser function. It defaults to strong, the tag generated e.g. by #expre",
                       "type": "string",
                       "default": "strong",
                       "required": false
               }
       }

} </TemplateData>

See also

• {{Error-small}}
• {{Formatting error}}
• #iferror: parser function