Template:Error/doc: Difference between revisions
From Zoophilia Wiki
Jump to navigationJump to search
meta>SiBr4 Linked to MediaWiki help page inline using Template:Pf; fixed "expre" typo; removed non-working Commons interwiki |
meta>Zyxw add {{TemplateData header}} before <templatedata> |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | |||
{{lua|Module:Error}} | {{lua|Module:Error}} | ||
This meta 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). 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. | This meta 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). 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 == | |||
* {{tlx|error|An exemplary error}} → {{error|An exemplary error}} | * {{tlx|error|An exemplary error}} → {{error|An exemplary error}} | ||
* {{tlx|error|message{{=}}An exemplary error}} → {{error|message=An exemplary error}} | * {{tlx|error|message{{=}}An exemplary error}} → {{error|message=An exemplary error}} | ||
* Compare, used in a Parser Function: <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 === | === 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 {{pf|iferror}} parser function. It defaults to <code>strong</code>, the tag generated e.g. by {{pf|expr}}. To prevent <code>strong</code> message, use one of the other tags, e.g. <code>tag=span</code>. | 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 {{pf|iferror}} parser function. It defaults to <code>strong</code>, the tag generated e.g. by {{pf|expr}}. To prevent <code>strong</code> message, use one of the other tags, e.g. <code>tag=span</code>. | ||
| Line 19: | Line 20: | ||
* ABC {{tlx|error|An exemplary error demo strong|tag{{=}}strong}} XYZ → ABC {{error|An exemplary error demo strong|tag=strong}} XYZ | * ABC {{tlx|error|An exemplary error demo strong|tag{{=}}strong}} XYZ → ABC {{error|An exemplary error demo strong|tag=strong}} XYZ | ||
== | ==TemplateData== | ||
{{TemplateData header}} | |||
<TemplateData> | <TemplateData> | ||
{ | { | ||
| Line 41: | Line 43: | ||
</TemplateData> | </TemplateData> | ||
==See also== | |||
* [[Template:TryCatch]] | * [[Template:TryCatch]] | ||
* [[Template:Formatting error]] | * [[Template:Formatting error]] | ||
* [[Help:Parser function]] | * [[Help:Parser function]] | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
<!-- Categories below this line, please; interwikis at Wikidata --> | |||
[[Category:Wikipedia metatemplates]] | [[Category:Wikipedia metatemplates]] | ||
}}</includeonly> | }}</includeonly> | ||
Revision as of 13:51, 8 September 2015
 | 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: |
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: 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 {{#expr}}. 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
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.
TemplateData for Error
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
