Modul:Yesno/doc - Versionsgeschichte

imported>Oetterer am 5. Oktober 2022 um 14:08 Uhr

2022-10-05T14:08:04Z

← Nächstältere Version		Version vom 5. Oktober 2022, 16:08 Uhr
Zeile 5:		Zeile 5:
	== Syntax ==		== Syntax ==

	<~~source~~ lang="lua">yesno(value, default)</~~source~~>		<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>.		<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>.
Zeile 13:		Zeile 13:
	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.		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.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local yesno = require('Module:Yesno')		local yesno = require('Module:Yesno')
	</~~source~~>		</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>.		Some input values always return <code>true</code>, and some always return <code>false</code>. <code>nil</code> values always return <code>nil</code>.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	-- These always return true:		-- These always return true:
	yesno('yes')		yesno('yes')
Zeile 28:		Zeile 28:
	yesno('wahr')		yesno('wahr')
	yesno('w')		yesno('w')
			yesno('t')
			yesno('on')
	yesno('1')		yesno('1')
	yesno(1)		yesno(1)
Zeile 39:		Zeile 41:
	yesno('falsch')		yesno('falsch')
	yesno('f')		yesno('f')
			yesno('off')
	yesno('0')		yesno('0')
	yesno(0)		yesno(0)
Zeile 45:		Zeile 48:
	-- A nil value always returns nil:		-- A nil value always returns nil:
	yesno(nil)		yesno(nil)
	</~~source~~>		</syntaxhighlight>

	String values are converted to lower case before they are matched:		String values are converted to lower case before they are matched:

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	-- These always return true:		-- These always return true:
	yesno('Yes')		yesno('Yes')
Zeile 63:		Zeile 66:
	yesno('N')		yesno('N')
	yesno('fALsE')		yesno('fALsE')
	</~~source~~>		</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.		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.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	-- These return nil:		-- These return nil:
	yesno('foo')		yesno('foo')
Zeile 85:		Zeile 88:
	yesno(5, 'bar')		yesno(5, 'bar')
	yesno(function() return 'This is a function.' end, 'bar')		yesno(function() return 'This is a function.' end, 'bar')
	</~~source~~>		</syntaxhighlight>

	Note that the blank string also functions this way:		Note that the blank string also functions this way:
	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	yesno('') -- Returns nil.		yesno('') -- Returns nil.
	yesno('', true) -- Returns true.		yesno('', true) -- Returns true.
	yesno('', 'bar') -- Returns "bar".		yesno('', 'bar') -- Returns "bar".
	</~~source~~>		</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.		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.

imported>Oetterer am 10. April 2022 um 05:36 Uhr

2022-04-10T05:36:55Z

← Nächstältere Version		Version vom 10. April 2022, 07:36 Uhr
Zeile 100:		Zeile 100:
	<!-- Categories go here if not set by {{module rating}} above (in which case you can use default [[Category:modules]]. -->		<!-- Categories go here if not set by {{module rating}} above (in which case you can use default [[Category:modules]]. -->
	[[Category:Lua metamodules]]		[[Category:Lua metamodules]]
	}}</includeonly>		}}</includeonly><!-- null edit comment; remove -->

mw>Oetterer am 17. Februar 2015 um 20:51 Uhr

2015-02-17T20:51:24Z

Neue Seite

{{documentation subpage}}
{{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.

== Syntax ==

<source lang="lua">yesno(value, default)</source>

<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 ==

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.

<source lang="lua">
local yesno = require('Module:Yesno')
</source>

Some input values always return <code>true</code>, and some always return <code>false</code>. <code>nil</code> values always return <code>nil</code>.

<source lang="lua">
-- These always return true:
yesno('yes')
yesno('y')
yesno('true')
yesno('ja')
yesno('j')
yesno('wahr')
yesno('w')
yesno('1')
yesno(1)
yesno(true)

-- These always return false:
yesno('no')
yesno('n')
yesno('nein')
yesno('false')
yesno('falsch')
yesno('f')
yesno('0')
yesno(0)
yesno(false)

-- A nil value always returns nil:
yesno(nil)
</source>

String values are converted to lower case before they are matched:

<source lang="lua">
-- 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')
</source>

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.

<source lang="lua">
-- 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')
</source>

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

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||

[[Category:Lua metamodules]]
}}</includeonly>