Template:Tlc/doc

From MozillaWiki
Jump to: navigation, search
Edit-copy green.svg
This is a documentation subpage for Template:Tlc.
It contains usage information, categories and other content that is not part of the original template page.

{{tlc}} is designed to display examples of how to use templates. It works similar to {{tl}} and {{tlf}} but doesn't link to the template it displays (like {{tl}}), or show it in plain text (like {{tlf}}). It shows the template's name and its parameters as code, i.e. wrapped in <code>-tags.

Its primary use is in instruction and documentation. The template is very good to use when you want to give examples of how to use a template.

Parameters

There are 12 optional parameters, all unnamed. If no parameters are specified, {{tlc}} will become a presentation of itself with the parameters replaced by an ellipsis (see the examples below).

The parameters of {{tlc}} can be formatted using wiki-code.

Synatx

The syntax for {{tlc}} is:

  • {{tlc|template name |param2 |param3 |param4 |…|param11 }}

Optional parameters

1 (unnamed)

Template name

The 1st parameter is the name of the template you want to present.

Usage

{{tlc|template name}}

2–12 (unnamed)

Template parameters

The parameters 2 through 12 are used for the parameters of the displayed template.

Notes
  • The specified parameters cannot include any equals signs (=). That will break the template. If you need to do that, use the template {{=}}.
  • If the maximum of 11 included parameters is exceeded, the template will only show the 11 first parameters, and exclude the surplus ones.
Usage

{{tlc|1|param1|param2|param3|param4|param5|…|param11}}

Examples

Correct use

Case What you type What you see Notes
No parameter {{tlc}} ...}} Presents itself
Only 1st parameter templatename}} {{templatename}}
Template name +
parameters
templatename|par1|par2|par3}} par1|par2|par3}}
Wiki-formatting '''templatename'''|''par1''|'''''par2'''''|[[par3]]}} par1|par2|par3}}
Parameters with {{=}} templatename|par1{{=}}|par2|par3{{=}}}} par1=|par2|par3=}}

Incorrect use

Case What you type What you see Notes
≥ 13 entries {{tlc|templatename|2|3|4|5|6|7|8|9|10|11|12|13|14}} 2|3|4|5|6|7|8|9|10|11|12}} Only the 12 first entries will be displayed (i.e. the template's name and the first 11 parameters)
Parameters with plain = templatename|par1=|par2|par3=}} par2}} Parameters that include equals signs will be excluded from the output

See also

  • {{tl}}: produces a link to a template, within braces.
  • {{tn}}: the same as {{tl}}, but also includes the inner pair of braces in the link, making it easier to click the link when presenting short template names.
  • {{tlf}}: produces a template presentation, with the template's name and it's parameters, and wraps the output in <code>-tags.
  • {{tlp}}: produces a template link, with the template's name and it's parameters, and shows the output in plain text.