Template:Nowiki template demo

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

This template shows a template invocation together with a demonstration of that template's output. The template arguments are passed in once, inside <nowiki>...</nowiki> tags, and are used to generate both the template invocation and the template output. The demonstration can be displayed in various different formats.

This template is identical to {{test case nowiki}} with the |showtemplate2= and |showheader= parameters both set to "no". To see the full range of options available, please see the test case nowiki documentation.

Usage

Basic syntax

{{nowiki template demo|<nowiki>{{[template name]
| [param1] = [value1]
| [param2] = [value2]
| [param3] = [value3]
...
}}</nowiki>}}

<!-- Or -->

{{nowiki template demo|<nowiki>{{<!-- template name with parameters -->}}</nowiki>}}

Common syntax

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

{{nowiki template demo
| format      = 
| collapsible = 
| resetRefs   = 
| showcode    = 
| showheader  = 
| code        = <nowiki>{{[template name]
| [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 &lt;, &gt; and &quot; 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 "default", "inline", "columns" or "rows". The inline format is for templates that can be displayed entirely on one line. If used with templates that display on multiple lines it may produce unexpected results. The "columns" and "rows" formats are intended for displaying multiple templates in a table, so they are not of much use here. See the test case nowiki documentation for more information about them.
heading1	A custom heading for the template.
showheader	If this is set to "no", then no headers are shown.
collapsible	If set to "yes", the demonstration is made collapsible. It is collapsed by default.
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 display of the template invocation.

You can use |collapsible=yes with any format to collapse it. You can set a custom title for collapsible test cases with the |title= parameter.

Examples

Default

Usage

{{nowiki template demo|code=<nowiki>{{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.}}</nowiki>}}

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.}}

Default, collapsible

Usage

{{nowiki template demo|collapsible=yes|<nowiki>{{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.}}</nowiki>}}

Output

{{Nowiki template demo}}

{{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.}}

Inline

using Template:3x

Usage

{{nowiki template demo|format=inline|code=<nowiki>{{3x|Lorem ipsum}}</nowiki>}}

Output

• {{3x|Lorem ipsum}} → Lorem ipsumLorem ipsumLorem ipsum

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

Inline with nowiki output

using Template:URL

Usage

{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{URL | 1= http://www.example.com/path?section=17 }}</nowiki>}}

Output

• {{URL | 1= http://www.example.com/path?section=17 }} → www.example.com/path?section=17

  <span class="url">[http://www.example.com/path?section=17 www<wbr/>.example<wbr/>.com<wbr/>/path?section=17]</span>

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.
• The template converts the HTML entities &lt;, &gt; and &quot; inside template invocations to the literal characters <, > and ". This is due to the way nowiki tags work.

See also

Similar templates:

• Template:Demo and Template:Demo-inline which use Module:Demo
• Template:Automarkup which uses Module:Automarkup

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

The above documentation is transcluded from Template:Nowiki template demo/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.