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.

{{ModuleQuality}}

<syntaxhighlight lang="lua">

yesno(value, default)

</syntaxhighlight>

<code>value</code> is the value to be tested.

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

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.

<syntaxhighlight lang="lua">

local yesno = require('Module:Yesno')

</syntaxhighlight>

Some input values always return <code>true</code>, and some always return <code>false</code>.

<code>nil</code> values always return <code>nil</code>.

<syntaxhighlight lang="lua">

-- These always return true:

yesno(true)

-- These always return false:

yesno('no')

yesno(false)

-- A nil value always returns nil:

yesno(nil)

yesno('tRuE')

-- These always return false:

yesno('No')

</syntaxhighlight>

You can specify a default value if <code>yesno</code> receives input other than that listed above.

If you don't supply a default, the module will return <code>nil</code> for these inputs.

<syntaxhighlight lang="lua">

-- These return nil:

yesno(function() return 'This is a function.' end)

-- These return true:

yesno('foo', true)

yesno(function() return 'This is a function.' end, true)

-- These return "bar":

yesno('foo', 'bar')

</syntaxhighlight>

Although the blank string usually evaluates to <code>false</code> in wikitext, it evaluates to <code>true</code> in Lua.

This module prefers the Lua behaviour over the wikitext behaviour.

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

}}