Template:Parmdesc/doc: Difference between revisions From Online Manual

Jump to: navigation, search
(Created page with "This template is used to create a parameter list. <pre><nowiki> {{Parmdesc |name1|d1=description 1 |name2|d2=description 2 |name3|d3=description 3 }} </nowiki></pre> will result...")
 
(documenting sep)
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.


<pre><nowiki>
{{code|1=<nowiki>{{Parmdesc
|name1|d1=description 1
|name2|d2=description 2
|name3|d3=description 3
}}</nowiki>}}
 
will result in
{{Parmdesc
{{Parmdesc
|name1|d1=description 1
|name1|d1=description 1
Line 7: Line 14:
|name3|d3=description 3
|name3|d3=description 3
}}
}}
</nowiki></pre>
 
{{code|1=<nowiki>{{Parmdesc
|sep=&amp;#58;
|name1|d1=description 1
|name2|d2=description 2
|name3|d3=description 3
}}</nowiki>}}
 
will result in
will result in
{{Parmdesc
{{Parmdesc
|sep=&#58;
|name1|d1=description 1
|name1|d1=description 1
|name2|d2=description 2
|name2|d2=description 2
|name3|d3=description 3
|name3|d3=description 3
}}
}}
Please note that in order to use the colon as separator its html entity <code>&amp;#58;</code> must be used.

Revision as of 14:27, 1 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.

{{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=&#58;
|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 &#58; must be used.



Advertisement: