doc: Difference between revisions

Latest revision as of 00:13, 6 March 2025

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:

Module:Error (sandbox)

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}} }} → 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 {{#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 Template:Error in articles based on its 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
Parameter		Description	Type	Status
Message	`1` `message`	Error message text in red	String	suggested
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 Suggested values `span` `div` `p` `strong` Default strong	String	optional

@@ Line 1: / Line 1: @@
-<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
+{{Documentation subpage}}
-{{Lua|Module:Error}}
+<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
+{{doc sub}}
+{{lua|Module:Error}}
-This meta template returns a ''state of error'' (recognized as such by a wiki {{ll|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 ==
@@ Line 8: / Line 10: @@
 * {{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}} | yes | no }}</nowiki></code> → {{#iferror:{{error|Foo}} | yes | no }}
+* <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>.
+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>.
 * ABC {{tlx|error|An exemplary error demo no tag (default)}} XYZ → ABC {{error|An exemplary error demo no tag (default)}} XYZ
@@ Line 18: / Line 21: @@
 * ABC {{tlx|error|An exemplary error demo strong|tag{{=}}strong}} XYZ → ABC {{error|An exemplary error demo strong|tag=strong}} XYZ
-== TemplateData ==
+==TemplateData==
 {{TemplateData header}}
 <TemplateData>
 {
-	"description": {
+	"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)",
-		"en": "The template returns a state of error (recognized as such by a wiki parser function), and an error-message text in red (visible for the user).",
-		"cs": "Šablona vrací chybový stav (rozpoznaný jako takový funkcí wiki analyzátoru) a text chybové zprávy červeně (viditelný pro uživatele)."
-	},
-	"format": "inline",
 	"params": {
 		"1": {
+			"label": "Message",
+			"description": "Error message text in red",
+			"type": "string",
+			"required": false,
+			"suggested": true,
 			"aliases": [
 				"message"
-			],
+			]
-			"label": {
-				"en": "Message",
-				"cs": "Zpráva"
-			},
-			"description": {
-				"en": "Error message text in red",
-				"cs": "Text chybové zprávy červeně"
-			},
-			"required": true,
-			"type": "content"
 		},
 		"tag": {
-			"label": {
+			"label": "Tag",
-				"en": "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",
-				"cs": "Značka"
+			"type": "string",
-			},
+			"default": "strong",
-			"description": {
+			"required": false,
-				"en": "\nThe 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.\n \nIt defaults to “strong”, the tag generated by the “#expr:”, “#invoke:”, etc. parser functions.\n",
-				"cs": "\nZnačka, která obsahuje chybovou zprávu; přijme pouze “span”, “div”, “p” a “strong”, protože to jsou jediné značky, které rozpozná funkce analyzátoru “#iferror:”.\n \nVýchozí hodnota je “strong”, značka vygenerovaná funkcemi analyzátoru “#expr:”, “#invoke:” atd.\n"
-			},
 			"suggestedvalues": [
 				"span",
-				"strong",
 				"div",
-				"p"
+				"p",
-			],
+				"strong"
-			"default": "strong",
+			]
-			"type": "string"
 		}
-	},
+	}
-	"paramOrder": [
-		"tag",
-		"1"
-	]
 }
 </TemplateData>
-== See also ==
+==See also==
-* {{ll|Help:Parser function}}
+* {{tl|Error-small}}
-* {{C|Error message templates}}
+* {{tl|Formatting error}}
+* [[Help:Magic words#Conditional|#iferror: parser function]]
 <includeonly>{{Sandbox other||
-<!-- Categories below this line; interwikis at Wikidata -->
+<!-- Categories below this line, please; interwikis at Wikidata -->
-[[Category:Error message templates{{#translation:}}| ]]
+[[Category:Wikipedia metatemplates]]
-[[Category:Meta templates{{#translation:}}]]
+[[Category:Error-message templates]]
 }}</includeonly>