Template:Para/doc: Difference between revisions
From BoyWiki
New page: <noinclude> {{documentation subpage}}</noinclude> <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> == Usage == This template is for giving examples of [[BoyWiki:T... |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 4: | Line 4: | ||
== Usage == | == Usage == | ||
This template is for giving examples of | This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be ''empty'', but it '''must''' be ''present''), and the second (optional) one is a value for the first example parameter, or (if the first {{tlx|para}} parameter is empty) an unnamed example parameter. | ||
===Examples=== | ===Examples=== | ||
| Line 23: | Line 23: | ||
When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <tt><nowiki><var>value</var></nowiki></tt> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4). | When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <tt><nowiki><var>value</var></nowiki></tt> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4). | ||
<noinclude> | <noinclude> | ||
[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | [[Category:Template documentation|{{PAGENAME}}]]</noinclude> | ||
Latest revision as of 16:08, 3 February 2014
 |
Usage
This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first {{para}} parameter is empty) an unnamed example parameter.
Examples
- {{para|name}}
- renders as
|name=
- {{para|title|<var>book title</var>}}
- renders as
|title=book title
- {{para| |section}}
- renders as
|section- (for unnamed parameters in the example code; note the empty first parameter in the {{para}} template)
- {{para|<var>parameter</var>|<var>value</var>}}
- renders as
|parameter=value
When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4).
