DarkMavis: Created page with "{{Documentation subpage}} This template normalises an input to be a yes/no output. == Usage == The t..."

2015-07-15T23:28:42Z

Created page with "{{Documentation subpage}}  This template normalises an input to be a yes/no output. == Usage == The t..."

New page

{{Documentation subpage}}


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

== Usage ==
The template distinguishes five different types of input, supplied on the first unnamed parameter:
# '''Yes''': Case-insensitive forms of "Yes", "y" and "1"; e.g. {{tlf|Yesno|yEs}}
# '''No''': Case-insensitive forms of "No", "n" and "0"; e.g. {{tlf|Yesno|nO}}
# '''Nothing''': When the input is defined but either contains no value or consists of [[whitespace character]] only; i.e. {{tlf|Yesno|}} or {{tlf|Yesno| }}
# '''Negation''': When the input is either "¬" or entirely missing; i.e. {{tlf|Yesno|¬}} or {{tlf|Yesno}}
# '''Anything else''': e.g. {{tlf|Yesno|Purple monkey dish washer}}

By default, the template returns "yes" in the first and last case but returns blank in the other cases.

===Customizing the output===
Template's default output can be customized with five named parameters, respectively: {{para|yes}}, {{para|no}}, {{para|blank}}, {{para|¬}} and {{para|def}}. If these parameters are specified, the template response is as follows:
# '''Yes''': Template returns the contents of {{para|yes}}, otherwise returns "yes". For example:
#* {{tlx|yesno|y|3=yes=Yeah}} results in "{{yesno|y|yes=Yeah}}"
#* {{tlx|yesno|y|3=yes=bacon}} results in "{{yesno|y|yes=bacon}}"
# '''No''': Template returns the contents of {{para|no}}, otherwise returns blank. For example:
#* {{tlx|yesno|n|3=no=Nay}} results in "{{yesno|n|no=Nay}}"
#* {{tlx|yesno|n|3=no=ham}} results in "{{yesno|n|no=ham}}"
# '''Nothing''': Template returns the contents of {{para|blank}} or {{para|no}} in absence of the former; otherwise, returns blank.
#* {{tlx|yesno||3=blank=eggs}} results in "{{yesno||blank=eggs}}"
#* {{tlx|yesno||3=no=ham}} results in "{{yesno||no=ham}}"
#* {{tlx|yesno||3=blank=eggs|4=no=ham}} results in "{{yesno||blank=eggs|no=ham}}"
# '''Negation''': Template returns the contents of {{para|¬}}, otherwise returns blank. For example:
#* {{tlx|yesno|¬|3=¬=sausage}} results in "{{yesno|¬|¬=sausage}}"
# '''Anything else''': Template returns the contents of {{para|def}} or {{para|yes}} in absence of the former; otherwise, returns "yes".
#* {{tlx|yesno|purple monkey dish washer|3=def=cup of tea}} results in "{{yesno|purple monkey dish washer|def=cup of tea}}"
#* {{tlx|yesno|purple monkey dish washer|3=yes=bacon}} results in "{{yesno|purple monkey dish washer|yes=bacon}}"
#* {{tlx|yesno|purple monkey dish washer|3=def=cup of tea|4=yes=bacon}} results in "{{yesno|purple monkey dish washer|def=cup of tea|yes=bacon}}"

For the named parameters, use of a blank value is not the same as omitting the parameter. Blank named parameters tells the template that the customized return value is blank. For example:
* {{tlx|yesno|purple monkey dish washer}} results in "{{yesno|purple monkey dish washer}}"
* {{tlx|yesno|purple monkey dish washer|3=def=}} results in "{{yesno|purple monkey dish washer|def=}}"

===Logical distinctions===

{| 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 parameter 1 ({{code|1=1=}})
| In code
| Logical return value
| Default return text
|
| Return text when set: {{code|1=yes=Pos}} {{code|1=no=Neg}} {{code|1=blank=Blank}} {{code|1=¬=Undefined}} {{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)
|-
| <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=<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}}"
|
|-
| <omitted>
| {{code|1=<nowiki>{{yesno}}</nowiki>}}
| {{code|¬}}
| "{{yesno}}"
|
| "{{yesno|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}"
|
|}

== 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>

== See also ==
* [[Module:yesno]]

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>
{
"description": "This template normalises an input to be a yes/no output.",
"params": {
"1": {
"label": "Input value",
"description": "The value to be evaluated",
"type": "string",
"required": true
},
"yes": {
"label": "Output on yes",
"description": "Specifies the output of the template when the input value is a case-insensitive forms of 'Yes', 'Y' or '1'",
"type": "string",
"required": false
},
"no": {
"label": "Output on no",
"description": "Specifies the output of the template when the input value is a case-insensitive forms of 'No', 'N' or '0'",
"type": "string",
"required": false
},
"blank": {
"label": "Output on blank input",
"description": "Specifies the output of the template when the input value is defined but is either empty or contains nothing but whitespace character(s)",
"type": "string",
"required": false
},
"¬": {
"label": "Output on ¬",
"description": "Specifies the output of the template when the input value is either '¬' or entirely missing (undefined)",
"type": "string",
"required": false
},
"def": {
"label": "Definite output",
"description": "Specifies the output of the template when the input value is defined but not a form of 'yes', 'no', '1', '0', '¬' or blank",
"type": "string",
"required": false
}
}
}
</templatedata>

<includeonly>
{{#ifeq:{{SUBPAGENAME}}|sandbox | |

[[Category:String manipulation templates]]
}}
</includeonly>

Template:Yesno/doc - Revision history

DarkMavis: Created page with "{{Documentation subpage}} This template normalises an input to be a yes/no output. == Usage == The t..."