View source for Module:Template test case/doc

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