Template:Tlx/doc

From TF Library

Template:Documentation subpageTemplate:Clear {{#ifeq:Tlx/doc|Tlx |Template:High-risk }} This template is used to show example template usage without expanding the template itself.

Contents 1 Basic use 2 Purpose and naming 2.1 Parameters 3 Usage 3.1 Examples 4 Usage 4.1 Examples 4.2 Examples 4.3 Examples 4.4 Examples 5 Usage 5.1 Examples 5.2 Examples 5.3 Examples 6 Documentation 6.1 Usage 6.2 Examples 7 See also 7.1 Examples 7.2 Examples 8 Template-linking templates

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|…|tenth}} produces: {{tlxTemplate:\sandbox|Template|first parameter|second parameter|third|…|tenth}}

Where parameters might contain one or more equals-signs ("="), replace each equals-sign with Template:Tlf:

{{tlxTemplate:\sandbox|tlx|Template|first{{=}}something|second|third{{=}}something|...|tenth}} produces: {{tlxTemplate:\sandbox|Template|firstTemplate:=something|second|thirdTemplate:=something|...|tenth}}

For more than ten parameters, possibly also containing equals-signs, use Template:Tag thus:

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

Purpose and naming

Mnemonically, "[t]emplate [l]ink e[x]panded" (after Template:Tl, "[t]emplate [l]ink").

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 ten of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 10 parameters can be displayed using a coded vertical-bar (as in "Template:Small…"). A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: "Template:Tag" or all parameters as a string in "Template:Tag" tags; see Examples at bottom. For more details, see this talk page.

Exceptions

If the intended template lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with Template:TagTemplate:Tag. For example:

Template:Tag.

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 Template:Tag.

Parameters

• If the only parameter supplied is Template:Param, i.e. a template's name, Template:Tlf's output is the same as Template:Tl – i.e. a link within braces – but in a monospaced font:
  • Template:Tc produces: Template:Tl
  • Template:Tc produces: {{tlxTemplate:\sandbox|tl}}

Template:Tlf will also not take nor display additional parameters.

Named parameters

Usage

This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first

1. REDIRECT Delete 24 parameter is empty) an unnamed example parameter.

Examples

1.   
2. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

3.   
4. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

5.   
6. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

   (for unnamed parameters in the example code; note the empty first parameter in the

7. REDIRECT Delete 24 template)
8.   
9. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4).

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.

Usage

This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first

1. REDIRECT Delete 24 parameter is empty) an unnamed example parameter.

Examples

1.   
2. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

3.   
4. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

5.   
6. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

   (for unnamed parameters in the example code; note the empty first parameter in the

7. REDIRECT Delete 24 template)
8.   
9. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4).

For an interwiki link to other sister projects, such as: == Usage ==

This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first

1. REDIRECT Delete 24 parameter is empty) an unnamed example parameter.

Examples

1.   
2. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

3.   
4. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

5.   
6. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

   (for unnamed parameters in the example code; note the empty first parameter in the

7. REDIRECT Delete 24 template)
8.   
9. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4). (Meta), == Usage == This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first

1. REDIRECT Delete 24 parameter is empty) an unnamed example parameter.

Examples

1.   
2. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

3.   
4. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

5.   
6. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

   (for unnamed parameters in the example code; note the empty first parameter in the

7. REDIRECT Delete 24 template)
8.   
9. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4). (WikiQuote), == Usage == This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first

1. REDIRECT Delete 24 parameter is empty) an unnamed example parameter.

Examples

1.   
2. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

3.   
4. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

5.   
6. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

   (for unnamed parameters in the example code; note the empty first parameter in the

7. REDIRECT Delete 24 template)
8.   
9. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4). (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

Usage

This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first

1. REDIRECT Delete 24 parameter is empty) an unnamed example parameter.

Examples

1.   
2. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

3.   
4. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

5.   
6. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

   (for unnamed parameters in the example code; note the empty first parameter in the

7. REDIRECT Delete 24 template)
8.   
9. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4).

For a link to Wikipedias in other languages, such as: == Usage ==

This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first

1. REDIRECT Delete 24 parameter is empty) an unnamed example parameter.

Examples

1.   
2. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

3.   
4. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

5.   
6. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

   (for unnamed parameters in the example code; note the empty first parameter in the

7. REDIRECT Delete 24 template)
8.   
9. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4). (German), == Usage == This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first

1. REDIRECT Delete 24 parameter is empty) an unnamed example parameter.

Examples

1.   
2. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

3.   
4. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

5.   
6. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

   (for unnamed parameters in the example code; note the empty first parameter in the

7. REDIRECT Delete 24 template)
8.   
9. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4). (Swedish), etc, facilitating cross-language template documentation and/or discussion.

Documentation

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

Usage

{{tlxTemplate:!Templatename}}

{{tlxTemplate:!TemplatenameTemplate:!param}}

{{tlxTemplate:!TemplatenameTemplate:!1Template:!2Template:!3Template:!4Template:!5Template:!6Template:!7Template:!8Template:!9Template:!10}}

{{tlxTemplate:!TemplatenameTemplate:!1Template:!2Template:!3Template:!4Template:!5Template:!6Template:!7Template:!8Template:!9Template:!10|more}}

{{tlxTemplate:!TemplatenameTemplate:!param=value}}

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

Examples

{{#switch:TF Library |Wikipedia|Meta= |

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.

}}

Template:Aligned table

Unlimited parameters as one Template:Tag string

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

See also

• Template:Tl, a version of Template:Tlf where the template name is shown in bold.

  Template:Tl, a version of Template:Tlf where the template name is shown in bold.

• Template:Tl, a version of Template:Tlf that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
• Template:Tl, for the presentation of template parameters and values (e.g. == Usage ==

This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first

1. REDIRECT Delete 24 parameter is empty) an unnamed example parameter.

Examples

1.   
2. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

3.   
4. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

5.   
6. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

   (for unnamed parameters in the example code; note the empty first parameter in the

7. REDIRECT Delete 24 template)
8.   
9. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4)., == Usage == This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first

1. REDIRECT Delete 24 parameter is empty) an unnamed example parameter.

Examples

1.   
2. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

3.   
4. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

5.   
6. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

   (for unnamed parameters in the example code; note the empty first parameter in the

7. REDIRECT Delete 24 template)
8.   
9. REDIRECT Delete 24

   renders as

   Template loop detected: Template:Para

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4).).

Template-linking templates

Template:Template-linking templates