Ta‌̱mpi‌̱let:Test case nowiki

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.

The template output and the template invocations are generated from template code passed inside <nowiki>...</nowiki> tags passed to the |code= or |1= parameters. In this template code, you must use the magic word __TEMPLATENAME__ instead of the normal template name.

Template names are specified parameters like |template1= and |template2=, etc. 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 nowiki|<nowiki>{{__TEMPLATENAME__
| [param1] = [value1]
| [param2] = [value2]
| [param3] = [value3]
...
}}</nowiki>}}

Common syntax

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

{{test case nowiki
| format      = 
| collapsible = 
| resetRefs   = 
| showcode    = 
| showheader  = 

| template      = 
| template1     = 
| showtemplate1 = 
| heading1      = 
| template2     = 
| showtemplate2 = 
| heading2      = 
| template3     = 
| showtemplate3 = 
| heading3      = 
...

| code = <nowiki>{{__TEMPLATENAME__
| [param1] = [value1]
| [param2] = [value2]
| [param3] = [value3]
...
}}</nowiki>
}}

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

Parameters

Common parameters
Parameter	Description
`code` or `1`	The template code, inside `<nowiki>...</nowiki>` tags. You must use the magic word "__TEMPLATENAME__" instead of the template name. For example: `\| code = <nowiki>{{__TEMPLATENAME__\|first\|second\|foo=bar}}</nowiki>`. 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.
`format`	The format to display the test cases in. This can be "columns", "rows", "inline" or "default".
`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 "no", then no headers are shown.
`collapsible`	If set to "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.
`resetRefs`	If set to "yes", any references generated by the templates tested are reset after each template is expanded.
`showcode`	Set this to "no" to disable showing the template code used to make the test case.

The default test case format doesn't have any extra parameters.

The inline format is 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. It doesn't have any extra parameters.

The columns format arranges 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.
`after`	This text is displayed after the output of each template.

The rows format arranges the test cases in rows in a table. 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.

You can use |collapsible=yes with any format to turn it into a collapsible test case. If all the template outputs are the same the test case is collapsed and given a green heading. If any of the template outputs differ, the test case is expanded and given a yellow heading. You can set a custom title for collapsible test cases with the |title= parameter.

Examples