doc

From Encyclopedia of Scientonomy
Jump to navigation Jump to search

Template:Mbox Template:Lua

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

  • Template:TlxScript error: No such module "Error".
  • Template:TlxScript error: No such module "Error".
  • Compare, used in a Parser Function: {{#expr:Foo}}Expression error: Unrecognized word "foo".
  • {{#iferror:{{error|Foo}} | {{y}} | {{n}} }}Template: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 #expre. To prevent strong message, use one of the other tags, e.g. tag=span.

  • ABC Template:Tlx XYZ → ABC Script error: No such module "Error". XYZ
  • ABC Template:Tlx XYZ → ABC Script error: No such module "Error". XYZ
  • ABC Template:Tlx XYZ → ABC Script error: No such module "Error". XYZ
  • ABC Template:Tlx XYZ → ABC Script error: No such module "Error". XYZ
  • ABC Template:Tlx XYZ → ABC Script error: No such module "Error". XYZ

Template data

<TemplateData> {

       "description": "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)",
       "params": {
               "1": {
                       "label": "Message",
                       "description": "Error message text in red",
                       "type": "string",
                       "required": false
               },
               "tag": {
                       "label": "Tag",
                       "description": "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",
                       "type": "string",
                       "default": "strong",
                       "required": false
               }
       }

} </TemplateData>

See also