Template:Parameter names example

Template documentation

This documentation is transcluded from Template:Parameter names example/doc. (Edit | history)
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.

{{Parameter names example}} is intended to assist template documentation by producing a generic instance of the template that uses parameters' names as those parameters' values.

Example

The example opposite for {{Infobox}}, for instance, was produced by:

{{{title}}}

{{{above}}}
{{{subheader}}}
{{{subheader2}}}
{{{image}}} {{{caption}}}
{{{header1}}}
{{{label2}}}	{{{data2}}}
{{{label3}}}	{{{data3}}}
{{{header4}}}
{{{data5}}}
{{{data6}}}
{{{below}}}

{{Parameter names example
|_template=Infobox
|title |above |subheader |subheader2 |image |caption 
|header1 |label2 |data2 |label3 |data3 |header4 
|data5 |data6 |below
}}

Usage notes

When {{Parameter names example}} is used on an immediate subpage of its target template – e.g. on the target template's /doc page – its own |_template = parameter identifying the target template may be omitted. In other words, the code above, if used on Template:Infobox/page (where page could be "doc", "testcases", etc.), would become:

{{Parameter names example
|title |above |subheader |subheader2 |image |caption 
|header1 |label2 |data2 |label3 |data3 |header4 
|data5 |data6 |below
}}

One exception to this is the "sandbox" subpage. If the module is called from a page ending in "/sandbox", it uses that page to generate the template output, not the base page. To override this behaviour you can specify the |_template = parameter explicitly.

The formatting of the parameter names can be changed with the |_display = parameter. By default, the parameter names are shown in triple braces, e.g. {{{name}}}, but if |_display = italics or |_display = italic is set, they are shown in italics.

A custom value for a parameter may be supplied by using |[parameter name] = [value] in place of |[parameter name]. Any formatting for such a value – including, for instance, italics – must be supplied as part of the value (e.g. |parameter = ''value''<br/>). Custom values cannot be used for parameters whose names begin with an underscore ("_").