Module:Yesno/doc - Revision history

Majestix: Marked this version for translation

2026-04-06T15:55:03Z

Marked this version for translation

← Older revision		Revision as of 17:55, 6 April 2026
Line 1:		Line 1:
	<languages/>		<languages/>
	<translate>		<translate>
			<!--T:35-->
	<noinclude><!--		<noinclude><!--
	-->{{#ifeq:{{SUBPAGENAME}}\|doc\|\|{{Documentation subpage}}}}<!--		-->{{#ifeq:{{SUBPAGENAME}}\|doc\|\|{{Documentation subpage}}}}<!--
Line 14:		Line 15:
	{{Module rating\|protected}}		{{Module rating\|protected}}
	<translate>		<translate>
			<!--T:36-->
	This module provides a consistent interface for processing boolean or boolean-style string input.		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.		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.
Line 21:		Line 23:
	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.		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.

	== Module Quality ==		== Module Quality == <!--T:37-->

	</translate>		</translate>
Line 27:		Line 29:
	<translate>		<translate>

	== Syntax ==		== Syntax == <!--T:38-->

			<!--T:39-->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	yesno(value, default)		yesno(value, default)
	</syntaxhighlight>		</syntaxhighlight>

			<!--T:40-->
	<code>value</code> is the value to be tested.		<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>.		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>.		Other values evaluate to <code>default</code>.

	== Usage ==		== Usage == <!--T:41-->

			<!--T:42-->
	First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages.		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 {{tlx\|yesno}} instead.		For normal wiki pages you can use {{tlx\|yesno}} instead.

			<!--T:43-->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local yesno = require('Module:Yesno')		local yesno = require('Module:Yesno')
	</syntaxhighlight>		</syntaxhighlight>

			<!--T:44-->
	Some input values always return <code>true</code>, and some always return <code>false</code>.		Some input values always return <code>true</code>, and some always return <code>false</code>.
	<code>nil</code> values always return <code>nil</code>.		<code>nil</code> values always return <code>nil</code>.

			<!--T:45-->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- These always return true:		-- These always return true:
Line 59:		Line 67:
	yesno(true)		yesno(true)

			<!--T:46-->
	-- These always return false:		-- These always return false:
	yesno('no')		yesno('no')
Line 68:		Line 77:
	yesno(false)		yesno(false)

			<!--T:47-->
	-- A nil value always returns nil:		-- A nil value always returns nil:
	yesno(nil)		yesno(nil)
Line 80:		Line 90:
	yesno('tRuE')		yesno('tRuE')

			<!--T:48-->
	-- These always return false:		-- These always return false:
	yesno('No')		yesno('No')
Line 88:		Line 99:
	</syntaxhighlight>		</syntaxhighlight>

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

			<!--T:50-->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- These return nil:		-- These return nil:
Line 98:		Line 111:
	yesno(function() return 'This is a function.' end)		yesno(function() return 'This is a function.' end)

			<!--T:51-->
	-- These return true:		-- These return true:
	yesno('foo', true)		yesno('foo', true)
Line 104:		Line 118:
	yesno(function() return 'This is a function.' end, true)		yesno(function() return 'This is a function.' end, true)

			<!--T:52-->
	-- These return "bar":		-- These return "bar":
	yesno('foo', 'bar')		yesno('foo', 'bar')
Line 117:		Line 132:
	</syntaxhighlight>		</syntaxhighlight>

			<!--T:53-->
	Although the blank string usually evaluates to <code>false</code> in wikitext, it evaluates to <code>true</code> in Lua.		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.		This module prefers the Lua behaviour over the wikitext behaviour.
Line 129:		Line 145:
	<translate>		<translate>

			<!--T:54-->
	</noinclude>		</noinclude>
	\| #default=		\| #default=

Majestix: Prepared the page for translation

2026-04-06T15:43:27Z

Prepared the page for translation

← Older revision		Revision as of 17:43, 6 April 2026
Line 1:		Line 1:
			<languages/>
			<translate>
	<noinclude><!--		<noinclude><!--
	-->{{#ifeq:{{SUBPAGENAME}}\|doc\|\|{{Documentation subpage}}}}<!--		-->{{#ifeq:{{SUBPAGENAME}}\|doc\|\|{{Documentation subpage}}}}<!--
Line 4:		Line 6:
	--></noinclude>{{#switch:		--></noinclude>{{#switch:
	\| =		\| =
	<includeonly>~~{{Languages\|Module:Yesno/doc}}~~</includeonly>		<includeonly></includeonly>
	<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->		<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
			</translate>
	{{high-risk}}		{{high-risk}}
	{{used in system}}		{{used in system}}
	{{Module rating\|release}}		{{Module rating\|release}}
	{{Module rating\|protected}}		{{Module rating\|protected}}
			<translate>
	This module provides a consistent interface for processing boolean or boolean-style string input.		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.		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.
Line 16:		Line 20:
	The module also accepts other Lua structures as input, i.e. booleans, numbers, tables, and functions.		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.		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.

	== Module Quality ==		== Module Quality ==

			</translate>
	{{ModuleQuality}}		{{ModuleQuality}}
			<translate>

	== Syntax ==		== Syntax ==

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	yesno(value, default)		yesno(value, default)
Line 26:		Line 36:
	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>.		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>.		Other values evaluate to <code>default</code>.

	== Usage ==		== Usage ==

	First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages.		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 {{tlx\|yesno}} instead.		For normal wiki pages you can use {{tlx\|yesno}} instead.
Line 110:		Line 122:
	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	<!-- Categories below this line; interwikis at Wikidata -->		<!-- Categories below this line; interwikis at Wikidata -->

			</translate>
	[[Category:Modules]]		[[Category:Modules]]
	}}</includeonly><noinclude>		}}</includeonly><noinclude>
	[[Category:Module documentation pages{{#translation:}}]]		[[Category:Module documentation pages{{#translation:}}{{#translation:}}]]
			<translate>

	</noinclude>		</noinclude>
	\| #default=		\| #default=
	{{#invoke:Template translation\|renderTranslatedTemplate\|template=Module:Yesno/doc\|noshift=1\|uselang={{int:lang}}}}		{{#invoke:Template translation\|renderTranslatedTemplate\|template=Module:Yesno/doc\|noshift=1\|uselang={{int:lang}}}}
	}}		}}
			</translate>

Majestix: Removed page from translation

2026-04-06T15:41:49Z

Removed page from translation

Show changes

Majestix: 1 revision imported: Initial Setup

2026-04-06T09:48:55Z

1 revision imported: Initial Setup

← Older revision	Revision as of 11:48, 6 April 2026
(No difference)

en>Tactica: rm {{Shared Template Warning}}.

2025-10-13T18:22:35Z

rm {{Shared Template Warning}}.

New page

<noinclude>{{#ifeq:{{SUBPAGENAME}}|doc||{{Documentation subpage}}}}<languages /></noinclude>{{#switch:<translate></translate>
| =
<includeonly>{{Languages|Module:Yesno/doc}}</includeonly>

{{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>
<translate>
== Module Quality == 
</translate>
{{ModuleQuality}}
<translate>
== Syntax == 
</translate>
<syntaxhighlight lang="lua">
yesno(value, default)
</syntaxhighlight>

<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 == 
</translate>
<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">
local yesno = require('Module:Yesno')
</syntaxhighlight>

<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">
-- <translate nowrap> These always return <tvar name=1>true</tvar>:</translate>
yesno('yes')
yesno('y')
yesno('true')
yesno('t')
yesno('1')
yesno(1)
yesno(true)

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

-- <translate nowrap> A <tvar name=1>nil</tvar> value always returns <tvar name=1>nil</tvar>:</translate>
yesno(nil)
</syntaxhighlight>
<translate>

String values are converted to lower case before they are matched:
</translate>
<syntaxhighlight lang="lua">
-- <translate nowrap> These always return <tvar name=1>true</tvar>:</translate>
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')

-- <translate nowrap> These always return <tvar name=1>false</tvar>:</translate>
yesno('No')
yesno('NO')
yesno('nO')
yesno('N')
yesno('fALsE')
</syntaxhighlight>

<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">
-- <translate nowrap> These return <tvar name=1>nil</tvar>:</translate>
yesno('foo')
yesno({})
yesno(5)
yesno(function() return 'This is a function.' end)

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

-- <translate nowrap> These return <tvar name=1>"bar"</tvar>:</translate>
yesno('foo', 'bar')
yesno({}, 'bar')
yesno(5, 'bar')
yesno(function() return 'This is a function.' end, 'bar')
</syntaxhighlight>
<translate>

Note that the blank string also functions this way:
</translate>
<syntaxhighlight lang="lua">
yesno('') -- <translate nowrap> Returns <tvar name=1>nil</tvar>.</translate>
yesno('', true) -- <translate nowrap> Returns <tvar name=1>true</tvar>.</translate>
yesno('', 'bar') -- <translate nowrap> Returns <tvar name=1>"bar"</tvar>.</translate>
</syntaxhighlight>

<translate> Although the blank string usually evaluates to <tvar name=1><code>false</code></tvar> in wikitext, it evaluates to <tvar name=2><code>true</code></tvar> in Lua.</translate>
<translate> This module prefers the Lua behaviour over the wikitext behaviour.</translate>
<translate> If treating the blank string as <tvar name=1><code>false</code></tvar> is important for your module, you will need to remove blank arguments at an earlier stage of processing.</translate>
<includeonly>{{Sandbox other||

[[Category:Modules]]
}}</includeonly><noinclude>
[[Category:Module documentation pages{{#translation:}}]]
</noinclude>
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Module:Yesno/doc|noshift=1|uselang={{int:lang}}}}
}}