[purge]
This is the documentation page. It should be transcluded into the main template page. See Template:Documentation for more informationThe template returns a state of error, and optionally an error-message text in red (visible for the user).
Usage[]
The parameter |1= can be set to the error to display when using this template.
{{error|An exemplary error}}→ An exemplary error- Compare, used in a Parser Function:
{{#expr:Foo}}→ Expression error: Unrecognized word "foo".
If |1= is unset, no error will be displayed, although it still can be detected by {{#iferror:}}
{{error}}→
#iferror[]
The error displayed is detected by the parser function {{#iferror:}}.
{{#iferror: {{error|Foo}} | {{c|yes}} | {{c|no}} }}→ Yes{{#iferror: {{error}} | {{c|yes}} | {{c|no}} }}→ Yes
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 by most parsers, e.g. by {{#expr:}}.
| Code | Result |
|---|---|
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
|
ABC An exemplary error demo div XYZ
|
ABC {{error|An exemplary error demo p|tag=p}} XYZ
|
ABC An exemplary error demo p XYZ |
ABC {{error|An exemplary error demo strong|tag=strong}} XYZ
|
ABC An exemplary error demo strong XYZ |