FANDOM


Usage

{{documentation subpage}}

OR

Note: This documentation for Template loop detected: Template:Tlx is also transcluded by its derivatives Template loop detected: Template:Tlx, Template loop detected: Template:Tlx, Template loop detected: Template:Tlx, Template loop detected: Template:Tlx (editTemplate:Dotmaster page).


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:Tcpl:

{{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 <nowiki>...</nowiki> 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, "[[[:Template:Padlr]]]emplate [[[:Template:Padlr]]]ink e[x]panded" (after Template:Tlpad, "[[[:Template:Padlr]]]emplate [[[:Template:Padlr]]]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 "&#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.

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><code class="nowrap"><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code></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

Template:Tpad will also not take nor display additional parameters.
Named parameters

Template:Para

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.

Template:Para

For an interwiki link to other sister projects, such as: Template:Para (Meta), Template:Para (WikiQuote), Template:Para (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

Template:Para

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

Documentation

Template:Tlpad 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: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:Tlpad, 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.

Template:Aligned table

Unlimited parameters as one <nowiki>...</nowiki> string
{{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

See also

Template-linking templates

Template:Template-linking templates


Userboxes

When used to document usage of a userbox, it may be preferred to have this template state "userbox"/"userbox page" instead of "template"/"template page" or "user template"/"user template page". If this is preferred, use:

{{userbox documentation subpage}}

OR

Note: This documentation for Template loop detected: Template:Tlx is also transcluded by its derivatives Template loop detected: Template:Tlx, Template loop detected: Template:Tlx, Template loop detected: Template:Tlx, Template loop detected: Template:Tlx (editTemplate:Dotmaster page).


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:Tcpl:

{{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 <nowiki>...</nowiki> 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, "[[[:Template:Padlr]]]emplate [[[:Template:Padlr]]]ink e[x]panded" (after Template:Tlpad, "[[[:Template:Padlr]]]emplate [[[:Template:Padlr]]]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 "&#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.

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><code class="nowrap"><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code></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

Template:Tpad will also not take nor display additional parameters.
Named parameters

Template:Para

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.

Template:Para

For an interwiki link to other sister projects, such as: Template:Para (Meta), Template:Para (WikiQuote), Template:Para (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

Template:Para

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

Documentation

Template:Tlpad 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: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:Tlpad, 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.

Template:Aligned table

Unlimited parameters as one <nowiki>...</nowiki> string
{{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

See also

Template-linking templates

Template:Template-linking templates


Customization of text

To manually change the text of the template, the "text1=your text here" and/or "text2=your other text here" parameters can be specified. "text1=" changes the automatic text on the first line to your own word(s). "text2=" changes the automatic text on the second line to your own word(s). If "text1=" parameter is specified without the "text2=" parameter, both the first and second line of text will be custom based on the text given in the "text1=" parameter.

Example usage:

Note: This documentation for Template loop detected: Template:Tlx is also transcluded by its derivatives Template loop detected: Template:Tlx, Template loop detected: Template:Tlx, Template loop detected: Template:Tlx, Template loop detected: Template:Tlx (editTemplate:Dotmaster page).


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:Tcpl:

{{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 <nowiki>...</nowiki> 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, "[[[:Template:Padlr]]]emplate [[[:Template:Padlr]]]ink e[x]panded" (after Template:Tlpad, "[[[:Template:Padlr]]]emplate [[[:Template:Padlr]]]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 "&#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.

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><code class="nowrap"><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code></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

Template:Tpad will also not take nor display additional parameters.
Named parameters

Template:Para

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.

Template:Para

For an interwiki link to other sister projects, such as: Template:Para (Meta), Template:Para (WikiQuote), Template:Para (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

Template:Para

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

Documentation

Template:Tlpad 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: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:Tlpad, 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.

Template:Aligned table

Unlimited parameters as one <nowiki>...</nowiki> string
{{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

See also

Template-linking templates

Template:Template-linking templates


Note: This documentation for Template loop detected: Template:Tlx is also transcluded by its derivatives Template loop detected: Template:Tlx, Template loop detected: Template:Tlx, Template loop detected: Template:Tlx, Template loop detected: Template:Tlx (editTemplate:Dotmaster page).


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:Tcpl:

{{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 <nowiki>...</nowiki> 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, "[[[:Template:Padlr]]]emplate [[[:Template:Padlr]]]ink e[x]panded" (after Template:Tlpad, "[[[:Template:Padlr]]]emplate [[[:Template:Padlr]]]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 "&#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.

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><code class="nowrap"><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code></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

Template:Tpad will also not take nor display additional parameters.
Named parameters

Template:Para

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.

Template:Para

For an interwiki link to other sister projects, such as: Template:Para (Meta), Template:Para (WikiQuote), Template:Para (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

Template:Para

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

Documentation

Template:Tlpad 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: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:Tlpad, 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.

Template:Aligned table

Unlimited parameters as one <nowiki>...</nowiki> string
{{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

See also

Template-linking templates

Template:Template-linking templates


Note: This documentation for Template loop detected: Template:Tlx is also transcluded by its derivatives Template loop detected: Template:Tlx, Template loop detected: Template:Tlx, Template loop detected: Template:Tlx, Template loop detected: Template:Tlx (editTemplate:Dotmaster page).


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:Tcpl:

{{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 <nowiki>...</nowiki> 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, "[[[:Template:Padlr]]]emplate [[[:Template:Padlr]]]ink e[x]panded" (after Template:Tlpad, "[[[:Template:Padlr]]]emplate [[[:Template:Padlr]]]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 "&#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.

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><code class="nowrap"><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code></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

Template:Tpad will also not take nor display additional parameters.
Named parameters

Template:Para

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.

Template:Para

For an interwiki link to other sister projects, such as: Template:Para (Meta), Template:Para (WikiQuote), Template:Para (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

Template:Para

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

Documentation

Template:Tlpad 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: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:Tlpad, 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.

Template:Aligned table

Unlimited parameters as one <nowiki>...</nowiki> string
{{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

See also

Template-linking templates

Template:Template-linking templates


How it is displayed

This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed:

  • On a "/doc" page, it displays a box explaining template documentation and links to the template page.
  • On other pages (ie, pages transcluding the "/doc" page), the template will not show. The template page itself (which contains {{Documentation}}) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to the output message, the template categorizes pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').

See also

Template:Documentation/see also


Community content is available under CC-BY-SA unless otherwise noted.