Template:Tc-var/doc

From Angelina Jordan Wiki
Revision as of 14:19, 22 June 2024 by Dcljr (talk | contribs) (high usage template; don't need {sp} here)
This is a subpage documenting Template:Tc-var. To change the template, edit that page; to change the template's documentation (seen below), edit this one.

Documentation

The name of this template is based on the phrase "template call with variable parameter values".

This template is used on a great many pages. Making any changes to it will cause lots of jobs to be added to the processing queue.

Usage

  • {{tc-var|template name|description of parameter 1|description of parameter 2||add=}}

Up to 19 positional parameters can be described using this template. If you need more, or if you want to tack on additional parameters of a different type, you can use the add parameter (see below).

Examples

  • {{tc-var}}{{}}
  • {{tc-var|}}{{}}
  • {{tc-var|code}}{{code}}
  • {{tc-var|code|content to be rendered as code}}{{code|content to be rendered as code}}
  • {{tc-var|wl|target|linktext}}{{wl|target|linktext}}
  • {{tc-var|ytv|ID|linktext|add={{pn|t|accessed}}}}{{ytv|ID|linktext|t=|accessed=}}

Obviously, the first three examples are not very useful; they're just here for "completeness".

The last example shows how to use add along with {{pn}} (Template:Param-names) to include additional named parameters. Alternatively, {{pnv}}, {{pnvv}}, or {{pv}} could be used in place of {{pn}}, depending on what kind of formatting is desired.

Alias

See also

Full list of similar templates:    [edit this list]

  • {{tc}} – no particular formatting of parameters, to render concrete examples like {{ytv|-wKoZlapqgg|Love Don't Let Me Go}}
  • {{tc-names}} – shows only parameter names with no values, like {{ytv|v=|t=|linktext=}}
  • {{tc-nameval}} – shows a concrete example with name-value pairs, like {{ytv|v=-wKoZlapqgg|linktext=Love Don't Let Me Go}}
  • {{tc-namevar}} – shows name-value pairs with generic (variable) values, like {{ytv|v=video ID|linktext=text to be linked}}
  • {{tc-numvar}} – shows numerical parameters with generic (variable) values, like {{ytv|1=video ID|2=text to be linked}}
  • {{tc-var}} – shows only variable values to explain positional parameters, like {{ytv|video ID|text to be linked}}