Template:Tc-names/doc

From Angelina Jordan Wiki
This is a subpage documenting Template:Tc-names. To change the template, edit that page; to change the template's documentation (seen below), edit this one.

Documentation

This template is used in template documentation to display wiki markup representing a template call with parameter names only (no corresponding values), as shown in the examples below. It should only be used on talk pages or in template documentation (or help pages, user pages, etc.), not in articles.

Unlike Template:Tl and Template:Tlnc, this template does not provide a link on the name of the template in the displayed markup.

This template styles the template call as code. There is no option to display it as plain text.

The name of the template is based on the phrase "template call with parameter names".

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-names|param 1 name|param 2 name|}}
  • {{tc-names|param 1 name|param 2 name||add=|sp=}}

Up to 19 parameters can be documented using this template. If you need more, or if you want to tack on additional parameters of a different type, you can use add as explained in the documentation of {{tc-var}}.

Setting sp to any true value adds space before each vertical bar (except the first one).

Examples

  • {{tc-names}}{{}}
  • {{tc-names|}}{{}}
  • {{tc-names|xl}}{{xl}}
  • {{tc-names|xl|}}{{xl}}
  • {{tc-names|xl|url|linktext|site|icon|accessed}}{{xl|url=|linktext=|site=|icon=|accessed=}}
  • {{tc-names|xl|url|linktext|site|icon|accessed|sp=y}}{{xl|url= |linktext= |site= |icon= |accessed=}}

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

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}}