Template:Parameter names example/doc

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.

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:



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. ), 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. Any formatting for such a value – including, for instance, italics – must be supplied as part of the value (e.g. parameter = value ). Custom values cannot be used for parameters whose names begin with an underscore ("_").