Template:Yesno/doc: Difference between revisions
Looney Toons (talk | contribs) (copied documentation from http://www.mediawiki.org/wiki/Template:Yesno/doc) |
m (1 revision imported) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> |
|||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
|||
{{#ifeq:{{ROOTPAGENAME}}|Yesno|{{high-risk|7760000+ pages, which is ≈{{#expr:(776524000/{{NUMBEROFPAGES:R}}) round 0}}% of all}}}} |
|||
{{tlx|Yesno}} (or {{tlx|YesNo}}) evaluates any input and produces a normalized <samp>yes</samp> or <samp>no</samp>, based on the content of the input and several configurable options. It is not used in article prose, but in coding complex templates. |
|||
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 <code>Yes</code>, <code>y</code>, <code>true</code>, and <code>1</code>; e.g. {{tlx|Yesno|yEs}} |
|||
# '''No''': Case-insensitive forms of <code>No</code>, <code>n</code>, <code>false</code>, and <code>0</code>; e.g. {{tlx|Yesno|nO}} |
|||
# '''Nothing''': When the input is defined but either contains no value or consists of [[whitespace character]] only; i.e. <code><nowiki>{{Yesno|}}</nowiki></code> or {{tlx|Yesno| }} |
|||
# '''Negation''': When the input is either <code>¬</code> or entirely missing; i.e. {{tlx|Yesno|¬}} or {{tlx|Yesno}} |
|||
# '''Anything else''': e.g. {{tlx|Yesno|Purple monkey dish washer}} |
|||
By default, the template returns "yes" in the first and last case but returns blank in the other cases. |
|||
The template has five possible outputs depending on the default parameter (input if you will). |
|||
Two short-hand templates for the most common uses that override the default behavior: |
|||
In its simplest usage these will all be either "yes" or "" (blank - nothing no characters). |
|||
* {{tlx|yesno-yes}} or {{tlx|YesNo-Yes}} – always returns "yes" (or the specified replacement result in {{para|yes}}) unless an explicit negative value is given; i.e., it evaluates to "yes" even when the value is empty or missing. |
|||
* {{tlx|yesno-no}} or {{tlx|YesNo-No}} – always returns "no" (or the specified replacement result in {{para|no}}) unless an explicit positive value is given; i.e., it evaluates to "no" even when the value is present, as long as it does not contain anything that resolves to "yes". |
|||
===Customizing the output=== |
|||
# <tt><nowiki>{{yesno|yes}}</nowiki></tt> result "yes" (also applies to "Yes", "YeS", etc, "Y", "y" and "1") |
|||
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: |
|||
# <tt><nowiki>{{yesno|no}}</nowiki></tt> result "" (also applies to "No", "NO", "nO", "N", "n" and "0") |
|||
# '''Yes''': Template returns the contents of {{para|yes}}, otherwise returns "yes". For example: |
|||
# <tt><nowiki>{{yesno}}</nowiki></tt> result "" |
|||
#* {{tlx|yesno|y|3=yes=Yeah}} results in "{{yesno|y|yes=Yeah}}" |
|||
# <tt><nowiki>{{yesno|¬}}</nowiki></tt> result "" |
|||
#* {{tlx|yesno|y|3=yes=bacon}} results in "{{yesno|y|yes=bacon}}" |
|||
# <tt><nowiki>{{yesno|purplemonkeydishwasher}}</nowiki></tt> result "yes" (also applies to any other value not given above). |
|||
# '''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 of {{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 of {{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=}}" {{var|[blank]}} |
|||
===Logical distinctions=== |
|||
Each of these can be over-ridden. |
|||
{| class=wikitable border=1 cellpadding=2 style="text-align:left; width:100%;" |
|||
# <tt><nowiki>{{yesno|yes|yes=bacon}}</nowiki></tt> result "bacon" (also applies to "Yes", "YeS", etc, "Y", "y" and "1") |
|||
|- |
|||
# <tt><nowiki>{{yesno|no|no=ham}}</nowiki></tt> result "ham" (also applies to "No", "NO", "nO", "N", "n" and "0") |
|||
! colspan=7 style="background:#d0d0d0;" | Overview of {{tlx|yesno}} ''logical values'' and their associated texts |
|||
# <tt><nowiki>{{yesno|blank= eggs}}</nowiki></tt> result "eggs" |
|||
|- style="text-align:left; vertical-align:top; font-weight:bold; background:#e8e8e8;" |
|||
## but <tt><nowiki>{{yesno|no=ham}}</nowiki></tt> result "ham" |
|||
| Input<br />parameter 1<br />({{code|1=1=}}) |
|||
## and <tt><nowiki>{{yesno|blank= eggs|no=ham}}</nowiki></tt> result "eggs" |
|||
| In code |
|||
# <tt><nowiki>{{yesno|¬|¬=sausage}}</nowiki></tt> result "sausage" |
|||
| Logical return value |
|||
# <tt><nowiki>{{yesno|purplemonkeydishwasher|def=cup-of-tea}}</nowiki></tt> result "cup-of-tea" (also applies to any other value not given above). |
|||
| Default<br />return text |
|||
## but <tt><nowiki>{{yesno|purplemonkeydishwasher|yes=bacon}}</nowiki></tt> result "bacon" |
|||
| |
|||
## but <tt><nowiki>{{yesno|purplemonkeydishwasher|def=cup-of-tea|yes=bacon}}</nowiki></tt> result "cup-of-tea" |
|||
| 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, true, 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|1=<code>def={{var|[omitted]}}</code>}} |
|||
|- |
|||
| no, n, false, 0* |
|||
| {{code|1=<nowiki>{{yesno|no}}</nowiki>}} |
|||
| {{code|no by definition}} |
|||
| "{{yesno|no}}" {{var|[blank]}} |
|||
| |
|||
| "{{yesno|no|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}" |
|||
| <nowiki>*</nowiki> Case-insensitive (N=n) |
|||
|- |
|||
| {{var|[blank]}} |
|||
| {{code|1=<nowiki>{{yesno|}}</nowiki>}} |
|||
| {{code|blank}} |
|||
| "{{yesno|1=}}" {{var|[blank]}} |
|||
| |
|||
| "{{yesno||yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}" |
|||
| "{{yesno||yes=Pos|no=Neg|¬=Undefined|def=Def}}" when {{nowrap|1=<code>blank={{var|[omitted]}}</code>}} |
|||
|- |
|||
| 1={{var|[blank]}} |
|||
| {{code|1=<nowiki>{{yesno|1=}}</nowiki>}} |
|||
| {{code|blank}} |
|||
| "{{yesno|1=}}" {{var|[blank]}} |
|||
| |
|||
| "{{yesno|1=|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}" |
|||
| "{{yesno|1=|yes=Pos|no=Neg|¬=Undefined|def=Def}}" when {{nowrap|1=<code>blank={{var|[omitted]}}</code>}} |
|||
|- |
|||
| ¬ |
|||
| {{code|1=<nowiki>{{yesno|¬}}</nowiki>}} |
|||
| {{code|¬}} |
|||
| "{{yesno|¬}}" {{var|[blank]}} |
|||
| |
|||
| "{{yesno|¬|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}" |
|||
| |
|||
|- |
|||
| {{var|[omitted]}} |
|||
| {{code|1=<nowiki>{{yesno}}</nowiki>}} |
|||
| {{code|¬}} |
|||
| "{{yesno}}" {{var|[blank]}} |
|||
| |
|||
| "{{yesno|yes=Pos|no=Neg|blank=Blank|¬=Undefined|def=Def}}" |
|||
| |
|||
|} |
|||
{| class="wikitable" |
|||
This may be used (apparently perversely) thus: |
|||
|- |
|||
! colspan="4" style="background:#d0d0d0;" | Comparison with related templates |
|||
|- style="text-align:left; vertical-align:top; font-weight:bold; background:#e8e8e8;" |
|||
| Input parameter 1 ({{code|1=1=}}) |
|||
| {{t|yesno}} |
|||
| {{t|yesno-yes}} |
|||
| {{t|yesno-no}} |
|||
|- |
|||
| yes, y, true, 1* |
|||
| "{{yesno|yes}}" |
|||
| "{{yesno-yes|yes}}" |
|||
| "{{yesno-no|yes}}" |
|||
|- |
|||
| {{nowrap|Some Text}} |
|||
| "{{yesno|Some Text}}" |
|||
| "{{yesno-yes|Some Text}}" |
|||
| "{{yesno-no|Some Text}}" |
|||
|- |
|||
| no, n, false, 0* |
|||
| "{{yesno|no}}" {{var|[blank]}} |
|||
| "{{yesno-yes|no}}" |
|||
| "{{yesno-no|no}}" |
|||
|- |
|||
| {{var|[blank]}} |
|||
| "{{yesno|1=}}" {{var|[blank]}} |
|||
| "{{yesno-yes|1=}}" |
|||
| "{{yesno-no|1=}}" |
|||
|- |
|||
| 1={{var|[blank]}} |
|||
| "{{yesno|1=}}" {{var|[blank]}} |
|||
| "{{yesno-yes|1=}}" |
|||
| "{{yesno-no|1=}}" |
|||
|- |
|||
| ¬ |
|||
| "{{yesno|¬}}" {{var|[blank]}} |
|||
| "{{yesno-yes|¬}}" |
|||
| "{{yesno-no|¬}}" |
|||
|- |
|||
| {{var|[omitted]}} |
|||
| "{{yesno}}" {{var|[blank]}} |
|||
| "{{yesno-yes}}" |
|||
| "{{yesno-no}}" |
|||
|} |
|||
== Full parameter list == |
|||
* <tt><nowiki>{{yesno|yes|yes=no|no=yes}}</nowiki></tt> result "no" |
|||
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''. |
|||
* <tt><nowiki>{{yesno|no|yes=no|no=yes}}</nowiki></tt> result "yes" |
|||
<pre> |
|||
This creates a logical inversion. |
|||
{{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', 'True' 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', 'False, 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> |
<includeonly> |
||
{{#ifeq:{{SUBPAGENAME}}|sandbox | | |
|||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> |
|||
<!----CATEGORIES BELOW THIS LINE, PLEASE:----> |
|||
[[Category:Utility templates]] |
|||
[[Category:Boolean, register, and condition testing templates]] |
|||
}} |
|||
</includeonly> |
</includeonly> |
Latest revision as of 04:18, 23 August 2016
This is a documentation subpage for Template:Yesno. It contains usage information, categories and other content that is not part of the original page. |
{{Yesno}}
(or {{YesNo}}
) evaluates any input and produces a normalized yes or no, based on the content of the input and several configurable options. It is not used in article prose, but in coding complex templates.
Usage
The template distinguishes five different types of input, supplied on the first unnamed parameter:
- Yes: Case-insensitive forms of
Yes
,y
,true
, and1
; e.g.{{Yesno|yEs}}
- No: Case-insensitive forms of
No
,n
,false
, and0
; e.g.{{Yesno|nO}}
- Nothing: When the input is defined but either contains no value or consists of whitespace character only; i.e.
{{Yesno|}}
or{{Yesno| }}
- Negation: When the input is either
¬
or entirely missing; i.e.{{Yesno|¬}}
or{{Yesno}}
- Anything else: e.g.
{{Yesno|Purple monkey dish washer}}
By default, the template returns "yes" in the first and last case but returns blank in the other cases.
Two short-hand templates for the most common uses that override the default behavior:
{{yesno-yes}}
or{{YesNo-Yes}}
– always returns "yes" (or the specified replacement result in|yes=
) unless an explicit negative value is given; i.e., it evaluates to "yes" even when the value is empty or missing.{{yesno-no}}
or{{YesNo-No}}
– always returns "no" (or the specified replacement result in|no=
) unless an explicit positive value is given; i.e., it evaluates to "no" even when the value is present, as long as it does not contain anything that resolves to "yes".
Customizing the output
Template's default output can be customized with five named parameters, respectively: |yes=
, |no=
, |blank=
, |¬=
and |def=
. If these parameters are specified, the template response is as follows:
- Yes: Template returns the contents of
|yes=
, otherwise returns "yes". For example: - No: Template returns the contents of
|no=
, otherwise returns blank. For example: - Nothing: Template returns the contents of
|blank=
, or of|no=
in absence of the former; otherwise, returns blank. - Negation: Template returns the contents of
|¬=
, otherwise returns blank. For example:{{yesno|¬|¬=sausage}}
results in "sausage"
- Anything else: Template returns the contents of
|def=
, or of|yes=
in absence of the former; otherwise, returns "yes".
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:
{{yesno|purple monkey dish washer}}
results in "yes"{{yesno|purple monkey dish washer|def=}}
results in "" [blank]
Logical distinctions
Overview of {{yesno}} logical values and their associated texts
| ||||||
---|---|---|---|---|---|---|
Input parameter 1 ( 1= )
|
In code | Logical return value | Default return text |
Return text when set:yes=Pos no=Neg blank=Blank ¬=Undefined def=Def
|
Note | |
yes, y, true, 1* | {{yesno|yes}}
|
yes by definition
|
"yes" | "Pos" | * Case-insensitive (Y=y) | |
Some Text | {{yesno|Some Text}}
|
yes by default
|
"yes" | "Def" | "Pos" when def=[omitted]
| |
no, n, false, 0* | {{yesno|no}}
|
no by definition
|
"" [blank] | "Neg" | * Case-insensitive (N=n) | |
[blank] | {{yesno|}}
|
blank
|
"" [blank] | "Blank" | "Neg" when blank=[omitted]
| |
1=[blank] | {{yesno|1=}}
|
blank
|
"" [blank] | "Blank" | "Neg" when blank=[omitted]
| |
¬ | {{yesno|¬}}
|
¬
|
"" [blank] | "Undefined" | ||
[omitted] | {{yesno}}
|
¬
|
"" [blank] | "Undefined" |
Comparison with related templates | |||
---|---|---|---|
Input parameter 1 (1= )
|
{{yesno}} | {{yesno-yes}} | {{yesno-no}} |
yes, y, true, 1* | "yes" | "yes" | "yes" |
Some Text | "yes" | "yes" | "no" |
no, n, false, 0* | "" [blank] | "no" | "no" |
[blank] | "" [blank] | "yes" | "no" |
1=[blank] | "" [blank] | "yes" | "no" |
¬ | "" [blank] | "yes" | "no" |
[omitted] | "" [blank] | "yes" | "no" |
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.
{{yesno | | yes = | no = | blank= | ¬ = | def = }}
See also
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Yesno
This template normalises an input to be a yes/no output.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Input value | 1 | The value to be evaluated | String | required |
Output on yes | yes | Specifies the output of the template when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1' | String | optional |
Output on no | no | Specifies the output of the template when the input value is a case-insensitive forms of 'No', 'N', 'False, or '0' | String | optional |
Output on blank input | blank | Specifies the output of the template when the input value is defined but is either empty or contains nothing but whitespace character(s) | String | optional |
Output on ¬ | ¬ | Specifies the output of the template when the input value is either '¬' or entirely missing (undefined) | String | optional |
Definite output | def | Specifies the output of the template when the input value is defined but not a form of 'yes', 'no', '1', '0', '¬' or blank | String | optional |