Template:Txl/doc - Revision history

Caleb Cooper: /* Purpose and naming */

2020-10-24T21:09:27Z

Purpose and naming

← Older revision		Revision as of 21:09, 24 October 2020
Line 28:		Line 28:

	===Parameters===		===Parameters===
	*If the only parameter supplied is {{param\|1}}, i.e. a template's name, {{tlx\|tlx}}'s output is the same as {{tlx\|tl}} – i.e. a link within [[Braces (punctuation)\|braces]] – but in a [[Wikipedia:monospaced font\|monospaced font]]:		*If the only parameter supplied is {{param\|1}}, i.e. a template's name, {{tlx\|tlx}}'s output is the same as {{tlx\|tl}} – i.e. a link within [[Wikipedia:Braces (punctuation)\|braces]] – but in a [[Wikipedia:monospaced font\|monospaced font]]:
	**{{tc\|tl\|tl}} produces: {{tl\|tl}}		**{{tc\|tl\|tl}} produces: {{tl\|tl}}
	**{{tc\|tlx\|tl}} produces: {{tlx{{\sandbox}}\|tl}}		**{{tc\|tlx\|tl}} produces: {{tlx{{\sandbox}}\|tl}}
	: {{tlx\|tl}} will also not take nor display additional parameters.		: {{tlx\|tl}} will also not take nor display additional parameters.


	==Documentation==		==Documentation==

Caleb Cooper at 21:07, 24 October 2020

2020-10-24T21:07:35Z

← Older revision		Revision as of 21:07, 24 October 2020
Line 1:		Line 1:
	<includeonly>{{small \|1=Note: This documentation for {{tlx\|tlx}} is also [[Wikipedia:Template doc page pattern\|transcluded]] by its derivatives {{tlx\|tlxb}}, {{tlx\|tlxc}} (<span class="plainlinks">[{{fullurl:Template:Tlx/doc \|action=edit}} edit]</span>{{#ifeq:{{SITENAME}}\|Meta \|). \|{{dot}}[[M:template:{{PAGENAMEE}}\|master page]]).}}<!--(end small:)-->}}</includeonly><noinclude>{{Documentation subpage}}{{clear}}</noinclude>		<includeonly>{{small \|1=Note: This documentation for {{tlx\|tlx}} is also [[Wikipedia:Template doc page pattern\|transcluded]] by its derivatives {{tlx\|tlxb}}, {{tlx\|tlxc}} (<span class="plainlinks">[{{fullurl:Template:Tlx/doc \|action=edit}} edit]</span>{{#ifeq:{{SITENAME}}\|Meta \|). \|{{dot}}[[Mediawikiwiki:template:{{PAGENAMEE}}\|master page]]).}}<!--(end small:)-->}}</includeonly><noinclude>{{Documentation subpage}}{{clear}}</noinclude>
	{{#ifeq:{{BASEPAGENAME}}\|Tlx \|{{High-risk\|2325910+}} {{Used in system}} }}		{{#ifeq:{{BASEPAGENAME}}\|Tlx \|{{High-risk\|2325910+}} {{Used in system}} }}

Line 5:		Line 5:

	==Basic use==		==Basic use==
	''(Note: In the following examples, [[Ellipsis\|ellipses (groups of three dots)]] indicate where parameters have been omitted.)''		''(Note: In the following examples, [[Wikipedia:Ellipsis\|ellipses (groups of three dots)]] indicate where parameters have been omitted.)''

	: {{tlx{{\sandbox}}\|tlx\|Template\|''first parameter''\|''second parameter''\|''third parameter''\|...\|''tenth parameter''}} produces: {{tlx{{\sandbox}}\|Template\|''first parameter''\|''second parameter''\|''third parameter''\|...\|''tenth parameter''}}		: {{tlx{{\sandbox}}\|tlx\|Template\|''first parameter''\|''second parameter''\|''third parameter''\|...\|''tenth parameter''}} produces: {{tlx{{\sandbox}}\|Template\|''first parameter''\|''second parameter''\|''third parameter''\|...\|''tenth parameter''}}
Line 18:		Line 18:
	Mnemonically, ''template link expanded'' (after ''[[Template:tl\|template link]]'').		Mnemonically, ''template link expanded'' (after ''[[Template:tl\|template link]]'').

	This template allows an example of calling a template, accompanied by one or more parameters<!-- ("pass parameters", i.e. [[Help:Pipe trick\|pipe-tricked]] [[m:Parameter#Parameters\|parameters]])-->, to be displayed without also causing the template to be called.		This template allows an example of calling a template, accompanied by one or more parameters<!-- ("pass parameters", i.e. [[Wikipedia:Help:Pipe trick\|pipe-tricked]] [[mediawikiwiki:Parameter#Parameters\|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 <code>&#124;</code>. A keyword parameter can be used with equals code &#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "{{tag\|nowiki\|content=size=10}}" or all parameters as a string in "{{tag\|nowiki\|o}}" tags; see ''[[#Examples\|Examples]]'' at bottom. For more details, see [[{{TALKPAGENAME}}\|this talk]] page. If you use 21 or more parameters, all after the 20th will be replaced with a single {{para\|\|...}} at the end of the parameter list.		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 <code>&#124;</code>. A keyword parameter can be used with equals code &#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "{{tag\|nowiki\|content=size=10}}" or all parameters as a string in "{{tag\|nowiki\|o}}" tags; see ''[[#Examples\|Examples]]'' at bottom. For more details, see [[{{TALKPAGENAME}}\|this talk]] page. If you use 21 or more parameters, all after the 20th will be replaced with a single {{para\|\|...}} at the end of the parameter list.
Line 28:		Line 28:

	===Parameters===		===Parameters===
	*If the only parameter supplied is {{param\|1}}, i.e. a template's name, {{tlx\|tlx}}'s output is the same as {{tlx\|tl}} – i.e. a link within [[Braces (punctuation)\|braces]] – but in a [[monospaced font]]:		*If the only parameter supplied is {{param\|1}}, i.e. a template's name, {{tlx\|tlx}}'s output is the same as {{tlx\|tl}} – i.e. a link within [[Braces (punctuation)\|braces]] – but in a [[Wikipedia:monospaced font\|monospaced font]]:
	**{{tc\|tl\|tl}} produces: {{tl\|tl}}		**{{tc\|tl\|tl}} produces: {{tl\|tl}}
	**{{tc\|tlx\|tl}} produces: {{tlx{{\sandbox}}\|tl}}		**{{tc\|tlx\|tl}} produces: {{tlx{{\sandbox}}\|tl}}
	: {{tlx\|tl}} will also not take nor display additional parameters.		: {{tlx\|tl}} will also not take nor display additional parameters.

	; Named parameters
	{{para\|subst}}
	: Setting this parameter to any non-blank value will prefix the string <code>subst:</code> linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example, {{tlx{{\sandbox}}\|tlx\|Welcome\|3=subst=Y}} produces: {{tlx{{\sandbox}}\|Welcome\|subst=Y}}. This is similar to the action of the {{tlx{{\sandbox}}\|tlxs}} template: {{tlx{{\sandbox}}\|tlxs\|Welcome}} produces: {{tlxs\|Welcome}}.
	{{para\|SISTER}}
	: For an interwiki link to [[H:IW\|other sister projects]], such as: {{para\|SISTER\|M:}} ([[m:\|Meta]]), {{para\|SISTER\|Q:}} ([[q:\|WikiQuote]]), {{para\|SISTER\|S:}} ([[s:\|WikiSource]]), etc, facilitating interwiki template documentation and/or discussion.
	{{para\|LANG}}
	: For a link to [[H:ILL\|Wikipedias in other languages]], such as: {{para\|LANG\|de:}} ([[:de:\|German]]), {{para\|LANG\|sv:}} ([[:sv:\|Swedish]]), etc, facilitating cross-language template documentation and/or discussion.

	==Documentation==		==Documentation==
	{{tl\|Tlx}} is a generalization of {{tl\|tl\|x}}, {{tl\|tlp\|x\|y}} etc., with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "{{thin space}}'''{'''{{thin space}}", "{{thin space}}'''\|'''{{thin space}}", "{{thin space}}'''}'''{{thin space}}" and links can be hard to read when not monospaced (and hard to click on; for uses like <code><nowiki>{{!}}</nowiki></code>, see {{tl\|tlw}}, which makes the click target bigger).		{{tl\|Tlx}} is a generalization of {{tl\|tl\|x}}, {{tl\|tlp\|x\|y}} etc., with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "{{thin space}}'''{'''{{thin space}}", "{{thin space}}'''\|'''{{thin space}}", "{{thin space}}'''}'''{{thin space}}" and links can be hard to read when not monospaced (and hard to click on; for uses like <code><nowiki>{{!}}</nowiki></code>, see {{tl\|tlw}}, which makes the click target bigger).

			For documentation see wikipedia page [[wikipedia:Template:Txl]]


	===Usage===		===Usage===

Caleb Cooper: Created page with "{{small |1=Note: This documentation for {{tlx|tlx}} is also transcluded by its derivatives {{tlx|tlxb}}, {{tlx|tlxc}} (
2020-10-24T21:04:52Z

Created page with "<includeonly>{{small |1=Note: This documentation for {{tlx|tlx}} is also transcluded by its derivatives {{tlx|tlxb}}, {{tlx|tlxc}} (<sp..."

New page
<includeonly>{{small |1=Note: This documentation for {{tlx|tlx}} is also [[Wikipedia:Template doc page pattern|transcluded]] by its derivatives {{tlx|tlxb}}, {{tlx|tlxc}} (<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>{{#ifeq:{{SITENAME}}|Meta |). |{{dot}}[[M:template:{{PAGENAMEE}}|master page]]).}}}}</includeonly><noinclude>{{Documentation subpage}}{{clear}}</noinclude>
{{#ifeq:{{BASEPAGENAME}}|Tlx |{{High-risk|2325910+}} {{Used in system}} }}

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

==Basic use==
''(Note: In the following examples, [[Ellipsis|ellipses (groups of three dots)]] indicate where parameters have been omitted.)''

: {{tlx{{\sandbox}}|tlx|Template|''first parameter''|''second parameter''|''third parameter''|...|''tenth parameter''}} produces: {{tlx{{\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 {{tlf|{{=}}}}, like so:
: {{tlx{{\sandbox}}|tlx|Template|''first''<nowiki>{{=}}</nowiki>''first value''|''second''|''third''<nowiki>{{=}}</nowiki>''third value''}} produces: {{tlx{{\sandbox}}|Template|''first{{=}}first value''|''second''|''third{{=}}third value''}}

For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in {{tag|nowiki}} tags. When you do, you don't need to replace equals-signs. For instance:
: {{tlx{{\sandbox}}|tlx|Template|<nowiki><nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki></nowiki>}} produces: {{tlx{{\sandbox}}|Template|<nowiki>first|second|third=value|...|999th</nowiki>}}

==Purpose and naming==
Mnemonically, ''template link expanded'' (after ''[[Template:tl|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 <code>&#124;</code>. A keyword parameter can be used with equals code &#61; or <nowiki>{{=}}</nowiki> or in nowiki-text: "{{tag|nowiki|content=size=10}}" or all parameters as a string in "{{tag|nowiki|o}}" tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see [[{{TALKPAGENAME}}|this talk]] page. If you use 21 or more parameters, all after the 20th will be replaced with a single {{para||...}} at the end of the parameter list.

; Exceptions
If the intended template lists numerous parameters, then perhaps this template should really {{em|not}} be used, and just hardcode the usage with {{tag|code|o}}{{tag|nowiki|o}}. For example:
: {{tag|code|content={{tag|nowiki|content=<nowiki>{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}</nowiki>}}}}.
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 {{tag|pre}}.

===Parameters===
*If the only parameter supplied is {{param|1}}, i.e. a template's name, {{tlx|tlx}}'s output is the same as {{tlx|tl}} – i.e. a link within [[Braces (punctuation)|braces]] – but in a [[monospaced font]]:
{{tc|tl|tl}} produces: {{tl|tl}}
{{tc|tlx|tl}} produces: {{tlx{{\sandbox}}|tl}}
: {{tlx|tl}} will also not take nor display additional parameters.

; Named parameters
{{para|subst}}
: Setting this parameter to any non-blank value will prefix the string <code>subst:</code> linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example, {{tlx{{\sandbox}}|tlx|Welcome|3=subst=Y}} produces: {{tlx{{\sandbox}}|Welcome|subst=Y}}. This is similar to the action of the {{tlx{{\sandbox}}|tlxs}} template: {{tlx{{\sandbox}}|tlxs|Welcome}} produces: {{tlxs|Welcome}}.
{{para|SISTER}}
: For an interwiki link to [[H:IW|other sister projects]], such as: {{para|SISTER|M:}} ([[m:|Meta]]), {{para|SISTER|Q:}} ([[q:|WikiQuote]]), {{para|SISTER|S:}} ([[s:|WikiSource]]), etc, facilitating interwiki template documentation and/or discussion.
{{para|LANG}}
: For a link to [[H:ILL|Wikipedias in other languages]], such as: {{para|LANG|de:}} ([[:de:|German]]), {{para|LANG|sv:}} ([[:sv:|Swedish]]), etc, facilitating cross-language template documentation and/or discussion.

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

===Usage===
:<code>{{tlx{{!}}Templatename}}</code>
:<code>{{tlx{{!}}Templatename{{!}}param}}</code>
:<code>{{tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10}}</code>
:<code>{{tlx{{!}}Templatename{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#124;more}}</code>
:<code>{{tlx{{!}}Templatename{{!}}param&#61;value}}</code>
There are up to 10 placeholders for parameters of the specified template.

===Examples===
For examples see wikipedia page [[wikipedia:Template:Tx]]

==TemplateData==
{{collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
"params": {
"1": {
"label": "Template name",
"description": "Name of the template to link.",
"example": "Tlx",
"type": "wiki-template-name",
"required": true
},
"2": {
"label": "1st parameter",
"type": "string"
},
"3": {
"label": "2nd parameter",
"type": "string"
},
"4": {
"label": "3rd parameter",
"type": "string"
},
"5": {
"label": "4th parameter",
"type": "string"
},
"6": {
"label": "5th parameter",
"type": "string"
},
"7": {
"label": "6th parameter",
"type": "string"
},
"8": {
"label": "7th parameter",
"type": "string"
},
"9": {
"label": "8th parameter",
"type": "string"
},
"10": {
"label": "9th parameter",
"type": "string"
},
"11": {
"label": "10th parameter",
"type": "string"
},
"12": {
"label": "11th parameter",
"type": "string"
},
"13": {
"label": "12th parameter",
"type": "string"
},
"14": {
"label": "13th parameter",
"type": "string"
},
"15": {
"label": "14th parameter",
"type": "string"
},
"16": {
"label": "15th parameter",
"type": "string"
},
"17": {
"label": "16th parameter",
"type": "string"
},
"18": {
"label": "17th parameter",
"type": "string"
},
"19": {
"label": "18th parameter",
"type": "string"
},
"20": {
"label": "19th parameter",
"type": "string"
},
"21": {
"label": "20th parameter",
"type": "string"
},
"subst": {
"description": "Set to any value to show \"subst:\" before the template name",
"example": "true",
"type": "boolean",
"label": "Show subst:"
},
"LANG": {
"label": "Language",
"description": "The prefix for a link to Wikipedias in other languages.",
"example": "de:",
"type": "line"
},
"SISTER": {
"description": "The prefix for an interwiki link to other sister projects",
"example": "M:",
"type": "line",
"label": "Sister project"
}
},
"description": "Show example template usage without expanding the template itself. {{tnull}} is similar without linking the template.",
"paramOrder": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"subst",
"LANG",
"SISTER"
],
"format": "inline"
}
</templatedata>
{{collapse bottom}}

==See also==
For more detail see wikipedia page [[wikipedia:Template:Txl]]

<includeonly>{{Sandbox other||{{#ifeq:{{BASEPAGENAME}}|Tlx |
[[Category:Internal template-link templates]]
[[Category:Interwiki link templates]]
[[Category:Wikitext typing-aid templates]]
}}}}</includeonly>