Template:Error/sandbox

{{{1}}}

This is the template sandbox page for Template:Error (diff).

Template documentation[view] [edit] [history] [purge]

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[Edit template data]
Parameter		Description	Type	Status
Message	`1`	Error message text in red	String	optional
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 Default strong	String	optional

The above documentation is transcluded from Template:Error/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.