Template:Para
|{{{1}}}=
 | This template uses TemplateStyles: |
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
- {{para|name}}
- renders as
|name=
- {{para|title|<var>book title</var>}}
- renders as
|title=book title
- {{para| |section}}
- renders as
|section- (for unnamed parameters in the example code; note the empty first parameter in the {{para}} template)
- {{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.
| 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>.
| Boolean | optional |
| Nowrap? | nowrap | Whether to add `style="white-space:nowrap"`.
| Boolean | optional |
See also
- {{ApiParam}} – for documenting API parameters
| Text style ↓ | {{tlg}} options[note 1] to achieve text style |
Link style | ||
|---|---|---|---|---|
| Linked | Unlinked | Linked with subst | ||
| {{tlg}} options[note 1] to achieve link style |
N/A | DEFAULT | nolink=1
|
subst=1
|
| normal | DEFAULT |
|
| |
code
|
code=1
|
|
|
|
| monospace | mono=1 |
N/A | ||
plaincode
|
plaincode=1 | |||
| kbd | kbd=1 | |||
- ↑ 1.0 1.1 1.2
{{tlg}}is the most general template, allowing any combination of text style and/or link style options. - ↑ 2.0 2.1 2.2 Prevents wrapping of text by placing it inside
<span style="white-space:nowrap">...</span>tags. - ↑ Allows links to templates in any namespace.
- ↑ 4.0 4.1 4.2 Displays monospaced font using
<span style="font-family:monospace">...</span>. - ↑
{{Template:Para}}<code style="background:transparent;border:none">...</code>. - ↑
{{Template:Para}}uses<kbd>tags.
