Template:Yesno

From Advocatespedia, ASSN: 65
Jump to navigation Jump to search

<templatestyles src="Module:Documentation/styles.css"></templatestyles>

Template documentation[view] [edit] [history] [purge]

Script error: No such module "Template link general". (or Script error: No such module "Template link general".) 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:

  1. Yes: Case-insensitive forms of Yes, y, true, on, and 1; e.g. Script error: No such module "Template link general".
  2. No: Case-insensitive forms of No, n, false, off, and 0; e.g. Script error: No such module "Template link general".
  3. Nothing: When the input is defined but either contains no value or consists of whitespace character only; i.e. {{Yesno|}} or Script error: No such module "Template link general".
  4. Negation: When the input is either ¬ or entirely missing; i.e. Script error: No such module "Template link general". or Script error: No such module "Template link general".
  5. Anything else: e.g. Script error: No such module "Template link general".

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:

  • Script error: No such module "Template link general". or Script error: No such module "Template link general". – 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.
  • Script error: No such module "Template link general". or Script error: No such module "Template link general". – 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:

  1. Yes: Template returns the contents of |yes=, otherwise returns "yes". For example:
    • Script error: No such module "Template link general". results in "Yeah"
    • Script error: No such module "Template link general". results in "bacon"
  2. No: Template returns the contents of |no=, otherwise returns blank. For example:
    • Script error: No such module "Template link general". results in "Nay"
    • Script error: No such module "Template link general". results in "ham"
  3. Nothing: Template returns the contents of |blank=, or of |no= in absence of the former; otherwise, returns blank.
    • Script error: No such module "Template link general". results in "eggs"
    • Script error: No such module "Template link general". results in "ham"
    • Script error: No such module "Template link general". results in "eggs"
  4. Negation: Template returns the contents of |¬=, otherwise returns blank. For example:
    • Script error: No such module "Template link general". results in "sausage"
  5. Anything else: Template returns the contents of |def=, or of |yes= in absence of the former; otherwise, returns "yes".
    • Script error: No such module "Template link general". results in "cup of tea"
    • Script error: No such module "Template link general". results in "bacon"
    • Script error: No such module "Template link general". results in "cup of tea"

For the named parameters, use of a blank value is not the same as omitting the parameter. A blank named parameter tells the template that the customized return value is blank. For example:

  • Script error: No such module "Template link general". results in "yes"
  • Script error: No such module "Template link general". results in "" [blank]

Logical distinctions

Overview of Script error: No such module "Template link general". logical values and their associated texts
Input
parameter 1
(<syntaxhighlight lang="text" class="" id="" style="" inline="1">1=</syntaxhighlight>)
In code Logical return value Default
return text
Return text when set:
<syntaxhighlight lang="text" class="" id="" style="" inline="1">yes=Pos</syntaxhighlight>
<syntaxhighlight lang="text" class="" id="" style="" inline="1">no=Neg</syntaxhighlight>
<syntaxhighlight lang="text" class="" id="" style="" inline="1">blank=Blank</syntaxhighlight>
<syntaxhighlight lang="text" class="" id="" style="" inline="1">¬=Undefined</syntaxhighlight>
<syntaxhighlight lang="text" class="" id="" style="" inline="1">def=Def</syntaxhighlight>
Note
yes, y, true, 1* <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{yesno|yes}}</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">yes by definition</syntaxhighlight> "yes" "Pos" * Case-insensitive (Y=y)
Some Text <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{yesno|Some Text}}</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">yes by default</syntaxhighlight> "yes" "Def" "Pos" when def=[omitted]
no, n, false, 0* <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{yesno|no}}</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">no by definition</syntaxhighlight> "" [blank] "Neg" * Case-insensitive (N=n)
[blank] <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{yesno|}}</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">blank</syntaxhighlight> "" [blank] "Blank" "Neg" when blank=[omitted]
1=[blank] <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{yesno|1=}}</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">blank</syntaxhighlight> "" [blank] "Blank" "Neg" when blank=[omitted]
¬ <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{yesno|¬}}</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">¬</syntaxhighlight> "" [blank] "Undefined"
[omitted] <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{yesno}}</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">¬</syntaxhighlight> "" [blank] "Undefined"
Comparison with related templates
Input parameter 1 (<syntaxhighlight lang="text" class="" id="" style="" inline="1">1=</syntaxhighlight>) {{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

  • Module:yesno
  • Script error: No such module "Template link general". – slower than Yesno, but can properly handle ref tags inside the parameters
  • Script error: No such module "Template link general". – variant of Yesno that defaults to "yes" if value is not explicitly negative
  • Script error: No such module "Template link general". – variant of Yesno that defaults to "no" if value is not explicitly positive

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Yesno

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

Template parameters

ParameterDescriptionTypeStatus
Input value1

The value to be evaluated

Stringrequired
Output on yesyes

Specifies the output of the template when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1'

Stringoptional
Output on nono

Specifies the output of the template when the input value is a case-insensitive forms of 'No', 'N', 'False, or '0'

Stringoptional
Output on blank inputblank

Specifies the output of the template when the input value is defined but is either empty or contains nothing but whitespace character(s)

Stringoptional
Output on ¬¬

Specifies the output of the template when the input value is either '¬' or entirely missing (undefined)

Stringoptional
Definite outputdef

Specifies the output of the template when the input value is defined but not a form of 'yes', 'no', '1', '0', '¬' or blank

Stringoptional