Template:SC/Error

Template documentation (for the above template, sometimes hidden or invisible)

The above text is transcluded from Template:SC/Error/doc; you can change it or view its history.
If you're done making changes, please refresh the text.
Please add categories and interwikis to Template:SC/Error/doc. (View all subpages of this page.)

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}} → Template:Error
• {{error|message=An exemplary error}} → Template:Error
• Compare, used in a Parser Function: {{#expr:Foo}} →
• {{#iferror:{{error|Foo}} | {{y}} | {{n}} }} → Template:N

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 Template:Pf parser function. It defaults to strong, the tag generated e.g. by Template:Pf. 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 Template:Error XYZ
• ABC {{error|An exemplary error demo span|tag=span}} XYZ → ABC Template:Error XYZ
• ABC {{error|An exemplary error demo div|tag=div}} XYZ → ABC Template:Error XYZ
• ABC {{error|An exemplary error demo p|tag=p}} XYZ → ABC Template:Error XYZ
• ABC {{error|An exemplary error demo strong|tag=strong}} XYZ → ABC Template:Error XYZ

TemplateData

<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, "suggested": true }, "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>