Template:Parmdesc/doc

From Online Manual

Jump to: navigation, search

This template is used to create a parameter list. A separator displayed between the name of the parameter and its description can be optionally defined with the sep parameter. Setting the optional parameter highlight to no it is possible to display the parameter's name not in bold.

{{Parmdesc
|name1|d1=description 1
|name2|d2=description 2
|name3|d3=description 3
}}

will result in

  • name1 description 1
  • name2 description 2
  • name3 description 3


{{Parmdesc
|sep=:
|name1|d1=description 1
|name2|d2=description 2
|name3|d3=description 3
}}

will result in

  • name1: description 1
  • name2: description 2
  • name3: description 3


Please note that in order to use the colon as separator its html entity : must be used.

{{Parmdesc
|sep=:
|highlight=no
|name1|d1=description 1
|name2|d2=description 2
|name3|d3=description 3
}}

will result in

  • name1: description 1
  • name2: description 2
  • name3: description 3