Template:Parameter names example/doc

This is a documentation subpage for Template:Parameter names example.It contains usage information, categories, and other content that is not part of the original template page.

{{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:

{{Parameter names example 
|_template=Infobox temp |title |image |row 1 title |row 1 info |row 2 title |row 2 info |row 3 title |row 3 info |row 4 title |row 4 info |row 5 title |row 5 info |row 6 title |row 6 info |row 7 title |row 7 info |row 8 title |row 8 info |row 9 title |row 9 info |row 10 title |row 10 info |row 11 title |row 11 info |row 12 title |row 12 info
}}

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 (the parameter standard, 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 ("_").

Example

Usage notes

See also