Template:Para/doc: Difference between revisions
m 1 revision imported |
mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | <noinclude>{{Documentation subpage}}</noinclude> | ||
< | |||
__TOC__ | __TOC__ | ||
== Usage == | == Usage == | ||
This template is for giving examples of [[w:Wikipedia:Template messages|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 {{tlx|para}} parameter is empty) an unnamed example parameter. | This template is for giving examples of [[w:Wikipedia:Template messages|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 {{tlx|para}} parameter is empty) an unnamed example parameter. | ||
| Line 26: | Line 23: | ||
== TemplateData == | == TemplateData == | ||
{{#invoke:TNT|doc|para}} | {{#invoke:TNT|doc|para}} | ||
Latest revision as of 04:01, 15 February 2022
 | This is a documentation subpage for Template:Para. It contains usage information, categories and other content that is not part of the original Template page. |
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 parameter is empty) an unnamed example parameter.
Examples
-
- renders as
|name=
-
- renders as
|title=book title
-
- renders as
|section- (for unnamed parameters in the example code; note the empty first parameter in the template)
-
- 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
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 |
Edit parameter translations
See also
- {{ApiParam}} – for documenting API parameters
| Text style ↓ | options[note 1] to achieve text style |
Link style | ||
|---|---|---|---|---|
| Linked | Unlinked | Linked with subst | ||
| 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>. - ↑
{{tlg|plaincode=1}}uses<code style="background:transparent;border:none">...</code>. - ↑
{{tlg|kbd=1}}uses<kbd>tags.