Template:Error

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Error/doc.

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).^{[clarification needed]}

Usage

{{error |1= }}

Template parameters

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

---

Wikipedia's help about TemplateData • Commons-specific information

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

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
message	1 message	The error message to display	Content	required
tag	tag	The HTML tag to wrap the error message in; one of “strong”, “span”, “div” and “p” Default strong	Line	optional

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: all users

See also

• Help:Parser function
• mw:Help:Extension:ParserFunctions##iferror:
• {{Fact disputed}}

Localization

This template is not intended to be localized.

Usage

• {{error|An exemplary error}} →
• Compare, used in a Parser Function: {{#expr:Foo}} →
• {{#iferror:{{error|Foo}} | DFD | FDD }} → DFD {color green or red)

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