Template:Bool/doc

From Sword of Moonlight Wiki
Revision as of 19:57, 13 September 2024 by Verdite cat (talk | contribs) (Created page with "This simple helper template will display <code>{{bool|y}}</code> if its input is <code>y</code>, <code>yes</code>, <code>true</code>, or <code>1</code>. It will not display anything otherwise. The empty input is special, you can change its behavior via unnamed parameter 2, see examples below. This is useful for handle revert flag option parameters, such as <code>|link=no</code>, which empty input means "true". This functionality is useful for templates where a parameter...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This simple helper template will display y if its input is y, yes, true, or 1. It will not display anything otherwise. The empty input is special, you can change its behavior via unnamed parameter 2, see examples below. This is useful for handle revert flag option parameters, such as |link=no, which empty input means "true".

This functionality is useful for templates where a parameter should only have an effect if it is set to one of these positive values. It is especially helpful for the integration of TemplateData, which sets a parameter that is marked as Boolean to 0 if it is added and de-selected.

Usage

{ bool | <string> | <value for empty input> ]

First unnamed parameter

The input string to check.

Examples

Code Result
{{bool|y}} y
{{bool|yes}} y
{{bool|true}} y
{{bool|1}} y
{{bool|n}}
{{bool|no}}
{{bool|false}}
{{bool|0}}
{{bool|foo}}
{{bool|}}
{{bool||y}} y
{{bool|2=y}} y
{{[[Template:#if:{{bool|{{{format|yes}}}}}|#if:{{bool|{{{format|yes}}}}}]]|format|don't format}} format
{{[[Template:#if:{{bool|{{{format|false}}}}}|#if:{{bool|{{{format|false}}}}}]]|format|don't format}} don't format