Difference between revisions of "Template:Yesno/doc"
(Created page with "{{Documentation subpage}} <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia:Wikidata) --> {{#ifeq:{{ROOTPAG...") |
m (Add WP notice) |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | ||
− | {{#ifeq:{{ | + | {{#ifeq:{{BASEPAGENAME}}|Yesno|{{high-risk}}}} |
+ | {{En-WP attribution notice}} | ||
{{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. | {{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. |
Revision as of 12:21, 6 October 2016
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This is a documentation subpage for Template:Yesno. It contains usage information, categories and other content that is not part of the original template page. |
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This template is used on a very large number of pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing changes on the talk page before implementing them. |
This template uses material from the Wikipedia template Template:Yesno/doc, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors). | Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
{{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.
Contents
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= )
|
Template:T | Template:T | Template:T |
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
TemplateData for Yesno
<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>