Template:Test case/doc

For the legacy syntax version of this template, see Template:Testcase.

This template generates a test case for two or more templates. Each template is called with the same parameters, and the test case can be displayed in various different formats.

All parameters passed to this template are passed through to the test-case templates, with the exception of parameters starting with an underscore character ("_"), which are reserved for internal use.

If no templates are specified explicitly, the module uses the base page of the current page as the first template, and its /sandbox subpage as the second template. If only one template is specified explicitly, its /sandbox subpage is used as the second template.

Usage

Basic syntax

{{test case
| [param1] = [value1]
| [param2] = [value2]
| [param3] = [value3]
...
}}

Common syntax

The following options will work with all different test case formats.

{{test case
| _format      = 
| _output      = 
| _collapsible = 
| _resetRefs   = 
| _code        = 
| _showcode    = 

| _template  = 
| _template1 = 
| _heading1  = 
| _template2 = 
| _heading2  = 
| _template3 = 
| _heading3  = 
...

| [param1] = [value1]
| [param2] = [value2]
| [param3] = [value3]
...
}}

Some test case formats accept additional parameters as well. See their sections for documentation.

Common parameters

Parameter	Description
_format	The format used to display the test cases. This can be "columns", "rows", "tablerows", "inline" or "default".
_output	Allows changes in how the template's output is displayed. The default output is displayed when the _output parameter is not specified or when it is set to any unsupported value. A <nowiki>...</nowiki> version of the template's output is displayed when |_output=nowiki; this is helpful when there are differences in the underlying wikitext which are not visible in the default output. Both the default output and nowiki version are displayed when |_output=nowiki+.
_collapsible	If set to "y" or "yes", the test case is made collapsible. The test case is collapsed and given a green heading if all the template outputs are the same. If any of the template outputs differ, the test case is expanded and given a yellow heading. See #Collapsible test cases for other parameters which only work when _collapsible is enabled.
_template1, _template2, _template3...	The names of the templates to be processed. The default of _template1 is the base page of the current page. If _template1 is specified, the default for _template2 is its /sandbox subpage; if not, the default for _template2 is the /sandbox subpage of the base page of the current page. Template names should be entered as you would use them in a normal template invocation, i.e. "3x", not "Template:3x". If you need to test a page in the main namespace you can use a colon prefix, i.e. ":article name".
_template	An alias for _template1. If both _template and _template1 are specified, _template will take precedence.
_showtemplate1, _showtemplate2, _showtemplate3...	If this is set to "no", then no output is shown for that template. This is useful if you only want to show the main template, or if you only want to show the sandbox template.
_heading1, _heading2, _heading3...	Custom headings for each of the templates.
_showheader	If this is set to "n" or "no", then no headers are shown.
_before, _after	Optional text to display before and after the output of each template.
_resetRefs	If set to "y" or "yes", any references generated by the templates tested are reset after each template is expanded.
_showcode	Show the template code used to make the test case. If an invocation is specified with the _code parameter, then that is used. Otherwise, an approximation is generated from the arguments. This approximation is not perfect - white space in named arguments is lost, and duplicate arguments are ignored - but it should be fine for template code that is input all on one line without spaces between parameters.
_code	Used to specify template code inside <nowiki>...</nowiki> tags. This is used with the _showcode option to display the template invocation while preserving white space. You must use the magic word "__TEMPLATENAME__" instead of the template name. For example: | _code = <nowiki>{{__TEMPLATENAME__|first|second|foo=bar}}</nowiki>. If you find yourself using this option a lot, you may want to consider using {{test case nowiki}}, which allows you to generate the entire test case from template code in nowiki tags, saving you from typing in all the arguments twice. Note: due to the way nowiki tags work, the template treats the HTML entities &lt;, &gt; and &quot; as if they were the literal characters <, > and " when used with this parameter.

Test case formats

Default format

This format is used when _format is not specified or when |_format=default. It does not have any extra parameters.

Example

{{ombox}}

{{ombox/sandbox}}

Columns format

Use |_format=columns to arrange the test cases side by side in a table. This is useful for comparing long and thin templates such as infoboxes. It has the following extra parameters:

Parameter	Description
_class	HTML classes for the table. Use |_class=wikitable to format the table as a wikitable.
_style	Custom inline CSS for the table.
_caption	Custom caption for the table. The default is "Side by side comparison".
_rowheader	An extra heading for the row containing the templates.
_heading0	If _rowheader is supplied, this is an optional heading above it in the template row.

Example

Side by side comparison

{{ombox}}	{{ombox/sandbox}}

Rows and tablerows formats

Use |_format=rows or |_format=tablerows to arrange the test cases one above another in a table. These two formats differ in the placement of the headings: rows puts them above, whereas tablerows to the left of the template outputs. It has the following extra parameters:

Parameter	Description
_class	HTML classes for the table. Use |_class=wikitable to format the table as a wikitable.
_style	Custom inline CSS for the table.
_caption	Custom caption for the table.

Example – rows

{{ombox}}

{{ombox/sandbox}}

Example – tablerows

{{ombox}}	→
{{ombox/sandbox}}	→

Inline format

Use |_format=inline for test cases that can be displayed entirely on one line. If used with templates that display on multiple lines it may produce unexpected results. This format creates a bulleted list by placing * before each line of output. It has the following extra parameters:

Parameter	Description
_addline	Text to be added as last line in list, after the template output.
_prefix	Character to replace * before each line of output. Using |_prefix=# would display a numbered list.

Note: As this format starts with a bullet, a newline will always be inserted at the start of the template output.

Examples (using Template:Lorem ipsum)

Default:

• Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

• Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

With |_showcode=yes:

• {{Lorem ipsum|1 }} →
  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

• {{Lorem ipsum/sandbox|1 }} →
  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Example (using Template:Height)

With |_prefix=# and |_addline=:

1. {{Height|m=1.51}} → 1.51 m (4 ft 11+1⁄2 in)
2. {{Height/sandbox|m=1.51}} → 1.51 m (4 ft 11+1⁄2 in)
3. {{Cvt|1.51|m|frac=2}} → 1.51 m (4 ft 11+1⁄2 in)

Output

The _output parameter allows changes in how the template's output is displayed. It should work with any of the test case formats; the following examples use |format=tablerows.

Default output

The default output is displayed when the _output parameter is not specified or when it is set to any unsupported value; this example uses |_output=default.

{{URL}}	→	example.com
{{Official website}}	→	example.com

Nowiki output

A <nowiki>...</nowiki> version of the template's output is displayed when |_output=nowiki. This is helpful if there are differences in the underlying wikitext which are not visible in the default output.

{{URL}}	→	<span class="url">[https://www.example.com example.com]</span>
{{Official website}}	→	<span class="official-website"><span class="url">[https://www.example.com example.com]</span></span>

Nowiki+ output

Both the default output and nowiki version are displayed when |_output=nowiki+.

{{URL}}	→	example.com <span class="url">[https://www.example.com example.com]</span>
{{Official website}}	→	example.com <span class="official-website"><span class="url">[https://www.example.com example.com]</span></span>

Collapsible test cases

If _collapsible is set to "y" or "yes", the test case is made collapsible. The test case is collapsed and given a green heading if all the template outputs are the same. If any of the template outputs differ, the test case is expanded and given a yellow heading. It has the following extra parameters:

Parameter	Description
_title	Use |_title= to display a custom title for collapsible test cases.
_titlecode	Use |_titlecode=yes to display the template's code as the title of a collapsible test case.
_notcollapsed	If set to y or yes, the test case will always be expanded upon loading the page. If set to n or no, it will always be collapsed upon loading the page. This setting overrides the default functionality in which the test case is collapsed unless two or more outputs do not match.

Examples

Default title

{{ombox}}

{{ombox}}

{{ombox/sandbox}}

With _title

Using the columns format

Side by side comparison

{{ombox}}	{{ombox/sandbox}}

Using the rows format

{{ombox}}

{{ombox/sandbox}}

Example of differing output

{{ombox}}

{{tmbox}}

With _titlecode=yes

This is useful for templates with a small number of parameters. It displays the template code in the title, eliminating the need for both |_title= and |_showcode=yes. For actual tests implemented with |_titlecode=yes, see Template:URL/testcases.

{{URL|www.example.com}}

{{URL}}	→	www.example.com <span class="url">[http://www.example.com www<wbr/>.example<wbr/>.com]</span>
{{URL/sandbox}}	→	www.example.com <span class="url">[http://www.example.com www<wbr/>.example<wbr/>.com]</span>

With _notcollapsed=yes

If |_notcollapsed=yes, the test case will always be expanded upon loading the page. This setting overrides the default functionality in which the test case is collapsed unless two or more outputs do not match. The following example would normally be collapsed, as indicated by green background of title:

Example of same output

{{ombox}}

{{ombox}}

With _notcollapsed=no

If |_notcollapsed=no, the test case will always be collapsed upon loading the page. This setting overrides the default functionality in which the test case is collapsed unless two or more outputs do not match. The following would normally be expanded, as indicated by yellow background of title:

Example of differing output

{{ombox}}

{{tmbox}}

Additional examples

With _showcode

Usage

{{test case|_template1=ombox|_showcode=yes|text=Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.}}

Output

{{ombox|text=Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.}}

{{ombox}}

{{ombox/sandbox}}

With _showcode, using a nowiki invocation via _code

Usage

{{test case|_template1=ombox|_showcode=yes
|_code = 
<nowiki>{{__TEMPLATENAME__
| text = Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
}}</nowiki>
|text=Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
}}

Output

{{ombox
| text = Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
}}

{{ombox}}

{{ombox/sandbox}}

With _showcode and _collapsible

Usage

{{test case|_template1=ombox|_showcode=yes|_collapsible=yes|text=Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.}}

Output

{{ombox}}

{{ombox|text=Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.}}

{{ombox}}

{{ombox/sandbox}}

Technical limitations

The template has the following known technical limitations:

• An error will be generated if processing the entire page takes more than 10 seconds. This is an intentional limit in the Scribunto extension that runs Module:Template test case, on which this template is based. If a test cases page takes more than 10 seconds to load, you may need to split it up into different pages.
• When generating the template code used with |_showcode= whitespace in named parameters is ignored, numbered parameters like |1= may be incorrectly displayed as positional parameters, and duplicate parameters are ignored. This is due to how template parameters are processed before they are passed to Module:Template test case.
• When using a template invocation inside nowiki tags with the |_code= parameter, the HTML entities &lt;, &gt; and &quot; are converted to the literal characters <, > and ". This is due to the way nowiki tags work.
• For collapsible test cases, all text inside each extension tag (e.g. <ref>, <references>, <gallery> or <nowiki>) is treated as equal. These tags are converted to strip markers before they are passed to the template, and all strip markers include a unique hexadecimal string. Even if strip markers were unstripped before being compared, the same wikitext would not be guaranteed to result in exactly the same unstripped code. So this module ignores the content of strip markers for the purposes of testing equality. This has the unwanted side effect that e.g. all <ref>...</ref> tags are treated as though they are equal, but should be adequate for most uses.

See also

Templates invoking Module:Template test case:

• Template:Testcase rows – for a table of test cases arranged in rows
• Template:Testcase table – for a table of test cases arranged in columns
• Template:Inline test case – for test cases with small invocations and small output
• Template:Collapsible test case – for test cases collapsed by default if the results are the same
• Template:Test case nowiki – for test cases from template invocations enclosed in <nowiki>...</nowiki> tags
• Template:Nowiki template demo – for use in template documentation