Module:Template test case/doc - Revision history

DreamRimmer: Reverted edits by 176.29.121.154 (talk) (HG) (3.4.12)

2023-11-04T13:55:53Z

Reverted edits by 176.29.121.154 (talk) (HG) (3.4.12)

← Previous revision		Revision as of 13:55, 4 November 2023
Line 1:		Line 1:
			{{Lua\|Module:Template test case/data\|Module:Template invocation\|Module:Protect\|Module:Arguments\|Module:Yesno}}
	′♯ƒ₴ℳ₣₠₭
			This module provides a framework for making templates which produce a [[WP:TESTCASES\|template test case]]. While test cases can be made manually, using Lua-based templates such as the ones provided by this module has the advantage that the template arguments only need to be input once, thus reducing the effort involved in making test cases and reducing the possibility of errors in the input.

			== Usage ==

			This module should not usually be called directly. Instead, you should use one of the following templates:

			Parameter-based templates:
			* [[Template:Test case]] – for standard test cases
			* [[Template:Testcase table]] – for test cases arranged side by side in columns
			* [[Template:Testcase rows]] – for test cases arranged as rows in a table
			* [[Template:Collapsible test case]] – for test cases that are collapsed by default if the results are the same
			* [[Template:Inline test case]] – for test cases with small invocations and small output, that do not contain any line breaks
			The only difference between these templates is their default arguments. For example, it is possible to display test cases side by side in [[Template:Testcase rows]] by specifying {{para\|_format\|columns}}

			Nowiki-based templates:
			* [[Template:Test case nowiki]] – for test cases created from template code wrapped in nowiki tags (useful for displaying complex template invocations)
			* [[Template:Nowiki template demo]] – for use in template documentation

			It is also possible to use a format of <code><nowiki>{{#invoke:template test case\|main\|</nowiki>''parameters''<nowiki>}}</nowiki></code>. This uses the same defaults as [[Template:Test case]]; please see that page for documentation of the parameters.

			There is no direct interface to this module for other Lua modules. Lua modules should generally use Lua-based test case modules such as [[Module:UnitTests]] or [[Module:ScribuntoUnit]]. If it is really necessary to use this module, you can use [[mw:Extension:Scribunto/Lua reference manual#frame:expandTemplate\|frame:expandTemplate]] with one of the templates listed above.

			== Configuration ==

			This module has a configuration module at [[Module:Template test case/config]]. You can edit it to add new wrapper templates, or to change the messages that the module outputs.

			== Tracking categories ==
			* {{clc\|Test cases using heading parameters}}
			* {{clc\|Test cases using output parameter}}

			<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
			<!-- Categories go here and interwikis go in Wikidata. -->
			[[Category:Modules that add a tracking category]]
			[[Category:Modules that check for strip markers]]
			}}</includeonly>

176.29.121.154: ←Replaced content with '′♯ƒ₴ℳ₣₠₭'

2023-11-04T13:55:12Z

←Replaced content with '′♯ƒ₴ℳ₣₠₭'

← Previous revision		Revision as of 13:55, 4 November 2023
Line 1:		Line 1:
			′♯ƒ₴ℳ₣₠₭
	{{Lua\|Module:Template test case/data\|Module:Template invocation\|Module:Protect\|Module:Arguments\|Module:Yesno}}
	This module provides a framework for making templates which produce a [[WP:TESTCASES\|template test case]]. While test cases can be made manually, using Lua-based templates such as the ones provided by this module has the advantage that the template arguments only need to be input once, thus reducing the effort involved in making test cases and reducing the possibility of errors in the input.

	== Usage ==

	This module should not usually be called directly. Instead, you should use one of the following templates:

	Parameter-based templates:
	* [[Template:Test case]] – for standard test cases
	* [[Template:Testcase table]] – for test cases arranged side by side in columns
	* [[Template:Testcase rows]] – for test cases arranged as rows in a table
	* [[Template:Collapsible test case]] – for test cases that are collapsed by default if the results are the same
	* [[Template:Inline test case]] – for test cases with small invocations and small output, that do not contain any line breaks
	The only difference between these templates is their default arguments. For example, it is possible to display test cases side by side in [[Template:Testcase rows]] by specifying {{para\|_format\|columns}}

	Nowiki-based templates:
	* [[Template:Test case nowiki]] – for test cases created from template code wrapped in nowiki tags (useful for displaying complex template invocations)
	* [[Template:Nowiki template demo]] – for use in template documentation

	It is also possible to use a format of <code><nowiki>{{#invoke:template test case\|main\|</nowiki>''parameters''<nowiki>}}</nowiki></code>. This uses the same defaults as [[Template:Test case]]; please see that page for documentation of the parameters.

	There is no direct interface to this module for other Lua modules. Lua modules should generally use Lua-based test case modules such as [[Module:UnitTests]] or [[Module:ScribuntoUnit]]. If it is really necessary to use this module, you can use [[mw:Extension:Scribunto/Lua reference manual#frame:expandTemplate\|frame:expandTemplate]] with one of the templates listed above.

	== Configuration ==

	This module has a configuration module at [[Module:Template test case/config]]. You can edit it to add new wrapper templates, or to change the messages that the module outputs.

	== Tracking categories ==
	* {{clc\|Test cases using heading parameters}}
	* {{clc\|Test cases using output parameter}}

	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
	<!-- Categories go here and interwikis go in Wikidata. -->
	[[Category:Modules that add a tracking category]]
	[[Category:Modules that check for strip markers]]
	}}</includeonly>

Izno: add dependencies

2020-12-24T03:41:29Z

add dependencies

← Previous revision		Revision as of 03:41, 24 December 2020
Line 1:		Line 1:
			{{Lua\|Module:Template test case/data\|Module:Template invocation\|Module:Protect\|Module:Arguments\|Module:Yesno}}
	This module provides a framework for making templates which produce a [[WP:TESTCASES\|template test case]]. While test cases can be made manually, using Lua-based templates such as the ones provided by this module has the advantage that the template arguments only need to be input once, thus reducing the effort involved in making test cases and reducing the possibility of errors in the input.		This module provides a framework for making templates which produce a [[WP:TESTCASES\|template test case]]. While test cases can be made manually, using Lua-based templates such as the ones provided by this module has the advantage that the template arguments only need to be input once, thus reducing the effort involved in making test cases and reducing the possibility of errors in the input.

Zyxw: add category

2019-04-10T11:48:42Z

add category

← Previous revision		Revision as of 11:48, 10 April 2019
Line 32:		Line 32:
	<!-- Categories go here and interwikis go in Wikidata. -->		<!-- Categories go here and interwikis go in Wikidata. -->
	[[Category:Modules that add a tracking category]]		[[Category:Modules that add a tracking category]]
			[[Category:Modules that check for strip markers]]

	}}</includeonly>		}}</includeonly>

Zyxw: add links

2018-08-10T20:29:03Z

add links

← Previous revision		Revision as of 20:29, 10 August 2018
Line 9:		Line 9:
	* [[Template:Testcase table]] – for test cases arranged side by side in columns		* [[Template:Testcase table]] – for test cases arranged side by side in columns
	* [[Template:Testcase rows]] – for test cases arranged as rows in a table		* [[Template:Testcase rows]] – for test cases arranged as rows in a table
	* [[Template:Collapsible test case]] – for test cases that are collapsed by default if the results are the same.		* [[Template:Collapsible test case]] – for test cases that are collapsed by default if the results are the same
	* [[Template:Inline test case]] – for test cases with small invocations and small output, that do not contain any line breaks.		* [[Template:Inline test case]] – for test cases with small invocations and small output, that do not contain any line breaks
	The only difference between these templates is their default arguments. For example, it is possible to display test cases side by side in [[Template:Testcase rows]] by specifying {{para\|_format\|columns}}		The only difference between these templates is their default arguments. For example, it is possible to display test cases side by side in [[Template:Testcase rows]] by specifying {{para\|_format\|columns}}

	Nowiki-based templates:		Nowiki-based templates:
	* [[Template:Test case nowiki]] – for test cases created from template code wrapped in nowiki tags (useful for displaying complex template invocations).		* [[Template:Test case nowiki]] – for test cases created from template code wrapped in nowiki tags (useful for displaying complex template invocations)
			* [[Template:Nowiki template demo]] – for use in template documentation

	It is also possible to use a format of <code><nowiki>{{#invoke:template test case\|main\|</nowiki>''parameters''<nowiki>}}</nowiki></code>. This uses the same defaults as [[Template:Test case]]; please see that page for documentation of the parameters.		It is also possible to use a format of <code><nowiki>{{#invoke:template test case\|main\|</nowiki>''parameters''<nowiki>}}</nowiki></code>. This uses the same defaults as [[Template:Test case]]; please see that page for documentation of the parameters.
Line 24:		Line 25:
	This module has a configuration module at [[Module:Template test case/config]]. You can edit it to add new wrapper templates, or to change the messages that the module outputs.		This module has a configuration module at [[Module:Template test case/config]]. You can edit it to add new wrapper templates, or to change the messages that the module outputs.

	== Tracking ~~category~~ ==		== Tracking categories ==
	* {{clc\|Test cases using heading parameters}}		* {{clc\|Test cases using heading parameters}}
			* {{clc\|Test cases using output parameter}}

	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|

Anomalocaris: dashes

2018-08-02T21:17:27Z

dashes

← Previous revision		Revision as of 21:17, 2 August 2018
Line 6:		Line 6:

	Parameter-based templates:		Parameter-based templates:
	* [[Template:Test case]] - for standard test cases		* [[Template:Test case]] – for standard test cases
	* [[Template:Testcase table]] - for test cases arranged side by side in columns		* [[Template:Testcase table]] – for test cases arranged side by side in columns
	* [[Template:Testcase rows]] - for test cases arranged as rows in a table		* [[Template:Testcase rows]] – for test cases arranged as rows in a table
	* [[Template:Collapsible test case]] - for test cases that are collapsed by default if the results are the same.		* [[Template:Collapsible test case]] – for test cases that are collapsed by default if the results are the same.
	* [[Template:Inline test case]] - for test cases with small invocations and small output, that do not contain any line breaks.		* [[Template:Inline test case]] – for test cases with small invocations and small output, that do not contain any line breaks.
	The only difference between these templates is their default arguments. For example, it is possible to display test cases side by side in [[Template:Testcase rows]] by specifying {{para\|_format\|columns}}		The only difference between these templates is their default arguments. For example, it is possible to display test cases side by side in [[Template:Testcase rows]] by specifying {{para\|_format\|columns}}

	Nowiki-based templates:		Nowiki-based templates:
	* [[Template:Test case nowiki]] - for test cases created from template code wrapped in nowiki tags (useful for displaying complex template invocations).		* [[Template:Test case nowiki]] – for test cases created from template code wrapped in nowiki tags (useful for displaying complex template invocations).

	It is also possible to use a format of <code><nowiki>{{#invoke:template test case\|main\|</nowiki>''parameters''<nowiki>}}</nowiki></code>. This uses the same defaults as [[Template:Test case]]; please see that page for documentation of the parameters.		It is also possible to use a format of <code><nowiki>{{#invoke:template test case\|main\|</nowiki>''parameters''<nowiki>}}</nowiki></code>. This uses the same defaults as [[Template:Test case]]; please see that page for documentation of the parameters.

Zyxw: add link to tracking category, add category

2016-12-10T01:55:35Z

add link to tracking category, add category

← Previous revision		Revision as of 01:55, 10 December 2016
Line 23:		Line 23:

	This module has a configuration module at [[Module:Template test case/config]]. You can edit it to add new wrapper templates, or to change the messages that the module outputs.		This module has a configuration module at [[Module:Template test case/config]]. You can edit it to add new wrapper templates, or to change the messages that the module outputs.

			== Tracking category ==
			* {{clc\|Test cases using heading parameters}}

	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
	<!-- Categories go here and interwikis go in Wikidata. -->		<!-- Categories go here and interwikis go in Wikidata. -->
			[[Category:Modules that add a tracking category]]

	}}</includeonly>		}}</includeonly>

Mr. Stradivarius: /* Usage */ ce

2014-12-02T23:30:05Z

Usage: ce

← Previous revision		Revision as of 23:30, 2 December 2014
Line 14:		Line 14:

	Nowiki-based templates:		Nowiki-based templates:
	* [[Template:Test case nowiki]] - for test cases created from template code wrapped in nowiki tags (useful for displaying ~~templates~~ ~~with~~ ~~many parameters~~)		* [[Template:Test case nowiki]] - for test cases created from template code wrapped in nowiki tags (useful for displaying complex template invocations).

	It is also possible to use a format of <code><nowiki>{{#invoke:template test case\|main\|</nowiki>''parameters''<nowiki>}}</nowiki></code>. This uses the same defaults as [[Template:Test case]]; please see that page for documentation of the parameters.		It is also possible to use a format of <code><nowiki>{{#invoke:template test case\|main\|</nowiki>''parameters''<nowiki>}}</nowiki></code>. This uses the same defaults as [[Template:Test case]]; please see that page for documentation of the parameters.

Mr. Stradivarius: /* Usage */ add Template:Inline test case

2014-12-02T06:10:35Z

Usage: add Template:Inline test case

← Previous revision		Revision as of 06:10, 2 December 2014
Line 10:		Line 10:
	* [[Template:Testcase rows]] - for test cases arranged as rows in a table		* [[Template:Testcase rows]] - for test cases arranged as rows in a table
	* [[Template:Collapsible test case]] - for test cases that are collapsed by default if the results are the same.		* [[Template:Collapsible test case]] - for test cases that are collapsed by default if the results are the same.
			* [[Template:Inline test case]] - for test cases with small invocations and small output, that do not contain any line breaks.
	The only difference between these templates is their default arguments. For example, it is possible to display test cases side by side in [[Template:Testcase rows]] by specifying {{para\|_format\|columns}}		The only difference between these templates is their default arguments. For example, it is possible to display test cases side by side in [[Template:Testcase rows]] by specifying {{para\|_format\|columns}}

Mr. Stradivarius: add configuration section

2014-12-02T06:06:53Z

add configuration section

← Previous revision		Revision as of 06:06, 2 December 2014
Line 18:		Line 18:

	There is no direct interface to this module for other Lua modules. Lua modules should generally use Lua-based test case modules such as [[Module:UnitTests]] or [[Module:ScribuntoUnit]]. If it is really necessary to use this module, you can use [[mw:Extension:Scribunto/Lua reference manual#frame:expandTemplate\|frame:expandTemplate]] with one of the templates listed above.		There is no direct interface to this module for other Lua modules. Lua modules should generally use Lua-based test case modules such as [[Module:UnitTests]] or [[Module:ScribuntoUnit]]. If it is really necessary to use this module, you can use [[mw:Extension:Scribunto/Lua reference manual#frame:expandTemplate\|frame:expandTemplate]] with one of the templates listed above.

			== Configuration ==

			This module has a configuration module at [[Module:Template test case/config]]. You can edit it to add new wrapper templates, or to change the messages that the module outputs.

	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|