Brontekst bekijken van Sjabloon:Yesno/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{high-risk|6,000,000+}}

This template normalises an input to be a yes/no output.

== Usage ==

The template discerns five possible logical outputs depending on the first parameter (input if you will).

In its simplest usage these will all be either "yes" or "" (blank&nbsp;— nothing no characters).

# <tt><nowiki>{{yesno|yes}}</nowiki></tt>  result "{{yesno|yes}}"  (also applies to "Yes", "YeS", etc, "Y", "y" and "1")
# <tt><nowiki>{{yesno|no}}</nowiki></tt> result "{{yesno|no}}" (also applies to "No", "NO", "nO", "N", "n" and "0")
# <tt><nowiki>{{yesno}}</nowiki></tt> result "{{yesno}}"
# <tt><nowiki>{{yesno|¬}}</nowiki></tt> result "{{yesno|¬}}"
# <tt><nowiki>{{yesno|purplemonkeydishwasher}}</nowiki></tt> result "{{yesno|purplemonkeydishwasher}}" (also applies to any other value not given above).


Each of these can be over-ridden.

# <tt><nowiki>{{yesno|yes|yes=bacon}}</nowiki></tt>  result "{{yesno|yes|yes=bacon}}" (also applies to "Yes", "YeS", etc, "Y", "y" and "1")
# <tt><nowiki>{{yesno|no|no=ham}}</nowiki></tt> result "{{yesno|no|no=ham}}": (also applies to "No", "NO", "nO", "N", "n" and "0")
# <tt><nowiki>{{yesno||blank=eggs}}</nowiki></tt> result "{{yesno||blank=eggs}}"
## but <tt><nowiki>{{yesno||no=ham}}</nowiki></tt> result "{{yesno||no=ham}}"
## and <tt><nowiki>{{yesno||blank=eggs|no=ham}}</nowiki></tt> result "{{yesno||blank=eggs|no=ham}}"
# <tt><nowiki>{{yesno|¬|¬=sausage}}</nowiki></tt> result "{{yesno|¬|¬=sausage}}"
# <tt><nowiki>{{yesno|purplemonkeydishwasher|def=cup-of-tea}}</nowiki></tt> result "{{yesno|purplemonkeydishwasher|def=cup-of-tea}}" (also applies to any other value not given above).
## but <tt><nowiki>{{yesno|purplemonkeydishwasher|yes=bacon}}</nowiki></tt> result "{{yesno|purplemonkeydishwasher|yes=bacon}}"
## but <tt><nowiki>{{yesno|purplemonkeydishwasher|def=cup-of-tea|yes=bacon}}</nowiki></tt> result "{{yesno|purplemonkeydishwasher|def=cup-of-tea|yes=bacon}}"

This may be used (apparently perversely) thus:

* <tt><nowiki>{{yesno|yes|yes=no|no=yes}}</nowiki></tt>  result "{{yesno|yes|yes=no|no=yes}}"
* <tt><nowiki>{{yesno|no|yes=no|no=yes}}</nowiki></tt>  result "{{yesno|no|yes=no|no=yes}}"

This creates a logical inversion.

==Full parameter list==
Unnamed parameter 1= the input value to be evaluated. The other parameters (all named, all optional), are the ''return values'' for their respective logical outcome. When set, each one overrules their ''default return value''.

<pre>
{{yesno
|
| yes  =
| no   =
| blank=
| ¬    =
| def  =
}}
</pre>

{| class=wikitable border=1 cellpadding=2 style="text-align:left; width:100%;"
|-
! colspan=7 style="background:#d0d0d0;" | Overview of {{tlx|yesno}} ''logical values'' and their associated texts
|- style="text-align:left; vertical-align:top; font-weight:bold; background:#e8e8e8;"
| Input<br />parameter 1<br />({{code|1=1=}})
| In code
| Logical return value
| Default<br />return text
|
| Return text when set:<br />{{code|1=yes=Pos}}<br />{{code|1=no=Neg}}<br />{{code|1=blank=Blank}}<br />{{code|1=¬=Undefined}}<br />{{code|1=def=Def}}
| Note
|-
| yes, y, 1*
| {{code|1=<nowiki>{{yesno|yes}}</nowiki>}}
| {{nowrap|{{code|yes by definition}}}}
| "{{yesno|yes}}"
|
| "{{yesno|yes|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}"
| <nowiki>*</nowiki> Case-insensitive (Y=y)
|-
| {{nowrap|Some Text}}
| {{nowrap|{{code|1=<nowiki>{{yesno|Some Text}}</nowiki>}}}}
| {{code|yes by default}}
| "{{yesno|Some Text}}"
|
| "{{yesno|Some Text|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}"
| "{{yesno|Some Text|yes=Pos|no=Neg|blank=Blank|¬=Undefined}}" when {{nowrap|{{code|1=def=<omitted>}}}}
|-
| no, n, 0*
| {{code|1=<nowiki>{{yesno|no}}</nowiki>}}
| {{code|no by definition}}
| "{{yesno|no}}"
|
| "{{yesno|no|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}"
| <nowiki>*</nowiki> Case-insensitive (N=n)
|-
| &lt;blank>
| {{code|1=<nowiki>{{yesno|}}</nowiki>}}
| {{code|blank}}
| "{{yesno|1=}}"
|
| "{{yesno||yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}"
| "{{yesno||yes=Pos|no=Neg|¬=Undefined|def=Def}}" when {{nowrap|{{code|1=blank=<omitted>}}}}
|-
| 1=&lt;blank>
| {{code|1=<nowiki>{{yesno|1=}}</nowiki>}}
| {{code|blank}}
| "{{yesno|1=}}"
|
| "{{yesno|1=|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}"
| "{{yesno|1=|yes=Pos|no=Neg|¬=Undefined|def=Def}}" when {{nowrap|{{code|1=blank=<omitted>}}}}
|-
| ¬
| {{code|1=<nowiki>{{yesno|¬}}</nowiki>}}
| {{code|¬}}
| "{{yesno|¬}}"
|
| "{{yesno|¬|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}"
|
|-
| &lt;omitted>
| {{code|1=<nowiki>{{yesno}}</nowiki>}}
| {{code|¬}}
| "{{yesno}}"
|
| "{{yesno|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}"
| 
|}

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:String manipulation templates]]
</includeonly>

<includeonly>
[[id:Templat:Yesno]]
[[sl:Predloga:Yesno]]
</includeonly>
<templatedata>
{
        "description": "This template normalises an input to be a yes/no output.",
        "params": {
                "": {
                        "label": "Value",
                        "description": "The value to be evaluated",
                        "type": "string",
                        "required": true
                },
                "yes": {
                        "label": "Output on yes",
                        "description": "Defines a value to output on yes",
                        "type": "string",
                        "required": false
},
                "no": {
                        "label": "Output on no",
                        "description": "Defines a value to output on no",
                        "type": "string",
                        "required": false
},
                "blank": {
                        "label": "Output on blank input",
                        "description": "Defines a value to output if blank input",
                        "type": "string",
                        "required": false
},
                "¬": {
                        "label": "Output on ¬",
                        "description": "Defines a value to output when input = ¬",
                        "type": "string",
                        "required": false
},
                "def": {
                        "label": "Definite output",
                        "description": "Defines the output when value = yes",
                        "type": "string",
                        "required": false
                }
        }
}
</templatedata>