Template:Para/doc

Usage

This template simply displays a parameter name between a vertical line and an equal sign, as is seen in template calls. (This is useful in template documentation and in talk page discussions of templates.)

Parameters

This template takes the following parameters:

• |1= (may be empty if second parameter is present): the name of the parameter
• |2= (optional if first parameter is present): a corresponding value for the parameter
• |3= (optional): additional usage text
• |req=1: indicate that the parameter is required
• |opt=1: indicate that the parameter is optional

Examples

1. Result: |name=

2. Result: |name= (required)

3. Result: |name= (optional)

4. Result: |opt=1

5. Result: |title=book title

6. Result: |section. This is useful for referring to values of unnamed parameters; note the empty first parameter in the template call.

7. Result: |parameter=value

8. {{para|=|foo}}

   Result: |=foo

9. Result: |2= (optional if first parameter is present)

When using literal, pre-specified values, simply provide the value (appearance as in example 6). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 5), and the same should be done for non-literal, example parameters (as in example 7).

See also

• Template:tlx – for providing examples of entire-template code with included parameters