Template:Para

From CasperTech Wiki
Jump to: navigation, search

|

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

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

  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

  • Template:Tlx – for providing examples of entire-template code with included parameters
Template linking templatesview · talk · edit
Link style ? Linked Unlinked Linked with subst Linked including braces Linked with alternative text
Text style ? {{tlg}} option1 nolink=yes subst=yes braceinside=yes alttext=FOO
Normal {{tl}} · {{tlp}}2 · {{tlg}}1, 2 {{tlf}}2 {{tls}} · {{tlsp}} {{tn}} {{tla}}
Code code=yes or
tt=yes
{{tlx}} {{tlc}}2 · {{tld}} · {{tnull}} {{tlxs}}  
Bold bold=yes {{tlb}}  
Bold code bold=yes|code=yes {{tlxb}}
Italic code italic=yes|code=yes {{tlxi}}
NOTES:  1 = {{tlg}} is the most general, allowing any combination of text style and/or link style options.
2 = Prevents wrapping of text by placing it inside of <span class="nowrap">...</span> tags.

Style comparison
  • {{tlf|Milford Haven Line|??????}} …renders… {{Milford Haven Line|??????}}
  • {{tld|Milford Haven Line|??????}} …renders… {{Milford Haven Line|??????}}
  • {{tlc|Milford Haven Line|??????}} …renders… {{Milford Haven Line|??????}}


For parameter description
  • {{para|name|{{var|value}}}} …renders… |name=value
  • {{para|name|{{varserif|value}}}} …renders… |name=value
  • {{tlx|Milford Haven Line|first parameter{{=}}first value}} …renders… {{Milford Haven Line|first parameter=first value}}