Template:Tlx/doc: Difference between revisions

Latest revision as of 21:49, 28 January 2015

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Tlx.

This template creates example usage syntax for a template, and links the name to the template page. The name is derived from "Template list expanded".

Up to 7 pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "|...". An optional SISTER parameter can specify an interwiki prefix to link to another wiki. Examples:

Code	Result	Remark
`{{Tlx\|x0}}`	`{{x0}}`
`{{Tlx\|x1\|one}}`	`{{x1\|one}}`
`{{Tlx\|x2\|one\|two}}`	`{{x2\|one\|two}}`
`{{Tlx\|x3\|1\|2\|3}}`	`{{x3\|1\|2\|3}}`
`{{Tlx\|x4\|1\|2\|3\|4}}`	`{{x4\|1\|2\|3\|4}}`	up to 7 parameters, then ...
`{{Tlx\|x4\|1\|2\|3\|4}}`	`{{x4\|1\|2\|3\|4}}`	`\|` for more
`{{Tlx\|x1\|x=u}}`	`{{x1}}`	= won't work
`{{Tlx\|x1\|x=u}}`	`{{x1\|x=u}}`	`=` is okay
`{{Tlx\|x1\|<nowiki>x=u</nowiki>}}`	`{{x1\|x=u}}`	sticky nowiki is okay
`{{Tlx\|x2\| \|two}}`	`{{x2\|two}}`	empty won't work
`{{Tlx\|x2\| \|two}}`	`{{x2\| \|two}}`	` ` is okay
`{{Tlx\|x2\| \|two}}`	`{{x2\| \|two}}`	` ` is okay
`{{Tlx\|x2\| \| two}}`	`{{x2\| \| two}}`	`\|` is okay
`{{Tlx\|x2\| {{!}} two}}`	`{{x2\| \| two}}`	`{{!}}` is dubious
`{{Tlx\|x2\|2=\|3=two}}`	`{{x2\|two}}`	empty really doesn't work
`{{Tlx\|x2\|3=two\|2=one}}`	`{{x2\|one\|two}}`	right to left okay

@@ Line 1: / Line 1: @@
-<!-----------------------(60 chars)------------------------><includeonly><!--
+{{documentation subpage}}
- ---------- /doc page model (for interwiki use) -----------
+This template creates example usage syntax for a template, and links the name to the template page. The name is derived from "'''T'''emplate '''l'''ist e'''x'''panded".
-  -->{{small
-      |1= ''This {{tlx|tlx}} template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all ''tlx family templates (tlx, tlxc, tlxw, tlxb)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>].<!--
-        -->{{#ifeq:{{SITENAME}}|Meta |&nbsp; |[[M:template:{{PAGENAMEE}}|master page]]&nbsp;}}<!--
-  -->}}</includeonly><!--
-  --><noinclude>{{documentation subpage}}<br/><hr/><br/>{{clear}}</noinclude>
-{{high-use|850,000+}}
-{{95%|''(In the following examples, [[Ellipsis|three dots]] indicate where parameters have been omitted.)''}}
+Up to 7 pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "<tt>|</tt>''...''". An optional <tt>SISTER</tt> parameter can specify an interwiki prefix to link to another wiki. Examples:
-; {{big|Basic use}}
-: {{tlx |tlx|Template|''first parameter''|''second parameter''|''third''|...|''tenth''}} <!--
- -->→ {{tlx |Template|''first parameter''|''second parameter''|''third''|...|''tenth''}}
-Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{tlx|{{=}}}}:
-: {{tlx |tlx|Template|''first<nowiki>{{=}}</nowiki>something''|''second''|''third<nowiki>{{=}}</nowiki>something''|...|tenth}} <!--
- -->→ {{tlx |Template|''first{{=}}something''|''second''|''third{{=}}something''|...|tenth}}
-For more than ten parameters, possibly also containing equals-signs, use:
-: {{tlx |tlx|Template|&lt;nowiki><nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>&lt;/nowiki>}} <!--
- -->→ {{Tlx|Template|<nowiki>first|second|third=something|...|999th</nowiki>}}
-== Purpose and naming ==
-[[Wikt:mnemonic|Mnemonically]], "['''t''']emplate ['''l''']ink e['''x''']panded" (after <tt>{{tlx|tl}}</tt>, "['''t''']emplate ['''l''']ink").
-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.
-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 "<small>&amp;#124;</small>''...''"). A keyword parameter can be used with equals code &amp;#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.
-* '''''Exceptions:''''' If the intended template lists numerous parameters, then perhaps this template should really ''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 given no additional parameters except ''<code>&nbsp;'template&nbsp;name'&nbsp;(<nowiki>{{{1}}}</nowiki>), </code>''&nbsp;it presents the same as the similar {{tl|Tl}} [[Macro (computer science)|macro]] template -- a blue link nested in [[brackets|curly-braces]]-- the same as a user would apply the template without parameters, but with a noticeably clearer font and spacing on most modern browsers.
-** {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}})
-* Comparatively, {{Tlx|Tl}} will not take or display additional parameters, and for minor technical reasons, may be preferred for mere listing and referencing in long pages involving a lot of template expansions.
-* {{tlx|Tlx}} has a named parameter {{para|subst}}. Setting this parameter to any non-blank value will place the string "<code>subst:</code>" before the template name, linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example {{tlx|Tlx|Welcome|3=subst=Y}} will display {{Tlx|Welcome|subst=Y}}. This is similar to the action of the {{tlx|tlxs}} template: {{tlx|Tlxs|Welcome}} will display {{Tlxs|Welcome}}.
-* Additionally, Tlx will take a named parameter {{para|SISTER}} to link interwiki to [[H:IW|other sister projects]] such as one of these examples: {{para|SISTER|M:}} ([[m:|Meta]]), {{para|SISTER|Q:}} ([[q:|WikiQuote]]), {{para|SISTER|S:}} ([[s:|WikiSource]]), etc. allowing documentation or discourse about a template across interwiki boundaries.
-* Tlx will also take a named parameter {{para|LANG}} to link to [[H:ILL|other language Wikipedias]], such as one of these examples: {{para|LANG|de:}} ([[:de:|German]]), {{para|LANG|sv:}} ([[:sv:|Swedish]]), etc. allowing documentation or discourse about a template across language boundaries.
-== Documentation ==
-{{tlx|Tlx}}
-is a generalization of {{Tl|Tl|x}}, {{Tl|Tlp|x|y}},
-etc., with arguably better-readable
-output. This depends on the browser, but too-narrow
-uses of "'''{'''", "'''|'''", "'''}'''" in conjunction
-with links can be hard to read when not monospaced (and hard to click on; for uses like <code><nowiki>{{!}}</nowiki></code>, see {{tlx|tln}}, which makes the click target bigger).
-===Usage===
-:<code>{&#123;tlx{{!}}template name&#125;}</code>
-:<code>{&#123;tlx{{!}}template name{{!}}param&#125;}</code>
-:<code>{&#123;tlx{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#125;}</code>
-:<code>{&#123;tlx{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&amp;#124;more&#125;}</code>
-:<code>{&#123;tlx{{!}}template name{{!}}param&amp;#61;value&#125;}</code>
-''Up to 10 placeholders for parameters of the specified template''
-=== Examples ===
-{{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->|
-{{#ifeq:{{SITENAME}}|Meta|<!-- No note needed --->|<!-- Other Sisters Note: --->
-;Note: On the source sister projects, en.wikipedia and Meta, '''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.
-}}}}
 {| border="1" cellpadding="4" class="wikitable"
@@ Line 63: / Line 9: @@
 ! Remark
 |-
-|{{Tlx|Tlx|x0}}
+|{{Tlx|SISTER=W:|Tlx|x0}}
-|{{Tlx|x0}}
+|{{Tlx|SISTER=W:|x0}}
-||&#160;
-|-
-|{{Tlx|Tlx|Abc}}
-|{{Tlx|Abc}}
 ||&#160;
 |-
-|{{Tlx|Tlx|ABC}}
+|{{Tlx|SISTER=W:|Tlx|x1|one}}
-|{{Tlx|ABC}}
+|{{Tlx|SISTER=W:|x1|one}}
 ||&#160;
 |-
-|{{Tlx|Tlx|AbC}}
+|{{Tlx|SISTER=W:|Tlx|x2|one|two}}
-|{{Tlx|AbC}}
+|{{Tlx|SISTER=W:|x2|one|two}}
 ||&#160;
 |-
-|{{Tlx|Tlx|x1|one}}
+|{{Tlx|SISTER=W:|Tlx|x3|1<tt>&#124;</tt>2<tt>&#124;</tt>3}}
-|{{Tlx|x1|one}}
+|{{Tlx|SISTER=W:|x3|1|2|3}}
 ||&#160;
 |-
-|{{Tlx|Tlx|x2|one|two}}
+|{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3|4}}
-|{{Tlx|x2|one|two}}
+|{{Tlx|SISTER=W:|x4|1|2|3|4}}
-||&#160;
+|up to 7 parameters, then ...
 |-
-|{{Tlx|Tlx|x3|1|2|3|4|5|6|7|8|9&#124;10}}
+|{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3&amp;#124;4}}
-|{{Tlx|x3|1|2|3|4|5|6|7|8|9|10}}
+|{{Tlx|SISTER=W:|x4|1|2|3&#124;4}}
-||&#160;
-|-
-|{{Tlx|Tlx|x4|1|2|3|4|5|6|7|8|9&#124;10&#124;11}}
-|{{Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}}
-|up to 10 parameters, then ...
-|-
-|{{Tlx|Tlx|x5|1|2|3|4|5|6|7|8|9&#124;10&amp;#124;11}}
-|{{Tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}}
 |align="right"|<tt>&amp;#124;</tt> for more
 |-
-|colspan=2| {{Tlx|Tlx|convert|<nowiki>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}}
+|{{Tlx|SISTER=W:|Tlx|x1|x&#61;u}}
-|unlimited parameters as one nowiki string
+|{{Tlx|SISTER=W:|x1|x=u}}
-|-
-|{{Tlx|Tlx|x1|x&#61;u}}
-|{{Tlx|x1|x=u}}
 |'''=''' won't work
 |-
-|{{Tlx|Tlx|x1|x&amp;#61;u}}
+|{{Tlx|SISTER=W:|Tlx|x1|x&amp;#61;u}}
-|{{Tlx|x1|x&#61;u}}
+|{{Tlx|SISTER=W:|x1|x&#61;u}}
 |align="right"|<tt>&amp;#61;</tt> is okay
 |-
-|{{Tlx|Tlx|x1|x<nowiki>{{=}}</nowiki>u}}
+|{{Tlx|SISTER=W:|Tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
-|{{Tlx|x1|x{{=}}u}}
+|{{Tlx|SISTER=W:|x1|<nowiki>x=u</nowiki>}}
-|align="right"|<tt><nowiki>{{=}}</nowiki></tt> is okay
-|-
-|{{Tlx|Tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
-|{{Tlx|x1|<nowiki>x=u</nowiki>}}
 |align="right"|sticky nowiki is okay
 |-
-|{{Tlx|Tlx|x2|&#160;|two}}
+|{{Tlx|SISTER=W:|Tlx|x2|&#160;|two}}
-|{{Tlx|x2| |two}}
+|{{Tlx|SISTER=W:|x2| |two}}
 |empty won't work
 |-
-|{{Tlx|Tlx|x2|&amp;#32;|two}}
+|{{Tlx|SISTER=W:|Tlx|x2|&amp;#32;|two}}
-|{{Tlx|x2|&#32;|two}}
+|{{Tlx|SISTER=W:|x2|&#32;|two}}
 |align="right"|<tt>&amp;#32;</tt> is okay
 |-
-|{{Tlx|Tlx|x2|&amp;nbsp;|two}}
+|{{Tlx|SISTER=W:|Tlx|x2|&amp;nbsp;|two}}
-|{{Tlx|x2|&nbsp;|two}}
+|{{Tlx|SISTER=W:|x2|&nbsp;|two}}
 |align="right"|<tt>&amp;nbsp;</tt> is okay
 |-
-|{{Tlx|Tlx|x2| &amp;#124; two}}
+|{{Tlx|SISTER=W:|Tlx|x2| &amp;#124; two}}
-|{{Tlx|x2| &#124; two}}
+|{{Tlx|SISTER=W:|x2| &#124; two}}
 |align="right"|<tt>&amp;#124;</tt> is okay
 |-
-|| {{Tlx|Tlx|x2| {&#123;!&#125;} two}}
+|| {{Tlx|SISTER=W:|Tlx|x2| {&#123;!&#125;} two}}
-|| {{Tlx|x2| {{!}} two}}
+|| {{Tlx|SISTER=W:|x2| {{!}} two}}
-|align="right"|{{Tlx|!}} is dubious
+|align="right"|{{Tlx|SISTER=W:|!}} is dubious
 |-
-|| {{Tlx|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}}
+|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}}
-|| {{Tlx|x2|2=|3=two}}
+|| {{Tlx|SISTER=W:|x2|2=|3=two}}
 |empty really doesn't work
 |-
-|| {{Tlx|Tlx|x2|<nowiki>2=one</nowiki>|two}}
+|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
-|| {{Tlx|x2|2=one|two}}
+|| {{Tlx|SISTER=W:|x2|3=two|2=one}}
-|'''two''' clobbers '''2=one'''
-|-
-|| {{Tlx|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
-|| {{Tlx|x2|3=two|2=one}}
 |align="right"|right to left okay
-|}
+|}<includeonly>[[Category:Internal link templates|Tlx]]
+----
-== See also ==
+<templatedata>
-* [[Template:Tlxb]] &ndash; same as {{tl|Tlx}}, but gives the template name in boldface type (this can be useful when stressing the difference between two similarly named templates). [[Template:Tlb]] is the same, except it uses regular text instead of a monospaced non-proportional font.
+{	"description": "Template list expanded",
-* [[Template:Temt]], &ndash; same as {{tl|Tlx}}, but handles template names with the Template: prefix and templates not in the [[Wikipedia:Namespace|Template: namespace]] <nowiki>{{ns:10}}</nowiki>.
+	"params": {
-* [[Template:Para]] &ndash; for giving examples of template parameters and values only, instead of entire templates with parameters.
+		"1": {
-{{tl-nav}}
+			"label": "Template",
+			"description": "Linked template name",
-<!--- Categories applied to both /doc style Documentation page and to the parent templates --->
+			"type": "string/wiki-page-name"
+		},
-<!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE --->
+		"2": {
+			"label": "Parameter",
-<includeonly>
+			"description": "Optional parameter",
-<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE -->
+			"type": "string"
-[[Category:Typing-aid templates |{{PAGENAME}}]]
+		},
-[[Category:Internal link templates |{{PAGENAME}}]]
+		"3": {
-[[Category:Interwiki link templates |{{PAGENAME}}]]
+			"description": "For 2 parameters",
+			"type": "string"
-<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE -->
+		},
-</includeonly>
+		"4": {
+			"description": "For 3 parameters",
-<includeonly>
+			"type": "string"
-[[de:Vorlage:Vorlage]]
+		},
-</includeonly>
+		"5": {
+			"description": "For 4 parameters",
+			"type": "string"
+		},
+		"6": {
+			"description": "For 5 parameters",
+			"type": "string"
+		},
+		"7": {
+			"description": "For 6 parameters",
+			"type": "string"
+		},
+		"8": {
+			"label": "Overflow",
+			"description": "Overflow shown as ...",
+			"type": "string"
+		},
+		"SISTER": {
+			"label": "Interwiki",
+			"description": "Optional InterWiki link prefix",
+			"type": "string"
+}	}	}</templatedata></includeonly>

Code	Result	Remark
`{{Tlx\|x0}}`	`{{x0}}`
`{{Tlx\|x1\|one}}`	`{{x1\|one}}`
`{{Tlx\|x2\|one\|two}}`	`{{x2\|one\|two}}`
`{{Tlx\|x3\|1\|2\|3}}`	`{{x3\|1\|2\|3}}`
`{{Tlx\|x4\|1\|2\|3\|4}}`	`{{x4\|1\|2\|3\|4}}`	up to 7 parameters, then ...
`{{Tlx\|x4\|1\|2\|3\|4}}`	`{{x4\|1\|2\|3\|4}}`	`\|` for more
`{{Tlx\|x1\|x=u}}`	`{{x1}}`	= won't work
`{{Tlx\|x1\|x=u}}`	`{{x1\|x=u}}`	`=` is okay
`{{Tlx\|x1\|<nowiki>x=u</nowiki>}}`	`{{x1\|x=u}}`	sticky nowiki is okay
`{{Tlx\|x2\| \|two}}`	`{{x2\|two}}`	empty won't work
`{{Tlx\|x2\| \|two}}`	`{{x2\| \|two}}`	` ` is okay
`{{Tlx\|x2\| \|two}}`	`{{x2\| \|two}}`	` ` is okay
`{{Tlx\|x2\| \| two}}`	`{{x2\| \| two}}`	`\|` is okay
`{{Tlx\|x2\| {{!}} two}}`	`{{x2\| \| two}}`	`{{!}}` is dubious
`{{Tlx\|x2\|2=\|3=two}}`	`{{x2\|two}}`	empty really doesn't work
`{{Tlx\|x2\|3=two\|2=one}}`	`{{x2\|one\|two}}`	right to left okay

Template:Tlx/doc: Difference between revisions

Latest revision as of 21:49, 28 January 2015

Navigation menu

Search