「テンプレート:Error/doc」を編集中

{{Documentation subpage}}
{{lua|Module:Error}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

The template returns a ''state of error'' (recognized as such by a wiki [[Help:Parser function|parser function]]), and optionally an ''error-message text'' in red (visible for the user).{{clarify|date=August 2013|where is this used or why would one use this template?}}

=== Usage ===
* {{tlx|error|An exemplary error}} → {{error|An exemplary error}}
* {{tlx|error|message{{=}}An exemplary error}} → {{error|message=An exemplary error}}
* Compare, used in a Parser Function: <code><nowiki>{{#expr:Foo}}</nowiki></code> → {{#expr:Foo}}
* <code><nowiki>{{#iferror:{{error|Foo}} | {{y}} | {{n}} }}</nowiki></code> → {{#iferror:{{error|Foo}} | {{y}} | {{n}} }}
=== Tag option ===
The tag to contain the error message can be given through the <code>tag</code> parameter, but it will only accept <code>span</code>, <code>div</code>, <code>p</code>, and <code>strong</code>, since those are the only tags recognized by the <code>#iferror</code> parser function. It defaults to <code>strong</code>, the tag generated e.g. by <code>#expre</code>. To prevent <code>strong</code> message, use one of the other tags, e.g. <code>tag=span</code>.

* ABC {{tlx|error|An exemplary error demo no tag (default)}} XYZ → ABC {{error|An exemplary error demo no tag (default)}} XYZ
* ABC {{tlx|error|An exemplary error demo span|tag{{=}}span}} XYZ → ABC {{error|An exemplary error demo span|tag=span}} XYZ
* ABC {{tlx|error|An exemplary error demo div|tag{{=}}div}} XYZ → ABC {{error|An exemplary error demo div|tag=div}} XYZ
* ABC {{tlx|error|An exemplary error demo p|tag{{=}}p}} XYZ → ABC {{error|An exemplary error demo p|tag=p}} XYZ
* ABC {{tlx|error|An exemplary error demo strong|tag{{=}}strong}} XYZ → ABC {{error|An exemplary error demo strong|tag=strong}} 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 ===
* [[Template:Formatting error]]
* [[Help:Parser function]]
* [[mw:Help:Extension:ParserFunctions##iferror:]]

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
[[commons:Template:Error]]

</includeonly>