Template:Error/doc: Difference between revisions
Template page
More actions
examplified |
|||
| Line 2: | Line 2: | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
The template returns a ''state of error'' (recognized as such by a wiki [[Help:Parser function|parser function]]), and optionally an ''error-message text'' in red (visible for the user). | |||
=== Usage === | === Usage === | ||
* {{tlx|error|An exemplary error}} → {{error|An exemplary error}} | * {{tlx|error|An exemplary error}} → {{error|An exemplary error}} | ||
* Compare: <code><nowiki>{{#expr:Foo}}</nowiki></code> → {{#expr:Foo}} | * Compare, used in a Parser Function: <code><nowiki>{{#expr:Foo}}</nowiki></code> → {{#expr:Foo}} | ||
* <code><nowiki>{{#iferror:{{error|Foo}} | {{y}} | {{n}} }}</nowiki></code> → {{#iferror:{{error|Foo}} | {{y}} | {{n}} }} | * <code><nowiki>{{#iferror:{{error|Foo}} | {{y}} | {{n}} }}</nowiki></code> → {{#iferror:{{error|Foo}} | {{y}} | {{n}} }} | ||
===Tag option=== | |||
The tag to contain the error message can be given through the <code>tag</code> parameter, but it will only accept <code>span</code>, <code>div</code>, <code>p</code>, and <code>strong</code>, since those are the only tags recognized by the <code>#iferror</code> parser function. It defaults to <code>strong</code>, the tag generated e.g. by <code>#expre</code>. To prevent <code>strong</code> message, use one of the other tags, e.g. <code>tag=span</code>. | |||
* ABC {{tlx|error|An exemplary error demo no tag (default)}} XYZ → ABC {{error|An exemplary error demo no tag (default)}} XYZ | |||
* ABC {{tlx|error|An exemplary error demo span|3=tag=span}} XYZ → ABC {{error|An exemplary error demo span|tag=span}} XYZ | |||
* {{tlx|error|An exemplary error span|3=tag=span}} → {{error|An exemplary error span|tag=span}} | * ABC {{tlx|error|An exemplary error demo div|tag=div}} XYZ → ABC {{error|An exemplary error demo div|tag=div}} XYZ | ||
* {{tlx|error|An exemplary error div| | * ABC {{tlx|error|An exemplary error demo p|tag=p}} XYZ → ABC {{error|An exemplary error demo p|tag=p}} XYZ | ||
* {{tlx|error|An exemplary error p| | * ABC {{tlx|error|An exemplary error demo strong|tag=strong}} XYZ → ABC {{error|An exemplary error demo strong|tag=strong}} XYZ | ||
* {{tlx|error|An exemplary error strong| | |||
=== See also === | === See also === | ||
Revision as of 21:21, 1 September 2010
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).
Usage
- {{error|An exemplary error}} → An exemplary error
- Compare, used in a Parser Function:
{{#expr:Foo}}→ Expression error: Unrecognized 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 #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=span}} XYZ → ABC An exemplary error demo span XYZ
- ABC {{error|An exemplary error demo div}} XYZ → ABC An exemplary error demo divXYZ
- ABC {{error|An exemplary error demo p}} XYZ → ABC
An exemplary error demo p
XYZ - ABC {{error|An exemplary error demo strong}} XYZ → ABC An exemplary error demo strong XYZ
See also