Anonymous user
This wiki has been automatically closed because there have been no edits or log actions made within the last 60 days. If you are a user (who is not the bureaucrat) that wishes for this wiki to be reopened, please request that at Requests for reopening wikis. If this wiki is not reopened within 6 months it may be deleted. Note: If you are a bureaucrat on this wiki, you can go to Special:ManageWiki and uncheck the "Closed" box to reopen it.Module:Yesno/doc: Difference between revisions
Marked this version for translation
mNo edit summary |
(Marked this version for translation) |
||
Line 11:
{{Module rating|release}}
{{Module rating|protected}}
<translate><!--T:1--> This module provides a consistent interface for processing boolean or boolean-style string input.</translate>
<translate><!--T:2--> 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><!--T:3--> This module processes these kinds of strings and turns them into boolean input for Lua to process.</translate>
<translate><!--T:4--> 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><!--T:5--> The module also accepts other Lua structures as input, i.e. booleans, numbers, tables, and functions.</translate>
<translate><!--T:6--> 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 ==
Line 24:
</syntaxhighlight>
<translate><!--T:7--> <tvar name=1><code>value</code></tvar> is the value to be tested.</translate>
<translate><!--T:8--> 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><!--T:9--> Other values evaluate to <tvar name=1><code>default</code></tvar>.</translate>
<translate>
== Usage == <!--T:10-->
</translate>
<translate><!--T:11--> First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages.</translate>
<translate><!--T:12--> For normal wiki pages you can use <tvar name=1>{{tlx|yesno}}</tvar> instead.</translate>
<syntaxhighlight lang="lua">
Line 37:
</syntaxhighlight>
<translate><!--T:13--> 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><!--T:14--> <tvar name=1><code>nil</code></tvar> values always return <tvar name=1><code>nil</code></tvar>.</translate>
<syntaxhighlight lang="lua">
-- <translate nowrap><!--T:15--> These always return <tvar name=1>true</tvar>:</translate>
yesno('yes')
yesno('y')
Line 50:
yesno(true)
-- <translate nowrap><!--T:16--> These always return <tvar name=1>false</tvar>:</translate>
yesno('no')
yesno('n')
Line 59:
yesno(false)
-- <translate nowrap><!--T:17--> A <tvar name=1>nil</tvar> value always returns <tvar name=1>nil</tvar>:</translate>
yesno(nil)
</syntaxhighlight>
<translate>
<!--T:18-->
String values are converted to lower case before they are matched:
</translate>
<syntaxhighlight lang="lua">
-- <translate nowrap><!--T:19--> These always return <tvar name=1>true</tvar>:</translate>
yesno('Yes')
yesno('YES')
Line 73 ⟶ 74:
yesno('tRuE')
-- <translate nowrap><!--T:20--> These always return <tvar name=1>false</tvar>:</translate>
yesno('No')
yesno('NO')
Line 81 ⟶ 82:
</syntaxhighlight>
<translate><!--T:21--> You can specify a default value if <tvar name=1><code>yesno</code></tvar> receives input other than that listed above.</translate>
<translate><!--T:22--> 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">
-- <translate nowrap><!--T:23--> These return <tvar name=1>nil</tvar>:</translate>
yesno('foo')
yesno({})
Line 91 ⟶ 92:
yesno(function() return 'This is a function.' end)
-- <translate nowrap><!--T:24--> These return <tvar name=1>true</tvar>:</translate>
yesno('foo', true)
yesno({}, true)
Line 97 ⟶ 98:
yesno(function() return 'This is a function.' end, true)
-- <translate nowrap><!--T:25--> These return <tvar name=1>"bar"</tvar>:</translate>
yesno('foo', 'bar')
yesno({}, 'bar')
Line 104 ⟶ 105:
</syntaxhighlight>
<translate>
<!--T:26-->
Note that the blank string also functions this way:
</translate>
<syntaxhighlight lang="lua">
yesno('') -- <translate nowrap><!--T:27--> Returns <tvar name=1>nil</tvar>.</translate>
yesno('', true) -- <translate nowrap><!--T:28--> Returns <tvar name=1>true</tvar>.</translate>
yesno('', 'bar') -- <translate nowrap><!--T:29--> Returns <tvar name=1>"bar"</tvar>.</translate>
</syntaxhighlight>
<translate><!--T:30--> Although the blank string usually evaluates to false in wikitext, it evaluates to true in Lua.</translate>
<translate><!--T:31--> This module prefers the Lua behaviour over the wikitext behaviour.</translate>
<translate><!--T:32--> 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||
<!-- Categories below this line; interwikis at Wikidata -->
| |||