Vorlage:Error/doc: Unterschied zwischen den Versionen

Aktuelle Version vom 27. Juni 2022, 09:18 Uhr

This is a documentation subpage for Vorlage:Error.
It contains usage information, categories and other content that is not part of the original vorlage page.

This template uses Lua:

Module:Error

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}} → Fehler im Ausdruck: Unerkanntes Wort „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 #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 → 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

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).

Vorlagenparameter
Diese Vorlage bevorzugt Inline-Formatierung von Parametern.
Parameter		Beschreibung	Typ	Status
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 by the “#expr:”, “#invoke:”, etc. parser functions. Suggested values are: 'span', 'strong', 'div', and 'p'. Standard strong	Mehrzeiliger Text	optional
Message	`1` `message`	Error message text in red	Wikitext	erforderlich

@@ Zeile 18: / Zeile 18: @@
 * 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
+== TemplateData ==
+<TemplateData>
+{
+	"description": {
+		"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)."
+	},
+	"format": "inline",
+	"params": {
+		"1": {
+			"aliases": [
+				"message"
+			],
+			"label": {
+				"en": "Message"
+			},
+			"description": {
+				"en": "Error message text in red"
+			},
+			"required": true,
+			"type": "content"
+		},
+		"tag": {
+			"label": {
+				"en": "Tag"
+			},
+			"description": {
+				"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.\nSuggested values are: 'span', 'strong', 'div', and 'p'."
+			},
+			"default": "strong",
+			"type": "string"
+		}
+	},
+	"paramOrder": [
+		"tag",
+		"1"
+	]
+}
+</TemplateData>
 === See also ===