Template:Yesno/doc - Revision history

JJR: /* TemplateData */

2022-02-26T22:09:06Z

TemplateData

← Older revision		Revision as of 22:09, 26 February 2022
Line 94:		Line 94:
	}		}
	</templatedata>		</templatedata>

			== See Also ==
			* https://www.mediawiki.org/wiki/Template:Yesno

	<includeonly>		<includeonly>

JJR at 23:51, 23 February 2022

2022-02-23T23:51:16Z

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

2022-02-23T23:40:02Z

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

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", "true", "on" and "1"; e.g. {{tlf|Yesno|yEs}}
# '''No''': Case-insensitive forms of "No", "n", "false", "off" 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=}}"

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

== TemplateData ==
<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 'true', 'on', '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 'false', 'off', '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>

← Older revision		Revision as of 23:51, 23 February 2022
Line 14:		Line 14:

	===Customizing the output===		===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:		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 ~~{{para\|~~yes}}, otherwise returns "yes". For example:		# '''Yes''': Template returns the contents of yes, otherwise returns "yes". For example:
	#* {{tlx\|yesno\|y\|3=yes=Yeah}} results in "{{yesno\|y\|yes=Yeah}}"		#* {{tlx\|yesno\|y\|3=yes=Yeah}} results in "{{yesno\|y\|yes=Yeah}}"
	#* {{tlx\|yesno\|y\|3=yes=bacon}} results in "{{yesno\|y\|yes=bacon}}"		#* {{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:		# '''No''': Template returns the contents of no, otherwise returns blank. For example:
	#* {{tlx\|yesno\|n\|3=no=Nay}} results in "{{yesno\|n\|no=Nay}}"		#* {{tlx\|yesno\|n\|3=no=Nay}} results in "{{yesno\|n\|no=Nay}}"
	#* {{tlx\|yesno\|n\|3=no=ham}} results in "{{yesno\|n\|no=ham}}"		#* {{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.		# '''Nothing''': Template returns the contents of blank or no in absence of the former; otherwise, returns blank.
	#* {{tlx\|yesno\|\|3=blank=eggs}} results in "{{yesno\|\|blank=eggs}}"		#* {{tlx\|yesno\|\|3=blank=eggs}} results in "{{yesno\|\|blank=eggs}}"
	#* {{tlx\|yesno\|\|3=no=ham}} results in "{{yesno\|\|no=ham}}"		#* {{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}}"		#* {{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:		# '''Negation''': Template returns the contents of ¬, otherwise returns blank. For example:
	#* {{tlx\|yesno\|¬\|3=¬=sausage}} results in "{{yesno\|¬\|¬=sausage}}"		#* {{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".		# '''Anything else''': Template returns the contents of def or 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=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=yes=bacon}} results in "{{yesno\|purple monkey dish washer\|yes=bacon}}"