Template:Error/doc: Difference between revisions
meta>Mr. Stradivarius remove Category:Lua-based templates, as it is added by the {{lua}} template - see Wikipedia talk:Lua#Lua talk template |
meta>Hyacinth {{clarify|date=August 2013|where is this used or why would one use this template?}} |
||
Line 3: | Line 3: | ||
<!-- 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). | 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).{{clarify|date=August 2013|where is this used or why would one use this template?}} | ||
=== Usage === | === Usage === |
Revision as of 23:34, 24 August 2013
This is a documentation subpage for Template:Error. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
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).[clarification needed]
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: 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=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
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