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 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
Template documentation[create]
An exemplary error}}
→ An exemplary error
- Compare, used in a Parser Function:
{{#expr:Foo}}
→ Expression error: Unrecognized word "foo". {{#iferror:{{error|Foo}} | {{y}} | {{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 #iferror
parser function. It defaults to strong
, the tag generated e.g. by #expre
. 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
Template documentation[create]
span}}
XYZ → ABC An exemplary error demo span XYZ
- ABC
{{error|An exemplary error demo div|tag
Template documentation[create]
div}}
XYZ → ABC
XYZ
- ABC
{{error|An exemplary error demo p|tag
Template documentation[create]
p}}
XYZ → ABC
An exemplary error demo p
XYZ
- ABC
{{error|An exemplary error demo strong|tag
Template documentation[create]
strong}}
XYZ → ABC An exemplary error demo strong XYZ
Template data
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)
Parameter | Description | Type | Status | |
---|---|---|---|---|
Message | 1 | Error message text in red | String | optional |
Tag | tag | 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
| String | optional |
See also
- Template:TryCatch
- Template:Formatting error
- Help:Parser function
- mw:Help:Extension:ParserFunctions##iferror: