Template:Error/doc
 | This is a documentation subpage for Template:Error. It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
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}}→ An exemplary error{{error|message=An exemplary error}}→ An exemplary error- Compare, used in a Parser Function:
{{#expr:Foo}}→ Expression error: Unrecognised word "foo". {{#iferror:{{error|Foo}} | {{y}} | {{n}} }}→ Template: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 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 An exemplary error demo no tag (default) XYZ - ABC
{{error|An exemplary error demo span|tag=span}}XYZ → ABC An exemplary error demo span XYZ - ABC
{{error|An exemplary error demo div|tag=div}}XYZ → ABCAn exemplary error demo divXYZ - ABC
{{error|An exemplary error demo p|tag=p}}XYZ → ABCAn exemplary error demo p
XYZ - ABC
{{error|An exemplary error demo strong|tag=strong}}XYZ → ABC An exemplary error demo strong XYZ
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, "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>
See also