Module:Yesno/doc - Revision history

Sanctaria: 88 revisions imported

2021-12-22T20:27:31Z

88 revisions imported

← Older revision		Revision as of 15:27, 22 December 2021
(No difference)

Sanctaria: 1 revision imported

2021-12-22T20:24:00Z

1 revision imported

← Older revision		Revision as of 15:24, 22 December 2021
(No difference)

en>DePiep: +2 new examples

2021-11-09T16:19:05Z

+2 new examples

← Older revision		Revision as of 11:19, 9 November 2021
Line 68:		Line 68:
	yesno(5)		yesno(5)
	yesno(function() return 'This is a function.' end)		yesno(function() return 'This is a function.' end)
			yesno(nil, true)
			yesno(nil, 'bar')

	-- These return true:		-- These return true:

en>Serols: Reverted edits by 188.229.38.139 (talk) (HG) (3.4.10)

2021-05-23T08:14:11Z

Reverted edits by 188.229.38.139 (talk) (HG) (3.4.10)

← Older revision	Revision as of 03:14, 23 May 2021
Line 1:	Line 1:
		{{used in system}}
		{{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 ==

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

		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.

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

		<syntaxhighlight lang="lua">
		-- These always return true:
		yesno('yes')
		yesno('y')
		yesno('true')
		yesno('t')
		yesno('1')
		yesno(1)
		yesno(true)

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

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

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

		<syntaxhighlight 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')
		</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.

		<syntaxhighlight 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')
		</syntaxhighlight>

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

		Although the empty 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 empty string as false is important for your module, you will need to convert empty strings to a value that evaluates to false before passing them to this module. In the case of arguments received from wikitext, this can be done by using [[Module:Arguments]].<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
		[[Category:Lua metamodules]]
		}}</includeonly>

188.229.38.139: ←Blanked the page

2021-05-23T08:11:42Z

←Blanked the page

← Older revision		Revision as of 03:11, 23 May 2021
Line 1:		Line 1:
	~~{{used in system}}~~
	~~{{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 ==~~

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

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

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

	~~<syntaxhighlight lang="lua">~~
	~~-- These always return true:~~
	~~yesno('yes')~~
	~~yesno('y')~~
	~~yesno('true')~~
	~~yesno('t')~~
	~~yesno('1')~~
	~~yesno(1)~~
	~~yesno(true)~~

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

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

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

	~~<syntaxhighlight 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')~~
	~~</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.~~

	~~<syntaxhighlight 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')~~
	~~</syntaxhighlight>~~

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

	Although the empty 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 empty string as false is important for your module, you will need to convert empty strings to a value that evaluates to false before passing them to this module. In the case of arguments received from wikitext, this can be done by using [[Module:Arguments]].<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
	~~[[Category:Lua metamodules]]~~
	~~}}</includeonly>~~

en>Nehme1499: Reverted edits by Muhammd Fajar (talk) to last version by GKFX

2021-04-22T14:32:15Z

Reverted edits by Muhammd Fajar (talk) to last version by GKFX

← Older revision		Revision as of 09:32, 22 April 2021
Line 1:		Line 1:
	{{used in system\|~~1=Pesantren Kilat\|2=Module talk:Yesno~~}}		{{used in system}}
			{{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.		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.

en>Muhammd Fajar at 09:46, 20 April 2021

2021-04-20T09:46:49Z

← Older revision		Revision as of 04:46, 20 April 2021
Line 1:		Line 1:
	{{used in system}}		{{used in system\|1=Pesantren Kilat\|2=Module talk:Yesno}}
	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.		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.

en>Muhammd Fajar at 09:45, 20 April 2021

2021-04-20T09:45:20Z

← Older revision		Revision as of 04:45, 20 April 2021
Line 1:		Line 1:
	{{used in system}}		{{used in system}}
	~~{{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.		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.

en>GKFX: Remove {{high-use}} as now redundant to {{used in system}}

2021-04-07T17:52:09Z

Remove {{high-use}} as now redundant to {{used in system}}

← Older revision		Revision as of 12:52, 7 April 2021
Line 1:		Line 1:
	~~{{High-use\|all-pages = yes}}~~
	{{used in system}}		{{used in system}}
	{{Module rating\|protected}}		{{Module rating\|protected}}

en>Paper9oll: Reverted edits by 102.176.125.22 (talk) (HG) (3.4.10)

2021-03-19T12:31:53Z

Reverted edits by 102.176.125.22 (talk) (HG) (3.4.10)

← Older revision		Revision as of 07:31, 19 March 2021
Line 31:		Line 31:

	-- These always return false:		-- These always return false:
	yesno('~~yes~~')		yesno('no')
	yesno('n')		yesno('n')
	yesno('false')		yesno('false')
Line 90:		Line 90:
	</syntaxhighlight>		</syntaxhighlight>

	Although the empty 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 empty string as false is important for your module, you will need to convert empty strings to a value that evaluates to false before passing them to this module. In the case of arguments received from wikitext, this can be done by using [[Module:Arguments]].<includeonly>{{#ifeq:{{~~ohio~~}}\|sandbox\|\|		Although the empty 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 empty string as false is important for your module, you will need to convert empty strings to a value that evaluates to false before passing them to this module. In the case of arguments received from wikitext, this can be done by using [[Module:Arguments]].<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
	[[Category:Lua metamodules]]		[[Category:Lua metamodules]]
	}}</includeonly>		}}</includeonly>