Template:Para/doc

<translate> Not to be confused with</translate> Template:Param<translate>  or</translate> Template:Parameter.

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

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Para

No description.

Template parameters

Parameter		Description	Type	Status
Name	1	The parameter name.	String	required
Value	2	The parameter value.	String	suggested
Plain?	plain	Whether to use plain text instead of <code>. Default 0 Auto value 1	Boolean	optional
Nowrap?	nowrap	Whether to add `style="white-space:nowrap"`. Default 1 Auto value 0	Boolean	optional

Edit parameter translations

See also

• {{ApiParam}} – for documenting API parameters

· <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>

Comparison of template-linking templates according to the styles of generated text and link produced

Text style ↓	{{tlg}} options to achieve text style	Link style
		Linked	Unlinked	Linked with subst
{{tlg}} options to achieve link style	N/A	DEFAULT	nolink=1	subst=1
normal	DEFAULT	{{tlg}} {{tl}} {{tlp|1|2|...}}	{{tlf}} <template link>	{{subst :tls}} {{subst :Template:tlsu}}
code	code=1	{{tl2}}	{{tlc}} <template link> {{tnull}} <template link>	{{subst :tlxs}}
monospace	mono=1	{{tlx}} {{tll}}	N/A
plaincode	plaincode=1
kbd	kbd=1