Template:Template link expanded/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content deleted Content added
→Usage: this attempt to hide the usage section from the main page failed because the pipes were interpreted by the {{#ifeq}}. Use {{!}} to get around this |
m Text replacement - "\[\[Category:([^|]+)\|{{PAGENAME}}\]\]" to "Category:$1" |
||
(76 intermediate revisions by 54 users not shown) | |||
Line 1:
<includeonly><!-----------------Interwiki Doc page pattern------------------->
<small>''This '{{Tlx|Tlx}}' template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all ''Tlx family templates (Tlx, Tlxc,
}}</small></includeonly><noinclude>
{{Documentation subpage}}
{{-}}
</noinclude>
<!-- Parent template(s) usage
: {{
: {{Tlx|Tlx|Template|<nowiki>2=first parameter|3=second|4=third|5=...|11=tenth</nowiki>}} → {{Tlx|Template|2=first parameter|3=second|4=third|5=...|11=tenth}} if they might contain "=" signs.
: {{Tlx|Tlx|Template|<nowiki>first|second|...|999th</nowiki>}} → {{Tlx|Template|<nowiki>first|second|...|999th</nowiki>}} (for more than 10 parameters)
The three dots in these examples represent a number of arguments that have been omitted in the examples and are not an actual argument.
'''<big>Purpose and naming:</big>''' [[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ist e'''x'''panded'... after <tt>{{tlx|tl}}</tt> '''T'''emplate '''l'''ist' ▼
== Purpose and naming ==
* This template takes another ''template-name'' and some associated [[w:pipe-trick|pipe-tricked]] [http://meta.wikimedia.org/wiki/Parameter#Parameters (numbered) parameters] (or 'pass parameters'), and displays them as an 'example demonstration' of how the ''template-name'' template could be coded, literally. It's primary use is in instruction and documentation.▼
▲
▲* This template takes another ''template-name'' and some associated [[
* '''''Specifics:''''' Up to
* '''''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}}.
----
* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' it presents the same as the similar {{tl|Tl}} [[
:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{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 ''subst''. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to [[Help:Substitution]]. This is useful to indicate when a template should be substituted. For example {{tlx|Tlx|Welcome|<nowiki>subst=Y</nowiki>}} will display {{Tlx|Welcome|subst=Y}}.
* Additionally, Tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=W:', 'Tlx|SISTER=M:', 'Tlx|SISTER=Q:', 'Tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries. Small 'front end' Shell or convience templates {{Tlx|Tlxw}} and {{tlx|Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.▼
▲* Additionally, Tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=W:', 'Tlx|SISTER=M:', 'Tlx|SISTER=Q:', 'Tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries
== Documentation ==
{{[[Template:{{
is a generalization of {{
etcetera with arguably better readable
output. This depends on the browser, but too narrow
uses of "'''{'''", "'''|'''", "'''}'''" in conjunction
with links can be hard to read.
=== Usage ===
:<tt>{{{{
:<tt>{{{{
:<tt>{{{{
:<tt>{{{{
:<tt>{{{{
''Up to
=== Examples ===
Line 71 ⟶ 62:
! Remark
|-
|{{Tlx
|{{Tlx
|| 
|-
|{{Tlx
|{{Tlx|
|| 
|-
|{{Tlx
|{{Tlx|
|| 
|-
|{{Tlx
|{{Tlx|
|| 
|-
|{{Tlx
|{{Tlx|
|| 
|up to 5 parameters, then ...▼
|-
|{{Tlx|Tlx|x2|one|two}}
|| 
|-
|{{Tlx|Tlx|x3|1|2|3|4|5|6|7|8|9|10}}
|{{Tlx|x3|1|2|3|4|5|6|7|8|9|10}}
|| 
|-
|{{Tlx|Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}}
|{{Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}}
|-
|{{Tlx
|{{Tlx|
|align="right"|<tt>&#124;</tt> for more
|-
|colspan=2| {{Tlx|Tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}}
|{{Tlx|SISTER=W:|Tlx|x1|x=u}}▼
|unlimited parameters as one nowiki string
▲|{{Tlx|SISTER=W:|x1|x=u}}
|-
|{{Tlx|x1|x=u}}
|'''=''' won't work
|-
|{{Tlx
|{{Tlx
|align="right"|<tt>&#61;</tt> is okay
|-
|{{Tlx
|{{Tlx
|align="right"|<tt><nowiki>{{=}}</nowiki></tt> is okay
|-
|{{Tlx|Tlx|x1|<nowiki>x=u</nowiki>}}
|{{Tlx|x1|<nowiki>x=u</nowiki>}}
|align="right"|sticky nowiki is okay
|-
|{{Tlx
|{{Tlx
|empty won't work
|-
|{{Tlx
|{{Tlx
|align="right"|<tt>&#32;</tt> is okay
|-
|{{Tlx
|{{Tlx
|align="right"|<tt>&nbsp;</tt> is okay
|-
|{{Tlx
|{{Tlx
|align="right"|<tt>&#124;</tt> is okay
|-
|| {{Tlx
|| {{Tlx
|align="right"|{{Tlx
|-
|| {{Tlx
|| {{Tlx
|empty really doesn't work
|-
|| {{Tlx
|| {{Tlx
|'''two''' clobbers '''2=one'''
|-
|| {{Tlx
|| {{Tlx
|align="right"|right to left okay
|}
== See also ==
* [[Template:Tlxb]] – 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.
* [[Template:Temt]], – 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>.
* [[Template:Para]] – for giving examples of template parameters and values only, instead of entire templates with parameters.
{{tl-nav}}
<!--- Categories applied to both /doc style Documentation page and to the parent templates --->
<!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE --->
<includeonly>
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE -->
[[Category:Typing-aid templates
[[Category:Internal link templates
[[Category:Interwiki link templates
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE -->
[[as:Template:Tlx]]
[[cy:Nodyn:Tlx]]
[[de:Vorlage:Vorlage]]
[[fr:Modèle:Lmp]]
[[fa:الگو:الگوب]]
[[hsb:Předłoha:Tlx]]
[[hy:Կաղապար:Tlx]]
[[ko:틀:Tlx]]
[[ia:Patrono:Tlx]]
[[os:Шаблон:Tlp]]
[[mk:Шаблон:Швп]]
[[id:Templat:Tlx]]
[[ja:Template:Tlx]]
[[no:Mal:Tlx]]
[[pt:Predefinição:Tlx]]
[[ro:Format:Tlx]]
[[ru:Template:Tlx]]
[[simple:Template:Tlx]]
[[sr:Šablon:Tlx]]
[[th:แม่แบบ:Tlx]]
[[tl:Suleras:Tlx]]
[[uk:Шаблон:Tlx]]
[[ur:سانچہ:Tlx]]
[[zh:Template:Tlx]]
</includeonly>
|
Latest revision as of 16:22, July 15, 2022
This is a documentation subpage for Template:Template link expanded. It may contain usage information, categories and other content that is not part of the original template page. |
{{Tlx|Template|first parameter|second|third|...|tenth}}
→{{Template|first parameter|second|third|...|tenth}}
{{Tlx|Template|2=first parameter|3=second|4=third|5=...|11=tenth}}
→{{Template|first parameter|second|third|...}}
if they might contain "=" signs.{{Tlx|Template|<nowiki>first|second|...|999th</nowiki>}}
→{{Template|first|second|...|999th}}
(for more than 10 parameters)
The three dots in these examples represent a number of arguments that have been omitted in the examples and are not an actual argument.
Purpose and naming
Mnemonically 'Template link expanded'. After {{Tl}}
'Template link'.
- This template takes another template-name and some associated pipe-tricked (numbered) parameters (or 'pass parameters'), and displays them as an 'example demonstration' of how the template-name template could be coded, literally. Its primary use is in instruction and documentation.
- Specifics: Up to 10 pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 10 parameters can be displayed using a coded vertical-bar (as in "|..."). A keyword parameter can be used with equals code = 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>
. 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<nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki>
</code><pre>...</pre>
.
- If given no additional parameters except
'template name' ({{{1}}}),
it presents the same as the similar {{Tl}} macro template -- a blue link nested in curly-braces-- the same as a user would apply the template without parameters, but with a noticably clearer font and spacing on most modern browsers.
- Comparatively,
{{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}}
has a named parameter subst. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example{{Tlx|Welcome|subst=Y}}
will display{{subst:Welcome}}
.
- Additionally, Tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=W:', 'Tlx|SISTER=M:', 'Tlx|SISTER=Q:', 'Tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries.
Documentation
{{Template link expanded}} is a generalization of {{Tl}}, {{Tlp}}, etcetera with arguably better readable output. This depends on the browser, but too narrow uses of "{", "|", "}" in conjunction with links can be hard to read.
Usage
- {{Template link expanded|template name}}
- {{Template link expanded|template name|param}}
- {{Template link expanded|template name|1|2|3|4|5|6|7|8|9|10}}
- {{Template link expanded|template name|1|2|3|4|5|6|7|8|9|10|more}}
- {{Template link expanded|template name|param=value}}
Up to 10 placeholders for parameters of the specified template
Examples
- 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.
Code | Result | Remark |
---|---|---|
{{Tlx|x0}}
|
{{x0}}
|
|
{{Tlx|Abc}}
|
{{Abc}}
|
|
{{Tlx|ABC}}
|
{{ABC}}
|
|
{{Tlx|AbC}}
|
{{AbC}}
|
|
{{Tlx|x1|one}}
|
{{x1|one}}
|
|
{{Tlx|x2|one|two}}
|
{{x2|one|two}}
|
|
{{Tlx|x3|1|2|3|4|5|6|7|8|9|10}}
|
{{x3|1|2|3|4|5|6|7|8|9|10}}
|
|
{{Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}}
|
{{x4|1|2|3|4|5|6|7|8|9|10|11}}
|
up to 10 parameters, then ... |
{{Tlx|x5|1|2|3|4|5|6|7|8|9|10|11}}
|
{{x5|1|2|3|4|5|6|7|8|9|10|11}}
|
| for more |
{{Tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}
|
unlimited parameters as one nowiki string | |
{{Tlx|x1|x=u}}
|
{{x1}}
|
= won't work |
{{Tlx|x1|x=u}}
|
{{x1|x=u}}
|
= is okay |
{{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|2=one|two}}
|
{{x2|two}}
|
two clobbers 2=one |
{{Tlx|x2|3=two|2=one}}
|
{{x2|one|two}}
|
right to left okay |
See also
- Template:Tlxb – same as {{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.
- Template:Temt, – same as {{Tlx}}, but handles template names with the Template: prefix and templates not in the Template: namespace {{ns:10}}.
- Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.