Template:Docparam/documentation

Usage

{{docparam|parameter_name}}

{{docparam|parameter_name|additional_info}}

This template is intended to simplify and standardize the documentation of parameters on template documentation subpages. It may also be used on talk pages, user pages, etc., but should not be used in the main (dictionary) namespace.

Parameters

Two positional (unnamed) parameters are supported:

• |1= the name of the parameter being documented; if none is provided, the name defaults to "1"
• |2= (optional) additional information, such as "optional", "required", "if not English", etc.

Example

The list in the previous section was generated by the following code:

* {{docparam|1}} the name of the parameter being documented; if none is provided, the name defaults to "1"
* {{docparam|2|''optional''}} additional information, such as "optional", "required", "if not English", etc.

Notes

1. Since the template provides an equal sign (=), a call to this template should probably not be followed immediately by punctuation such as a colon (:), hyphen (-) or dash (—).
2. The "additional info" specified in the second parameter is rendered in parentheses but not in bold or italics; if you want one of these renderings, you must provide it in the template call.