Template:Formatting error/doc

This is a documentation subpage for Template:Formatting error.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

This template was ported from a template from Wikipedia. It was originally at Template:Formatting error/doc. The original authors of this template are shown on the template's edit history page.
This template's documentation was also ported from Wikipedia, originally from Template:Formatting error/doc/doc. The original authors of the documentation are shown on the documentation's edit history page.
Wikipedia's text is available under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

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

• 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.
• {{Error-small}}
• {{Error}}
• mw:Help:Extension:ParserFunctions##iferror