Template:Para/doc
| File:Farm-Fresh css add.svg | 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/doc
<templatedata>{"paramOrder":["1","2","plain","nowrap"],"params":{"nowrap":{"suggested":false,"type":"boolean","default":"1","label":"Nowrap?","description":"Whether to add `style=\"white-space:nowrap\"`.","autovalue":"0","required":false},"plain":{"suggested":false,"type":"boolean","default":"0","label":"Plain?","description":"Whether to use plain text instead of .","autovalue":"1","required":false},"1":{"suggested":false,"type":"string","required":true,"label":"Name","description":"The parameter name."},"2":{"suggested":true,"type":"string","required":false,"label":"Value","description":"The parameter value."}}}</templatedata>Edit parameter translations
See also
- {{ApiParam}} – for documenting API parameters
Comparison of template-linking templates according to the styles of generated text and link produced
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
- {{tlf}}
[note 2]
<template link>
- {{subst:tls}}
- {{subst:Template:tlsu}}
[note 3]
code
code=1
{{tl2}}
{{tlc}}[note 2]
<template link> {{tnull}}
<template link>
monospace
mono=1[note 4]
N/A
plaincode
plaincode=1[note 5]
kbd
kbd=1[note 6]
- ↑ Jump up to: 1.0 1.1 1.2
{{tlg}} is the most general template, allowing any combination of text style and/or link style options.
- ↑ Jump up to: 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.
- ↑ Jump up to: 4.0 4.1 4.2 Displays monospaced font using
<span style="font-family:monospace">...</span>.
- ↑
{{Template:Para/doc}}<code style="background:transparent;border:none">...</code>.
- ↑
{{Template:Para/doc}} uses <kbd> tags.
