Template:Template link/doc

From Church of God Knowledge Encyclopedia
Jump to navigation Jump to search


This template is used to show example template usage without expanding the template itself.

Basic use

(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)

{{tlxTemplate:\sandbox|tlx|Template|first parameter|second parameter|third parameter|...|tenth parameter}} produces: {{tlxTemplate:\sandbox|Template|first parameter|second parameter|third parameter|...|tenth parameter}}

When you want to indicate setting a value to one or more parameters, you would normally use the equals-sign ("="). This doesn't work here; instead use {{Error: The retired template Template:Tn has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code Template:Magic word to generate the = character.}}, like so:

{{tlxTemplate:\sandbox|tlx|Template|first{{=}}first value|second|third{{=}}third value}} produces: {{tlxTemplate:\sandbox|Template|firstError: The retired template Template:Tn has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code Template:Magic word to generate the = character.first value|second|thirdError: The retired template Template:Tn has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code Template:Magic word to generate the = character.third value}}

For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in <nowiki>...</nowiki> tags. When you do, you don't need to replace equals-signs. For instance:

{{tlxTemplate:\sandbox|tlx|Template|<nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>}} produces: {{tlxTemplate:\sandbox|Template|first|second|third=value|...|999th}}

Purpose and naming

Mnemonically, template link expanded (after template link).

This template allows an example of calling a template, accompanied by one or more parameters, to be displayed without also causing the template to be called.

Up to 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, as in &#124;. A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: " <nowiki>size=10</nowiki>" or all parameters as a string in " <nowiki>" tags; see Examples at bottom. For more details, see this talk page. If you use 21 or more parameters, all after the 20th will be replaced with a single |... at the end of the parameter list.

Exceptions

If the intended template lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with <code> <nowiki>. For example:

<code><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code>. If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with <pre>...</pre>.

Parameters

{{tl}} will also not take nor display additional parameters.
Named parameters

|subst=

Setting this parameter to any non-blank value will prefix the string subst: linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example, {{tlxTemplate:\sandbox|tlx|Welcome|3=subst=Y}} produces: {{tlxTemplate:\sandbox|Welcome|subst=Y}}. This is similar to the action of the {{tlxTemplate:\sandbox|tlxs}} template: {{tlxTemplate:\sandbox|tlxs|Welcome}} produces: Template:Tlxs.

|SISTER=

For an interwiki link to other sister projects, such as: |SISTER=M: (Meta), |SISTER=Q: (WikiQuote), |SISTER=S: (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

|LANG=

For a link to Wikipedias in other languages, such as: |LANG=de: (German), |LANG=sv: (Swedish), etc, facilitating cross-language template documentation and/or discussion.

Documentation

{{Tlx}} is a generalization of {{tl}}, {{tlp}} etc., with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "Template:Thin space{Template:Thin space", "Template:Thin space|Template:Thin space", "Template:Thin space}Template:Thin space" and links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}, see {{tlw}}, which makes the click target bigger).

Usage

{{tlx|Templatename}}
{{tlx|Templatename|param}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10&#124;more}}
{{tlx|Templatename|param&#61;value}}

There are up to 10 placeholders for parameters of the specified template.

Examples

Note
At the en.wikipedia and Meta sites, X0, X1, X2, ... X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other sister projects.
Code Result Remarks
{{tlx|x0}} {{tlxTemplate:\sandbox|x0}}  
{{tlx|Abc}} {{tlxTemplate:\sandbox|Abc}}  
{{tlx|ABC}} {{tlxTemplate:\sandbox|ABC}}  
{{tlx|AbC}} {{tlxTemplate:\sandbox|AbC}}  
{{tlx|x1|one}} {{tlxTemplate:\sandbox|x1|one}}  
{{tlx|x2|one|two}} {{tlxTemplate:\sandbox|x2|one|two}}  
{{tlx|x3|1|2|3|4|5|6|7|8|9|10}} {{tlxTemplate:\sandbox|x3|1|2|3|4|5|6|7|8|9|10}}  
{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} {{tlxTemplate:\sandbox|x4|1|2|3|4|5|6|7|8|9|10|11}} up to 10 parameters...
{{tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} {{tlxTemplate:\sandbox|x5|1|2|3|4|5|6|7|8|9|10|11}}
...&#124; for more
{{tlx|x1|x=u}} {{tlxTemplate:\sandbox|x1|x=u}} the straightforward equals-sign won't work...
{{tlx|x1|x&#61;u}} {{tlxTemplate:\sandbox|x1|x=u}}
...but &#61; is okay
{{tlx|x1|x{{=}}u}} {{tlxTemplate:\sandbox|x1|xError: The retired template Template:Tn has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code Template:Magic word to generate the = character.u}}
...and {{=}} is okay
{{tlx|x1|<nowiki>x=u</nowiki>}} {{tlxTemplate:\sandbox|x1|x=u}}
sticky nowiki also okay
{{tlx|x2| |two}} {{tlxTemplate:\sandbox|x2| |two}} empty won't work...
{{tlx|x2|&#32;|two}} {{tlxTemplate:\sandbox|x2| |two}}
...but &#32; is okay
{{tlx|x2|&nbsp;|two}} {{tlxTemplate:\sandbox|x2| |two}}
...&nbsp; is also okay
{{tlx|x2| <nowiki />|two}} {{tlxTemplate:\sandbox|x2||two}}
<nowiki /> handles the space
{{tlx|x2| &#124; two}} {{tlxTemplate:\sandbox|x2| | two}}
&#124; is okay
{{tlx|x2| {{!}} two}} {{tlxTemplate:\sandbox|x2 | | two}}
{{!}} is dubious
{{tlx|x2|2=|3=two}} {{tlxTemplate:\sandbox|x2|2=|3=two}} empty really doesn't work
{{tlx|x2|2=one|two}} {{tlxTemplate:\sandbox|x2|two}} "two" overrides "2Error: The retired template Template:Tn has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code Template:Magic word to generate the = character.one"
{{tlx|x2|3=two|2=one}} {{tlxTemplate:\sandbox|x2|3=two|2=one}}
irregular parameter order is okay
Unlimited parameters as one

<nowiki>...</nowiki> string

{{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

TemplateData

TemplateData documentation used by VisualEditor and other tools
Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Template link

Show example template usage without expanding the template itself. {{tnull}} is similar without linking the template.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Template name1

Name of the template to link.

Example
Tlx
Templaterequired
1st parameter2

no description

Stringoptional
2nd parameter3

no description

Stringoptional
3rd parameter4

no description

Stringoptional
4th parameter5

no description

Stringoptional
5th parameter6

no description

Stringoptional
6th parameter7

no description

Stringoptional
7th parameter8

no description

Stringoptional
8th parameter9

no description

Stringoptional
9th parameter10

no description

Stringoptional
10th parameter11

no description

Stringoptional
11th parameter12

no description

Stringoptional
12th parameter13

no description

Stringoptional
13th parameter14

no description

Stringoptional
14th parameter15

no description

Stringoptional
15th parameter16

no description

Stringoptional
16th parameter17

no description

Stringoptional
17th parameter18

no description

Stringoptional
18th parameter19

no description

Stringoptional
19th parameter20

no description

Stringoptional
20th parameter21

no description

Stringoptional
Show subst:subst

Set to any value to show "subst:" before the template name

Example
true
Booleanoptional
LanguageLANG

The prefix for a link to Wikipedias in other languages.

Example
de:
Lineoptional
Sister projectSISTER

The prefix for an interwiki link to other sister projects

Example
M:
Lineoptional

See also

  • {{tlxb}}, a version of {{tlx}} where the template name is shown in bold.
  • {{tlb}}, a version of {{tl}} where the template name is shown in bold.
  • {{temt}}, a version of {{tlx}} that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
  • {{para}}, for the presentation of template parameters and values (e.g. |paraname=val, |another=).
  • {{tnull}}, like Template:Tnull without linking the template.

Template:Template-linking templates