Template:Para/doc

Not to be confused with Template:Param or 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 for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Para in articles based on its TemplateData.

TemplateData for Para

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<ref group="note" name="TlTfn1"></ref> to achieve text style	Link style
		Linked	Unlinked	Linked with subst
{{tlg}} options<ref group="note" name="TlTfn1"></ref> to achieve link style	N/A	DEFAULT	nolink=1	subst=1
normal	DEFAULT	{{tlg}}<ref group="note" name="TlTfn1"></ref> {{tl}} {{tlp|1|2|...}}<ref group="note" name="TlTfn2"></ref>	{{tlf}}<ref group="note" name="TlTfn2"></ref> <template link>	{{subst :tls}} {{subst :Template:tlsu}}<ref group="note" name="TlTfn3"></ref>
code	code=1	{{tl2}}	{{tlc}}<ref group="note" name="TlTfn2"></ref> <template link> {{tnull}} <template link>	{{subst :tlxs}}
monospace	mono=1<ref group="note" name="TlTfn4"></ref>	{{tlx}}<ref group="note" name="TlTfn4"></ref> {{tll}}<ref group="note" name="TlTfn4"></ref>	N/A
plaincode	plaincode=1<ref group="note" name="TlTfn5"></ref>
kbd	kbd=1<ref group="note" name="TlTfn6"></ref>