Editing TemplateDoc:Internal/Error

{{Notice/TemplateDoc}}

==Error templates==
===General template errors===
*[[Template:Internal/Error/DeprecatedTemplate|Deprecated template error]] (<code><nowiki>{{Internal/Error/DeprecatedTemplate}}</nowiki></code>)

===Parameter errors===
*[[Template:Internal/Error/InvalidParam|Invalid parameter error]] (<code><nowiki>{{Internal/Error/InvalidParam}}</nowiki></code>)
*[[Template:Internal/Error/MissingParam|Missing parameter error]] (<code><nowiki>{{Internal/Error/MissingParam}}</nowiki></code>)
*[[Template:Internal/Error/DeprecatedParam|Deprecated parameter error]] (<code><nowiki>{{Internal/Error/DeprecatedParam}}</nowiki></code>)

<small>IMPORTANT: If you intend to create a new error template, please make sure to also create its respective category page and make that category a subcategory of [[:Category:Pages containing template errors|Category:Pages containing template errors]]. This makes it easier to find and fix template errors on pages!</small>

==Usage==
This template is used to signal unrecoverable template errors to the user. Templates should only use this or another error template when there is no possible way to give a logical output from a given set of parameters. An error message will be displayed on the article itself, and the editor will also be notified via a message at the top of the page in the edit preview. The page will automatically be added to a category, so that the error can be found and fixed by other users.

Under normal circumstances, templates should use one of the other, more specific error templates to signify errors, so that the error message, type and category is more specific.

<small>IMPORTANT: Errors should only be used in cases where the issue cannot be recovered from, and the template is unable to display in a sensible manner on the page! If the issue is more minor and the template can still function, please use [[Template:Internal/Warning]] instead, to give the editor a more less warning and avoid error messages appearing in the final article.</small>

{|width=100%
!width=50%|Simplified Version
!width=50%|Full Version
|-
|
<pre>
{{Internal/Error
|
}}
</pre>
|
<pre>
{{Internal/Error
|Name=
|Category=
|Template=
|
}}
</pre>
|}

===Parameters===
{| width=100% class="wikitable"
!width=12%|''Field Name''
!width=12%|''Field Aliases''
!width=12%|''Optional or Required?''
!width=auto|''Description''
!width=24%|''Example''
|-
|'''1''' {{C|Unnamed field}}
|'''Message'''
|'''Required'''
|The message to present to the user.
|<code>Unrecognised acronym: "banana"!</code>
|-
|'''Type'''
| -
|''Optional''
|The type of error.
|<code>Invalid parameter</code>
|-
|'''Catgory'''
| -
|''Optional''
|The category to insert pages into if they contain an error of this type.
|<code>Pages containing invalid template parameter errors</code>
|-
|'''Template'''
|'''Recommended'''
|The name of the template in which the error has occurred.
|<code>Acronym</code>
|}

===Error states===
This template will always throw an error - that is its purpose.

===Examples===
Here are some examples of how to use this template:

{|width=100%
!width=50%|Wiki Markup
!width=50%|Result
|-
|<pre><nowiki>
{{Internal/Error}}
</nowiki></pre>
|{{#tag:span|'''{{uc:Template error}}:''' There was an error with this template. Are the parameters correct?|style=color: red;|class="template-error"}}
|-
|
<pre><nowiki>
{{Internal/Error|Unrecognised acronym: "banana"!|Type=Invalid parameter|Category=Pages containing invalid template parameter errors}}
</nowiki></pre>
|
{{#tag:span|'''{{uc:Invalid parameter error}}:''' Unrecognised acronym: "banana"!|style=color: red;|class="template-error"}}
|}

<noinclude>[[Category:Error template documentation]]</noinclude>