Module:Yesno/doc: Difference between revisions

Revision as of 13:21, 7 July 2020

Latest revision as of 21:05, 16 December 2024

(58 intermediate revisions by 43 users not shown)

Line 1:

<noinclude>{{High-usepp|all-pages small= yes}}

</noinclude>{{used in system}}

{{Module rating|protected}}

{{cascade-protected template|page=module}}

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 "yes", "no", etc. This module processes these kinds of strings and turns them into boolean input for Lua to process. It also returns <code>nil</code> values as <code>nil</code>, to allow for distinctions between <code>nil</code> and <code>false</code>. 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.

Line 26 ⟶ 27:

yesno('true')

yesno('t')

yesno('on')

yesno('1')

yesno(1)

Line 35 ⟶ 37:

yesno('false')

yesno('f')

yesno('off')

yesno('0')

yesno(0)

Line 41 ⟶ 44:

-- A nil value always returns nil:

yesno(nil)

yesno()

</syntaxhighlight>

Line 61 ⟶ 65:

</syntaxhighlight>

===Undefined input ('foo')===

You can specify a default value if yesno 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(nil)

yesno('foo')

yesno({})

yesno(5)

yesno('')

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

yesno(nil, true)

yesno(nil, 'bar')

-- These return true:

Line 74 ⟶ 83:

yesno({}, true)

yesno(5, true)

yesno('', true)

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

Line 80 ⟶ 90:

yesno({}, 'bar')

yesno(5, 'bar')

yesno('', 'bar')

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

</syntaxhighlight>

Although the blankempty string usually evaluates to false in wikitext, it evaluates to true in Lua. This module prefers the Lua behaviour over the wikitext behaviour. If treating the blankempty string as false is important for your module, you will need to removeconvert blankempty argumentsstrings atto ana earliervalue stagethat ofevaluates processingto false before passing them to this module.<includeonly>{{#ifeq In the case of arguments received from wikitext, this can be done by using [[Module:{{SUBPAGENAME}}|sandbox||Arguments]].

Note that the blank string also functions this way:

===Handling nil results===

By definition:

<syntaxhighlight lang="lua">

yesno(''nil) -- Returns nil.

yesno('foo', true) -- Returns truenil.

yesno(''nil, 'bar'true) -- Returns "bar"nil.

yesno(nil, false) -- Returns nil.

yesno('foo', true) -- Returns true.

</syntaxhighlight>

To get the binary <syntaxhighlight lang="lua" inline>true/false</syntaxhighlight>-only values, use code like:

Although the blank string usually evaluates to false in wikitext, it evaluates to true in Lua. This module prefers the Lua behaviour over the wikitext behaviour. If treating the blank string as false is important for your module, you will need to remove blank arguments at an earlier stage of processing.<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

<syntaxhighlight lang="lua">

myvariable = yesno(value or false) -- When value is nil, result is false.

myvariable = yesno(value or true) -- When value is nil, result is true. (XXX: when value is false, result is true...)

myvariable = yesno('foo') or false -- Unknown string returns nil, result is false.

myvariable = yesno('foo', true) or false -- Default value (here: true) applies, result is true.

</syntaxhighlight>

Better suggestions:

<syntaxhighlight lang="lua">

local myvariable = yesno(value)

if myvariable == nil then -- value is nil or an unrecognized string

myvariable = true

end

-- more efficient when value is nil, but more verbose

-- (note the default result has to be written twice)

local myvariable

if value == nil then

myvariable = true

else

myvariable = yesno(value, true)

end

</syntaxhighlight><!--

--><includeonly>{{sandbox other||

[[Category:Lua metamodules]]

}}</includeonly>

<noinclude>

[[Category:Module documentation pages]]

</noinclude>