Module:Yesno/doc: Difference between revisions

<noinclude><!--

-->{{#ifeq:{{SUBPAGENAME}}|doc||{{Documentation subpage}}}}<!--

--></noinclude>{{#switch:

| =

<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->

{{high-risk}}

{{used in system}}

{{Module rating|release}}

{{Module rating|protected}}

This module provides a consistent interface for processing boolean or boolean-style string input.

While Lua allows the <code>true</code> and <code>false</code> boolean values, wikicode templates can only express boolean values through strings such as "1", "0", "yes", "no", etc.

The module also accepts other Lua structures as input, i.e. booleans, numbers, tables, and functions.

If it is passed input that it does not recognise as boolean or <code>nil</code>, it is possible to specify a default value to return.

== Module Quality ==

{{ModuleQuality}}

== Syntax ==

<syntaxhighlight lang="lua">

yesno(value, default)

Boolean input or boolean-style input (see below) always evaluates to either <code>true</code> or <code>false</code>, and <code>nil</code> always evaluates to <code>nil</code>.

Other values evaluate to <code>default</code>.

== Usage ==

First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages.

For normal wiki pages you can use {{tlx|yesno}} instead.

<includeonly>{{Sandbox other||

<!-- Categories below this line; interwikis at Wikidata -->

[[Category:Modules]]

}}</includeonly><noinclude>

</noinclude>

| #default=

{{#invoke:Template translation|renderTranslatedTemplate|template=Module:Yesno/doc|noshift=1|uselang={{int:lang}}}}

}}