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
m
Adapt for this wiki
m (Undo revision 4677186 by ExE Boss (talk): It did not work) |
imported>FrozenPlum m (Adapt for this wiki) |
||
| (11 intermediate revisions by 3 users not shown) | |||
Line 1:
{{Documentation subpage}}
<noinclude>▼
This module provides a consistent interface for processing boolean or boolean-style string input.
== Syntax ==▼
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.
▲== Syntax ==
<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>.
== Usage ==
▲<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">
Line 29 ⟶ 25:
</syntaxhighlight>
<code>nil</code> values always return <code>nil</code>.
<syntaxhighlight lang="lua">
--
yesno('yes')
yesno('y')
Line 41 ⟶ 38:
yesno(true)
--
yesno('no')
yesno('n')
Line 50 ⟶ 47:
yesno(false)
--
yesno(nil)
</syntaxhighlight>
String values are converted to lower case before they are matched:
<syntaxhighlight lang="lua">
--
yesno('Yes')
yesno('YES')
Line 64 ⟶ 59:
yesno('tRuE')
--
yesno('No')
yesno('NO')
Line 72 ⟶ 67:
</syntaxhighlight>
If you don't supply a default, the module will return <code>nil</code> for these inputs.
<syntaxhighlight lang="lua">
--
yesno('foo')
yesno({})
Line 81 ⟶ 77:
yesno(function() return 'This is a function.' end)
--
yesno('foo', true)
yesno({}, true)
Line 87 ⟶ 83:
yesno(function() return 'This is a function.' end, true)
--
yesno('foo', 'bar')
yesno({}, 'bar')
Line 93 ⟶ 89:
yesno(function() return 'This is a function.' end, 'bar')
</syntaxhighlight>
<!--T:26-->
Note that the blank string also functions this way:
<syntaxhighlight lang="lua">
yesno('') --
yesno('', true) --
yesno('', 'bar') --
</syntaxhighlight>
This module prefers the Lua behaviour over the wikitext behaviour.
<includeonly>{{Sandbox other||▼
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.
▲<noinclude>
<!-- Template categories/interwikis here -->
[[Category:Modules]]
| |||