Saucy: doc

2021-06-09T01:43:12Z

doc

New page

This template evaluates any input and produces a normalized <samp>yes</samp> or nil output, based on the content of the input and several configurable options. It is not meant for use directly in articles, but for making templates.

== In a nutshell ==
If the input the template receives is (not case sensitive) "no", "n", "false", "off", "0", is only whitespace, or is entirely missing; then the template returns an empty string. If any other value is received, then the template returns "yes".

This is useful for creating opt-in parameters in templates. For example, a nocat parameter:

<code><nowiki>{{#if: {{yesno| {{{nocat|}}} }} ||[[Category:Your category here]]}}</nowiki></code>

In this example, the template adds the page to the category, but if the user does not want that then they can set the parameter <code>nocat=yes</code>, <code>nocat=y</code>, etc.

This is a basic use case for this template. What the template outputs can be changed. For more complex usage, read [[wp:Template:Yesno|Wikipedia's documentation]].

== TemplateData ==
<templatedata>
{
"description": "This template normalises an input to be a yes or nil 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>

Template:Yesno/doc - Revision history

Saucy: doc