Template:paramref/documentation

From Wiktionary, the free dictionary
Jump to navigation Jump to search
Documentation for Template:paramref. [edit]
This page contains usage information, categories, interwiki links and other content describing the template.

This template displays a parameter name surrounded by {{{triple braces}}}, as one would see in MediaWiki template code. Note that this is useful when discussing the coding of templates (e.g., on template talk pages), but not so much when discussing how to use templates (e.g., in template documentation or on entry talk pages). For the latter usage, please see {{para}}.

Usage

[edit]

This template may be added anywhere outside of the main (dictionary) namespace to display a parameter as it would appear inside template code.

Parameters

[edit]

This template uses one or two unnamed (positional) parameters:

  • |1= (required) The parameter name to be shown. This can be empty, but must be given.
  • |2= (optional) The text that appears after the parameter name and a pipe. This can be empty.

Examples

[edit]
  • {{paramref|1}} returns:
    {{{1}}}
  • {{paramref|foo}} returns:
    {{{foo}}}
  • {{paramref|bar|}} returns:
    {{{bar|}}}
  • {{paramref|salt|pepper}} returns:
    {{{salt|pepper}}}
  • {{paramref||Tweedle-dee}} returns:
    {{{|Tweedle-dee}}}

See also

[edit]