Template:Para/doc: Difference between revisions
Jump to navigation
Jump to search
m (→Usage: dox clarification) |
m (twiddle) |
||
| Line 15: | Line 15: | ||
#:renders as | #:renders as | ||
#:{{para||section}} | #:{{para||section}} | ||
#:(for unnamed parameters) | #:(for unnamed parameters in the example code; note the empty first parameter in the {{tlx|para}} template) | ||
# {{tlx|para|<var>parameter</var>|<var>value</var>}} | # {{tlx|para|<var>parameter</var>|<var>value</var>}} | ||
#:renders as | #:renders as | ||
Revision as of 22:19, 1 September 2008
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 parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first parameter, or (if the first parameter is empty) an unnamed 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).
See also
- Template:Tlx – for providing examples of entire-template code with included parameters