Template:Error/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
VisualWikitext
meta>Mormegil
m (+cs:)
m (49 revisions imported)
 
(38 intermediate revisions by 33 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{high use}}
{{lua|Module:Error}}


Create a [[Help:Parser function|parser function]] error message.
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 ===
== Usage ==
* {{tlx|error|An examplary error}} → {{error|An examplary error}}
* {{tlx|error|An exemplary error}} → {{error|An exemplary error}}
* Compare: <code><nowiki>{{#expr:Foo}}</nowiki></code> → {{#expr:Foo}}
* {{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}}
* <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}} }}


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 genereated e.g. by <code>#expre</code>.
=== 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>.


* {{tlx|error|An examplary error span|3=tag=span}} → {{error|An examplary error span|tag=span}}
* 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|tag{{=}}span}} XYZ → ABC {{error|An exemplary error demo span|tag=span}} XYZ
* ABC {{tlx|error|An exemplary error demo div|tag{{=}}div}} XYZ → ABC {{error|An exemplary error demo div|tag=div}} XYZ
* ABC {{tlx|error|An exemplary error demo p|tag{{=}}p}} XYZ → ABC {{error|An exemplary error demo p|tag=p}} XYZ
* ABC {{tlx|error|An exemplary error demo strong|tag{{=}}strong}} XYZ → ABC {{error|An exemplary error demo strong|tag=strong}} XYZ


== See also ==
==TemplateData==
* [[Help:Parser function]]
{{TemplateData header}}
* [[mw:Help:Extension:ParserFunctions##iferror:]]
<TemplateData>
{
"description": "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)",
"params": {
"1": {
"label": "Message",
"description": "Error message text in red",
"type": "string",
"required": false,
"suggested": true
},
"tag": {
"label": "Tag",
"description": "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",
"type": "string",
"default": "strong",
"required": false
}
}
}
</TemplateData>


<includeonly>
==See also==
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
* {{tl|Error-small}}
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
* {{tl|Formatting error}}
[[ar:قالب:Error]]
* [[Help:Magic_words#Conditional|#iferror: parser function]]
[[cs:Šablona:Chyba]]
 
[[id:Templat:Error]]
<includeonly>{{Sandbox other||
[[ja:Template:Error]]
<!-- Categories below this line, please; interwikis at Wikidata -->
[[pt:Predefinição:Error]]
[[Category:Wikipedia metatemplates]]
</includeonly>
[[Category:Error-message templates]]
}}</includeonly>

Latest revision as of 04:27, 3 September 2020

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}} }} → Green tickY

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 → 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

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)

Template parameters

ParameterDescriptionTypeStatus
Message1

Error message text in red

Stringsuggested
Tagtag

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

Default
strong
Stringoptional

See also


Retrieved from "https://zoophilia.wiki/index.php?title=Template:Error/doc&oldid=60313"