imported>Im Wired In at 23:16, 23 April 2025

2025-04-23T23:16:04Z

New page

{{Documentation}}

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, except for 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'''

<pre>
{{test case
| [param1] = [value1]
| [param2] = [value2]
| [param3] = [value3]
...
}}
</pre>

'''Common syntax'''

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

<pre>
{{test case
| _format =
| _output =
| _collapsible =
| _resetRefs =
| _code =
| _showcode =

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

| [param1] = [value1]
| [param2] = [value2]
| [param3] = [value3]
...
}}
</pre>

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

== Common parameters ==

{| class="wikitable"
|-
! Parameter !! Description
|-
| <code>_format</code> || The format used to display the test cases. This can be "[[#Columns|columns]]", "[[#Rows and tablerows|rows]]", "[[#Rows and tablerows|tablerows]]", "[[#Inline|inline]]" or "[[#Default|default]]".
|-
| <code>_output</code> || Allows changes in how the template's output is displayed. The default output is displayed when the <code>_output</code> parameter is not specified or when it is set to any unsupported value. A [[Special:MyLanguage/Help:Formatting#Text formatting markup|nowiki]] version of the template's output is displayed when {{para|_output|nowiki}}; this is helpful when there are differences in the underlying [[Help:Wikitext|wikitext]] which are not visible in the default output. Both the default output and nowiki version are displayed when {{para|_output|nowiki+}}.
|-
| <code>_collapsible</code> || 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.
|-
| <code>_template1</code>, <code>_template2</code>, <code>_template3</code>... || 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. "2x", not "Template:2x". If you need to test a page in the main namespace you can use a colon prefix, i.e. ":''article name''".
|-
| <code>_template</code> || An alias for _template1. If both _template and _template1 are specified, _template will take precedence.
|-
| <code>_showtemplate1</code>, <code>_showtemplate2</code>, <code>_showtemplate3</code>... || 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.
|-
| <code>_heading1</code>, <code>_heading2</code>, <code>_heading3</code>... || Custom headings for each of the templates.
|-
| <code>_showheader</code> || If this is set to "n" or "no", then no headers are shown.
|-
| <code>_resetRefs</code> || If set to "y" or "yes", any references generated by the templates tested are reset after each template is expanded.
|-
| <code>_showcode</code> || 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>_code</code> || Used to specify template code inside {{tag|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>| _code = <nowiki>{{__TEMPLATENAME__|first|second|foo=bar}}</nowiki></nowiki></code>. <p>Note: due to the way nowiki tags work, the template treats the [[w:HTML entities|HTML entities]] &lt;, &gt; and &quot; as if they were the literal characters <, > and " when used with this parameter.</p>
|}

Template:DW/Test case/doc - Revision history

imported>Im Wired In at 23:16, 23 April 2025