Template:Error: Difference between revisions

From Space Station 14 Wiki
(Created page with "<includeonly><!-- -->{{#invoke:Error|error|{{{message|{{{1}}}}}}|tag={{{tag|}}}}}<!-- # do not add category if on specified page -->{{add category if not on pages or subpages|Template errors|{{{no category on page|}}}|Template:Error}}</includeonly><noinclude> {{documentation|below banner= {{template populates category|Template errors}} {{external template|https://www.mediawiki.org/wiki/Template:Error}} }} Category:Error-message templates Category:Templates mean...")
 
(template for use in templates)
 
Line 6: Line 6:


{{documentation|below banner=
{{documentation|below banner=
{{template for use in templates}}
{{template populates category|Template errors}}
{{template populates category|Template errors}}
{{external template|https://www.mediawiki.org/wiki/Template:Error}}
{{external template|https://www.mediawiki.org/wiki/Template:Error}}
Line 11: Line 12:


[[Category:Error-message templates]]
[[Category:Error-message templates]]
[[Category:Templates meant for other templates]]
<templatedata>
<templatedata>
{
{

Latest revision as of 11:56, 17 August 2024


Template documentation
view or edit this documentation about template documentation
For use in other templates
This template is meant to be used within other templates and not by itself.
Populates a category
This template will add a category when used:
(though on what conditions — consult with the template itself)
External template
This template originates from an external source:

This meta template returns a state of error, 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
  • {{#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 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

The template returns a state of error (recognized as such by a wiki parser function), an error-message text in red (visible for the user) and adds the page to "Template errors" category.

Template parameters[Edit template data]

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
Page to exempt from adding the error category tono category on page

Here you can specify a page on which the category for template errors won't be added. This also includes all its subpages.

Example
Template:FooBar
Page nameoptional