Template:Para

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

|{{{1}}}=

Documentationview · edit · history · purge ]
This documentation is transcluded from Template:Para/doc.

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.

Usage

{{para |1= |2= }}

Template parameters

<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

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

Additional information

The template is intended to be used in the following namespaces: no namespace specified

The template is intended to be used by the following user groups: no user group specified

Localization

This template is not intended to be localized.

Examples[edit]

  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).

See also[edit]

  • {{Tle}} – Meta template to decribe template parameters by names/positions and values
  • {{Tlx}} – for providing examples of entire-template code with included parameters