View source for Template:Testcase/doc

{{Documentation subpage}}
{{Template sandbox notice}}<!--only displayed when viewed from /sandbox page-->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{for|an easier-to-use version of this template|Template:Test case}}

=== Usage ===
Use to compare a template with its sandbox.  Pass the raw code in nowikis as the first unnamed parameter; the existing template as the second, and the sandbox as the third.  The optional named parameter {{para|id}} is used as a heading (to describe the test being performed); if {{para|id}} is omitted, parameter 1 is used. The optional named parameter {{para|layout}} determines whether the live and sandbox outputs are displayed side by side or on top of each other. The default value is vertical (on top of each other). A value of horizontal will produce side by side output.

If the pair of test codes in parameters 2 and 3 both produce the same output, then the test case is displayed in a collapsed table with a green heading.  If the test codes produce different output ''(this includes white space differences)'', then the test is displayed in an uncollapsed table with a yellow heading.

Note that some more complex templates may cause testcases to be highlighted even when their output is the same. The cause of this is under investigation...

===Example===
<pre>{{testcase
|id=title and url
|layout=horizontal
|&lt;nowiki>{{citation|title=Test|url=http://example.org}}&lt;/nowiki>
|{{citation        |title=Test|url=http://example.org}}
|{{citation/sandbox|title=Test|url=http://example.org}}
}}</pre>

If the sandbox code in parameter 3 gives the same output as the non-sandbox code in parameter 2:
<!--note, the code used in the examples below is simply to ensure that the output is always the same in the first example and different in the second - the output, not the code, is what matters.-->
{{testcase
|id=title and url
|<nowiki>{{citation|title=Test|url=http://example.org}}</nowiki>
|{{citation|title=Test|url=http://example.org}}
|{{citation|title=Test|url=http://example.org}}
}}

If sandbox gives different output:
{{testcase
|id=title and url
|<nowiki>{{citation|title=Test|url=http://example.org}}</nowiki>
|{{citation|title=Test|url=http://example.org}}
|{{citation|title=Test|url=http://example.org}} content of the differing output
}}

== See also ==
Templates invoking [[Module:Template test case]]:
* [[Template:Test case]] – a generalised test case template
* [[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 {{tag|nowiki}} tags
* [[Template:Nowiki template demo]] – for use in template documentation

<includeonly>{{Sandbox other||<!--
++++ PLEASE ADD CATEGORIES BELOW THIS LINE, INSIDE INCLUDEONLY TAGS, THANK YOU. -->
[[Category:Template namespace templates]]
[[Category:Template test cases| ]]
}}</includeonly>