Template:Error/doc

From MattWiki
Jump to: navigation, search

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}} }}Green tickY

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 documentation for this template used by VisualEditor and other tools.

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

ParameterDescriptionTypeStatus
Message1

Error message text in red

Default
empty
Example
empty
Auto value
empty
Stringoptional
Tagtag

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
Example
empty
Auto value
empty
Stringoptional

See also