Template:Para/doc

Revision as of 14:49, 24 June 2022 by BruceBeachWikiSysop (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

[[Category:Template documentation pages{{#translation:}}]] <templatestyles src="Hatnote/styles.css"/>

<translate> Not to be confused with</translate> Template:Param<translate>  or</translate>Script error: No such module "Int".Template:Parameter.

Lua error: Module:TNT:158: '''Missing JsonConfig extension, or not properly configured; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab. See https://www.mediawiki.org/wiki/Extension:JsonConfig#Supporting_Wikimedia_templates'''.

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 <templatestyles src="Template:Mono/styles.css"/>{{para}} parameter is empty) an unnamed example parameter.

Examples

  1.   <templatestyles src="Template:Mono/styles.css"/>{{para|name}}
    renders as
    <templatestyles src="Template:Nowrap/styles.css"/>|name=
  2.   <templatestyles src="Template:Mono/styles.css"/>{{para|title|<var>book title</var>}}
    renders as
    <templatestyles src="Template:Nowrap/styles.css"/>|title=book title
  3.   <templatestyles src="Template:Mono/styles.css"/>{{para| |section}}
    renders as
    <templatestyles src="Template:Nowrap/styles.css"/>|section
    (for unnamed parameters in the example code; note the empty first parameter in the <templatestyles src="Template:Mono/styles.css"/>{{para}} template)
  4.   <templatestyles src="Template:Mono/styles.css"/>{{para|<var>parameter</var>|<var>value</var>}}
    renders as
    <templatestyles src="Template:Nowrap/styles.css"/>|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

[[Category:TemplateData documentation{{#translation:}}]]

Lua error: Module:TNT:158: '''Missing JsonConfig extension, or not properly configured; Cannot load https://commons.wikimedia.org/wiki/Data:Templatedata/para.tab. See https://www.mediawiki.org/wiki/Extension:JsonConfig#Supporting_Wikimedia_templates'''.

See also

  • {{ApiParam}} – for documenting API parameters

<templatestyles src="Module:Navbar/styles.css"/>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 ↓ <templatestyles src="Template:Mono/styles.css"/>{{tlg}} options[note 1]
to achieve text style
Link style
Linked Unlinked Linked with subst
<templatestyles src="Template:Mono/styles.css"/>{{tlg}} options[note 1]
to achieve link style
N/A DEFAULT nolink=1 subst=1
normal DEFAULT
code code=1
<templatestyles src="Template:Mono/styles.css"/>monospace mono=1[note 4]
  • <templatestyles src="Template:Mono/styles.css"/>{{tlx}}[note 4]
  • <templatestyles src="Template:Mono/styles.css"/>{{tll}}[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. <templatestyles src="Template:Nowrap/styles.css"/>{{Template:Para/doc}} uses <code style="background:transparent;border:none">...</code> .
  6. <templatestyles src="Template:Nowrap/styles.css"/>{{Template:Para/doc}} uses ‎<kbd> tags.