Module:Yesno/doc: Difference between revisions

From DynamicPageList3 Manual
Content added Content deleted
No edit summary
(Make translatable)
Line 1: Line 1:
<noinclude>
⚫
{{Languages|Module:Yesno/doc}}
{{#ifeq:{{SUBPAGENAME}}|doc||{{Documentation subpage}}}}
<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}}
{{Shared Template Warning}}
{{high-risk}}
{{high-risk}}
Line 5: Line 11:
{{Module rating|release}}
{{Module rating|release}}
{{Module rating|protected}}
{{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 "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.
<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>


== Syntax ==
== Syntax ==


<syntaxhighlight lang="lua">yesno(value, default)</syntaxhighlight>
<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>.


⚫
<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>
<translate>
== Usage ==
== Usage ==
</translate>

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 {{tl|yesno}} instead.
<translate>First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages.</translate> <translate>For normal wiki pages you can use <tvar name=1>{{tlx|yesno}}</tvar> instead.</translate>


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 21: Line 29:
</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>.
<translate>Some input values always return <tvar name=1><code>true</code></tvar>, and some always return <tvar name=2><code>false</code></tvar>.</translate> <translate><tvar name=1><code>nil</code></tvar> values always return <tvar name=1><code>nil</code></tvar>.</translate>


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- These always return true:
-- <translate nowrap>These always return <tvar name=1>true</tvar>:</translate>
yesno('yes')
yesno('yes')
yesno('y')
yesno('y')
Line 33: Line 41:
yesno(true)
yesno(true)


-- These always return false:
-- <translate nowrap>These always return <tvar name=1>false</tvar>:</translate>
yesno('no')
yesno('no')
yesno('n')
yesno('n')
Line 42: Line 50:
yesno(false)
yesno(false)


-- A nil value always returns nil:
-- <translate nowrap>A <tvar name=1>nil</tvar> value always returns <tvar name=1>nil</tvar>:</translate>
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:
-- <translate nowrap>These always return <tvar name=1>true</tvar>:</translate>
yesno('Yes')
yesno('Yes')
yesno('YES')
yesno('YES')
Line 56: Line 64:
yesno('tRuE')
yesno('tRuE')


-- These always return false:
-- <translate nowrap>These always return <tvar name=1>false</tvar>:</translate>
yesno('No')
yesno('No')
yesno('NO')
yesno('NO')
Line 64: Line 72:
</syntaxhighlight>
</syntaxhighlight>


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.
<translate>You can specify a default value if <tvar name=1><code>yesno</code></tvar> receives input other than that listed above.</translate> <translate>If you don't supply a default, the module will return <tvar name=1><code>nil</code></tvar> for these inputs.</translate>


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- These return nil:
-- <translate nowrap>These return <tvar name=1>nil</tvar>:</translate>
yesno('foo')
yesno('foo')
yesno({})
yesno({})
Line 73: Line 81:
yesno(function() return 'This is a function.' end)
yesno(function() return 'This is a function.' end)


-- These return true:
-- <translate nowrap>These return <tvar name=1>true</tvar>:</translate>
yesno('foo', true)
yesno('foo', true)
yesno({}, true)
yesno({}, true)
Line 79: Line 87:
yesno(function() return 'This is a function.' end, true)
yesno(function() return 'This is a function.' end, true)


-- These return "bar":
-- <translate nowrap>These return <tvar name=1>"bar"</tvar>:</translate>
yesno('foo', 'bar')
yesno('foo', 'bar')
yesno({}, 'bar')
yesno({}, 'bar')
Line 85: Line 93:
yesno(function() return 'This is a function.' end, 'bar')
yesno(function() return 'This is a function.' end, 'bar')
</syntaxhighlight>
</syntaxhighlight>
<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('') -- Returns nil.
yesno('') -- <translate nowrap>Returns <tvar name=1>nil</tvar>.</translate>
yesno('', true) -- Returns true.
yesno('', true) -- <translate nowrap>Returns <tvar name=1>true</tvar>.</translate>
yesno('', 'bar') -- Returns "bar".
yesno('', 'bar') -- <translate nowrap>Returns <tvar name=1>"bar"</tvar>.</translate>
</syntaxhighlight>
</syntaxhighlight>


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||
<translate>Although the blank string usually evaluates to false in wikitext, it evaluates to true in Lua.</translate> <translate>This module prefers the Lua behaviour over the wikitext behaviour.</translate> <translate>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.</translate>
<includeonly>{{Sandbox other||
⚫
[[Category:Lua metamodules]]
<!-- Categories below this line; interwikis at Wikidata -->
⚫
}}</includeonly>
⚫
[[Category:Modules]]
⚫
}}</includeonly><noinclude>
[[Category:Module documentation pages{{#translation:}}]]
</noinclude>
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Module:Yesno/doc|noshift=1|uselang={{int:lang}}}}
}}

Revision as of 13:26, 30 June 2021


<languages /> Script error: No such module "Template translation".

Retrieved from "https://dpl3.wikitide.org/wiki/Module:Yesno/doc?oldid=1492"