Difference between revisions of "Template:Formatting error/doc"

From blackwiki
Jump to navigation Jump to search
imported>Djr13
imported>Andrybak
 
(2 intermediate revisions by 2 users not shown)
Line 14: Line 14:
 
=== See also ===
 
=== See also ===
 
* [[:Category:Pages with incorrect formatting templates use]] for a list of pages that have been marked as using a formatting template incorrectly using this template.
 
* [[:Category:Pages with incorrect formatting templates use]] for a list of pages that have been marked as using a formatting template incorrectly using this template.
 +
* {{tl|Error-small}}
 
* {{tl|Error}}
 
* {{tl|Error}}
* {{tl|TryCatch}}
+
* [[mw:Help:Extension:ParserFunctions##iferror]]
  
<includeonly>
+
<includeonly>{{Sandbox other||
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
 
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
Line 23: Line 24:
  
 
[[id:Templat:FormattingError]]
 
[[id:Templat:FormattingError]]
</includeonly>
+
}}</includeonly>

Latest revision as of 20:59, 31 March 2020

Outputs an error message in red into the page and adds the page to Category:Pages with incorrect formatting templates use. An anchor (FormattingError) is inserted at the start of the error message, so you can find any errors on a page easily by adding #FormattingError at the end of the URL (e.g. Template:val/test#FormattingError). Used in complex templates that check their arguments for validity, so incorrect use can be spotted while editing a page or afterwards.

Usage

  • {{FormattingError|error message}}

or

  • {{FormattingError|error message|nocategory=true}}

When using the nocategory argument, the error message is displayed as usual, but the page is not added to Category:Pages with incorrect formatting templates use. This is useful in documentation pages for templates that use FormattingError and show what errors they can generate without adding these documentation pages to the category. For an example of this, see {{LinkForElement}}.

This template can be evaluated using the {{#iferror}} parser function:

  • {{#iferror:{{val|XX}}|error|OK}}OK

See also