Difference between revisions of "Template:Para"

[view] [edit] [history] [purge] Template documentation

Template:TOCright

Description

Template:Para 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) is a value for the first example parameter, or (if the first {{para}} parameter is empty) an unnamed example parameter.

Examples

1.   {{para|name}}

   renders as

   |name=

2.   {{para|title|<var>book title</var>}}

   renders as

   |title=book title

3.   {{para| |section}}

   renders as

   |section

   (for unnamed parameters in the example code; note the empty first parameter in the {{para}} template)

4.   {{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

• {{Tlx}} — for providing examples of entire-template code with included parameters

Template:Tl-nav