Template:para

Definition from Wiktionary, the free dictionary
Jump to navigation Jump to search

|{{{1}}}={{{2}}}


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.)

To display a parameter name surrounded by {{{triple-braces}}} (as would appear in template code), use {{paramref}}.

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. {{para|name}}
    Result: |name=
  2. {{para|name|req=1}}
    Result: |name= (required)
  3. {{para|name|opt=1}}
    Result: |name= (optional)
  4. {{para|opt|1}}
    Result: |opt=1
  5. {{para|title|<var>book title</var>}}
    Result: |title=book title
  6. {{para||section}}
    Result: |section. This is useful for referring to values of unnamed parameters; note the empty first parameter in the template call.
  7. {{para|<var>parameter</var>|<var>value</var>}}
    Result: |parameter=value
  8. {{para|=|foo}}
    Result: |=foo
  9. {{para|2||''optional'' if first parameter is present}}
    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).