Template:Documentation paramlist

Template:documentation paramlist – displays a pretty parameter list.

[edit] [purge]

Function

This template and it's co-working templates produce a formatted template parameter list.

Please note that this method in a makeshift manner and are in need of some inprovements, e.g. using CSS, being closed in a single template, etc. Therefore, your contributions are highly appreciated.

Usage

{{documentation paramlist/begin}}
{{documentation paramlist
|name= parameter_name_1
|desc= parameter_description_1
|opt=  optional / mandatory / blank
|def=  default value_1
}}
{{documentation paramlist
|name= parameter_name_2
|desc= parameter_description_2
|opt=  optional / mandatory / blank
|def=  default value_2
}}
:
{{documentation paramlist/end}}

Parameters

name	–	(Mandatory)  the name of this parameter. Use sequential number for anonymous parameters.
desc	–	(Mandatory)  A description of this parameter.
opt	–	(Optional)  Describs that this parameter is mandatory or optional. Default value: blank
def	–	(Optional)  The default value of this parameter. Default value: blank

Examples

The code of "Parameters" section above is:

{{documentation paramlist/begin}}
{{documentation paramlist
|name= name
|desc= the name of this parameter.  Use sequential number for anonymous parameters.
|opt=  mandatory
|def=
}}
{{documentation paramlist
|name= desc
|desc= A description of this parameter.
|opt=  mandatory
|def=
}}
{{documentation paramlist
|name= opt
|desc= Describs that this parameter is mandatory or optional.
|opt=  optional
|def=  ''blank''
}}
{{documentation paramlist
|name= def
|desc= The default value of this parameter.
|opt=  optional
|def=  ''blank''
}}
{{documentation paramlist/end}}

Related templates

• Template:Documentation paramlist/begin – the opener tag of {{documentation paramlist}}.
• Template:Documentation paramlist/end – the closer tag of {{documentation paramlist}}.
• Template:Documentation – displays a template documentation.