Template:Error/doc

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}} →
• {{error|message=An exemplary error}} →
• Compare, used in a Parser Function: {{#expr:Foo}} →
• {{#iferror:{{error|Foo}} | yes | no }} → yes

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

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Error/doc

<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).", "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": { "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": { "en": "Tag", "cs": "Značka" }, "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.\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" ], "default": "strong", "type": "string" } }, "paramOrder": [ "tag", "1" ] } </TemplateData>

See also

• Help:Parser function
• Error message templates