Module:Yesno/doc: Difference between revisions
(Make translatable) |
imported>FrozenPlum m (Adapt for this wiki) |
||
(13 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
|||
⚫ | |||
<!-- Documentation here --> |
|||
<languages /> |
|||
</noinclude>{{#switch:<translate></translate> |
|||
| = |
|||
<includeonly>{{Languages|Module:Yesno/doc}}</includeonly> |
|||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> |
|||
{{Shared Template Warning}} |
|||
{{high-risk}} |
|||
{{used in system}} |
|||
{{Module rating|release}} |
|||
{{Module rating|protected}} |
|||
<translate>This module provides a consistent interface for processing boolean or boolean-style string input.</translate> <translate>While Lua allows the <tvar name=1><code>true</code></tvar> and <tvar name=2><code>false</code></tvar> boolean values, wikicode templates can only express boolean values through strings such as <tvar name=3>"1"</tvar>, <tvar name=4>"0"</tvar>, <tvar name=5>"yes"</tvar>, <tvar name=6>"no"</tvar>, etc.</translate> <translate>This module processes these kinds of strings and turns them into boolean input for Lua to process.</translate> <translate>It also returns <tvar name=1><code>nil</code></tvar> values as <tvar name=1><code>nil</code></tvar>, to allow for distinctions between <tvar name=1><code>nil</code></tvar> and <tvar name=2><code>false</code></tvar>.</translate> <translate>The module also accepts other Lua structures as input, i.e. booleans, numbers, tables, and functions.</translate> <translate>If it is passed input that it does not recognise as boolean or <tvar name=1><code>nil</code></tvar>, it is possible to specify a default value to return.</translate> |
|||
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. |
|||
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 recognize as boolean or <code>nil</code>, it is possible to specify a default value to return. |
|||
⚫ | |||
<syntaxhighlight lang="lua"> |
<syntaxhighlight lang="lua"> |
||
yesno(value, default) |
yesno(value, default) |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
<code>value</code> is the value to be tested. |
|||
<translate><tvar name=1><code>value</code></tvar> is the value to be tested.</translate> <translate>Boolean input or boolean-style input (see below) always evaluates to either <tvar name=1><code>true</code></tvar> or <tvar name=2><code>false</code></tvar>, and <tvar name=3><code>nil</code></tvar> always evaluates to <tvar name=3><code>nil</code></tvar>.</translate> <translate>Other values evaluate to <tvar name=1><code>default</code></tvar>.</translate> |
|||
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>. |
|||
<translate> |
|||
Other values evaluate to <code>default</code>. |
|||
== Usage == |
== Usage == |
||
⚫ | |||
</translate> |
|||
⚫ | |||
<syntaxhighlight lang="lua"> |
<syntaxhighlight lang="lua"> |
||
Line 29: | Line 25: | ||
</syntaxhighlight> |
</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"> |
<syntaxhighlight lang="lua"> |
||
-- |
-- These always return true: |
||
yesno('yes') |
yesno('yes') |
||
yesno('y') |
yesno('y') |
||
Line 41: | Line 38: | ||
yesno(true) |
yesno(true) |
||
-- |
-- These always return false: |
||
yesno('no') |
yesno('no') |
||
yesno('n') |
yesno('n') |
||
Line 50: | Line 47: | ||
yesno(false) |
yesno(false) |
||
-- |
-- A nil value always returns nil: |
||
yesno(nil) |
yesno(nil) |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
<translate> |
|||
String values are converted to lower case before they are matched: |
String values are converted to lower case before they are matched: |
||
</translate> |
|||
<syntaxhighlight lang="lua"> |
<syntaxhighlight lang="lua"> |
||
-- |
-- These always return true: |
||
yesno('Yes') |
yesno('Yes') |
||
yesno('YES') |
yesno('YES') |
||
Line 64: | Line 59: | ||
yesno('tRuE') |
yesno('tRuE') |
||
-- |
-- These always return false: |
||
yesno('No') |
yesno('No') |
||
yesno('NO') |
yesno('NO') |
||
Line 72: | Line 67: | ||
</syntaxhighlight> |
</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"> |
<syntaxhighlight lang="lua"> |
||
-- |
-- These return nil: |
||
yesno('foo') |
yesno('foo') |
||
yesno({}) |
yesno({}) |
||
Line 81: | Line 77: | ||
yesno(function() return 'This is a function.' end) |
yesno(function() return 'This is a function.' end) |
||
-- |
-- These return true: |
||
yesno('foo', true) |
yesno('foo', true) |
||
yesno({}, true) |
yesno({}, true) |
||
Line 87: | Line 83: | ||
yesno(function() return 'This is a function.' end, true) |
yesno(function() return 'This is a function.' end, true) |
||
-- |
-- These return "bar": |
||
yesno('foo', 'bar') |
yesno('foo', 'bar') |
||
yesno({}, 'bar') |
yesno({}, 'bar') |
||
Line 93: | Line 89: | ||
yesno(function() return 'This is a function.' end, 'bar') |
yesno(function() return 'This is a function.' end, 'bar') |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
<!--T:26--> |
|||
<translate> |
|||
Note that the blank string also functions this way: |
Note that the blank string also functions this way: |
||
</translate> |
|||
<syntaxhighlight lang="lua"> |
<syntaxhighlight lang="lua"> |
||
yesno('') -- |
yesno('') -- Returns nil. |
||
yesno('', true) -- |
yesno('', true) -- Returns true. |
||
yesno('', 'bar') -- |
yesno('', 'bar') -- Returns "bar". |
||
</syntaxhighlight> |
</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. |
|||
⚫ | |||
If treating the blank string as <code>false</code> is important for your module, you will need to remove blank arguments at an earlier stage of processing. |
|||
<!-- Categories below this line; interwikis at Wikidata --> |
|||
⚫ | |||
⚫ | |||
<!-- Template categories/interwikis here --> |
|||
[[Category:Modules]] |
[[Category:Modules]] |
||
</includeonly> |
|||
[[Category:Module documentation pages{{#translation:}}]] |
|||
</noinclude> |
|||
| #default= |
|||
{{#invoke:Template translation|renderTranslatedTemplate|template=Module:Yesno/doc|noshift=1|uselang={{int:lang}}}} |
|||
}} |
Latest revision as of 04:37, 30 March 2022
This module provides a consistent interface for processing boolean or boolean-style string input.
While Lua allows the true
and false
boolean values, wikicode templates can only express boolean values through strings such as "1", "0", "yes", "no", etc.
This module processes these kinds of strings and turns them into boolean input for Lua to process.
It also returns nil
values as nil
, to allow for distinctions between nil
and false
.
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 recognize as boolean or nil
, it is possible to specify a default value to return.
Syntax
yesno(value, default)
value
is the value to be tested.
Boolean input or boolean-style input (see below) always evaluates to either true
or false
, and nil
always evaluates to nil
.
Other values evaluate to default
.
Usage
First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages.
local yesno = require('Module:Yesno')
Some input values always return true
, and some always return false
.
nil
values always return nil
.
-- These always return true:
yesno('yes')
yesno('y')
yesno('true')
yesno('t')
yesno('1')
yesno(1)
yesno(true)
-- These always return false:
yesno('no')
yesno('n')
yesno('false')
yesno('f')
yesno('0')
yesno(0)
yesno(false)
-- A nil value always returns nil:
yesno(nil)
String values are converted to lower case before they are matched:
-- These always return true:
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')
-- These always return false:
yesno('No')
yesno('NO')
yesno('nO')
yesno('N')
yesno('fALsE')
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 nil
for these inputs.
-- These return nil:
yesno('foo')
yesno({})
yesno(5)
yesno(function() return 'This is a function.' end)
-- These return true:
yesno('foo', true)
yesno({}, true)
yesno(5, true)
yesno(function() return 'This is a function.' end, true)
-- These return "bar":
yesno('foo', 'bar')
yesno({}, 'bar')
yesno(5, 'bar')
yesno(function() return 'This is a function.' end, 'bar')
Note that the blank string also functions this way:
yesno('') -- Returns nil.
yesno('', true) -- Returns true.
yesno('', 'bar') -- Returns "bar".
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.