Template:Para

From Bonkipedia
Revision as of 23:17, 7 July 2021 by [[mw:]]>ExE Boss (Use TemplateStyles (Template:Mono/styles.css and Template:Nowrap/styles.css))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

|{{{1}}}=

Template documentation
<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

ParameterDescriptionTypeStatus
Name1

The parameter name.

Stringrequired
Value2

The parameter value.

Stringsuggested
Plain?plain

Whether to use plain text instead of <code>.

Default
0
Auto value
1
Booleanoptional
Nowrap?nowrap

Whether to add `style="white-space:nowrap"`.

Default
1
Auto value
0
Booleanoptional
Edit parameter translations

See also

  • {{ApiParam}} – for documenting API parameters

These tables: <span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <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[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[note 4] N/A
plaincode plaincode=1[note 5]
kbd kbd=1[note 6]
  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. 2.0 2.1 2.2 Prevents wrapping of text by placing it inside <span style="white-space:nowrap">...</span> tags.
  3. Allows links to templates in any namespace.
  4. 4.0 4.1 4.2 Displays monospaced font using <span style="font-family:monospace">...</span>.
  5. {{Template:Para}} uses <code style="background:transparent;border:none">...</code> .
  6. {{Template:Para}} uses ‎<kbd> tags.