(documenting sep) |
No edit summary |
||
| Line 1: | Line 1: | ||
This template is used to create a parameter list. | 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. | 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. | |||
{{code|1=<nowiki>{{Parmdesc | {{code|1=<nowiki>{{Parmdesc | ||
| Line 31: | Line 32: | ||
Please note that in order to use the colon as separator its html entity <code>&#58;</code> must be used. | Please note that in order to use the colon as separator its html entity <code>&#58;</code> must be used. | ||
{{code|1=<nowiki>{{Parmdesc | |||
|sep=&#58; | |||
|highlight=no | |||
|name1|d1=description 1 | |||
|name2|d2=description 2 | |||
|name3|d3=description 3 | |||
}}</nowiki>}} | |||
will result in | |||
{{Parmdesc | |||
|sep=: | |||
|highlight=no | |||
|name1|d1=description 1 | |||
|name2|d2=description 2 | |||
|name3|d3=description 3 | |||
}} | |||
Latest revision as of 11:40, 3 July 2011
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
