Template:Error/doc

From Campaigns
Revision as of 05:00, 25 July 2021 by mw>ExE Boss (Move {{error}} to the beginning of Category:Error message templates)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to 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

  • An exemplary error
  • An exemplary error
  • Compare, used in a Parser Function: {{#expr:Foo}}Expression error: Unrecognized word "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 XYZ → ABC An exemplary error demo no tag (default) XYZ
  • ABC XYZ → ABC An exemplary error demo span XYZ
  • ABC XYZ → ABC
    An exemplary error demo div
    XYZ
  • ABC XYZ → ABC

    An exemplary error demo p

    XYZ
  • ABC XYZ → ABC An exemplary error demo strong XYZ

TemplateData

Template:TemplateData header

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

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
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 by the “#expr:”, “#invoke:”, etc. parser functions.

Suggested values
span strong div p
Default
strong
Stringoptional
Message1 message

Error message text in red

Contentrequired

See also