Template documentation[view] [edit] [history] [purge]

This template uses Lua:

Module:Template test case (sandbox)

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 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 <, > and " 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

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.

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.

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

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

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.

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

Usage

Common parameters

Test case formats

Default format

Columns format

Rows and tablerows formats

Inline format

Output

Default output

Nowiki output

Nowiki+ output

Collapsible test cases

Default title

With _title

With _titlecode=yes

With _notcollapsed=yes

With _notcollapsed=no

Additional examples

With _showcode

With _showcode, using a nowiki invocation via _code

With _showcode and _collapsible

Technical limitations

See also