Template:Template link expanded/doc: Difference between revisions

From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search

Template:Template link expanded/doc (view source)

Revision as of 16:22, July 15, 2022

103 bytes added ,  1 year ago
m
Text replacement - "\[\[Category:([^|]+)\|{{PAGENAME}}\]\]" to "Category:$1"
mNo edit summary
m (Text replacement - "\[\[Category:([^|]+)\|{{PAGENAME}}\]\]" to "Category:$1")
 
(55 intermediate revisions by 36 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, TlxmTlxw, TlxwTlxb)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}|Meta|&nbsp;|[[M:template:{{PAGENAMEE}}|Masterpage]]
&nbsp;}}</small></includeonly><noinclude>
=={{Documentation== subpage}}▼
{{template doc page viewed directly}}
{{-}}
</noinclude>
{{interwikitmp-grp
|V=D
|cats=
|inhib=yes
|wdy=|wqt=|wsr=|wnw=
|{{PAGENAME}}|{{PAGENAME}}}}</noinclude>
 
<!-- Parent template(s) usage Beginsbegins: --->
<includeonly>{{interwikitmp-grp|V=6|cat=Typing-aid templates |CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}}</includeonly>
 
: {{tlxTlx|tlxTlx|templateTemplate|first parameter|second|third|fourth...|fifth|sixth|seventh|eight|ninthtenth}} → {{tlxTlx|templateTemplate|first parameter|second|third|fourth|fifth|sixth|seventh|eight...|ninthtenth}}
: {{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|&lt;nowiki>first|second|...|999th&lt;/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.
==Purpose and naming==▼
[[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'... after <tt>{{tlx|tl}}</tt> '''T'''emplate '''l'''ink' ▼
 
▲== 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. Its primary use is in instruction and documentation.▼
▲[[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'... afterAfter <tt>{{tlx|tlTl}}</tt> ''''T'''emplate '''l'''ink' .
* '''''Specifics:''''' Up to five pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 5 parameters can be displayed using a coded vertical-bar (as in "<small>&amp;#124;</small>''...''"). A keyword parameter can be used, when tagged as a nowiki-keyword: <nowiki>"<nowiki>siz=10<\nowiki>"</nowiki> with each keyword parameter surrounded by <nowiki>"<nowiki>"</nowiki> tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see the [[w:{{TALKPAGENAME}}|this talk]] page.▼
 
* '''''Exceptions:''''' If the intended template lists numerous/keyword parameters, then perhaps this template should really ''not'' be used, and just hardcode the usage with <code><nowiki>&lt;code&gt;&lt;nowiki&gt;</code>, for example: <code><nowiki>&lt;code&gt;&lt;nowiki&gt;{{Anytemplate|arg1=23|siz=250px|</nowiki><var>other parameters...</var><nowiki>}}&lt;/nowiki&gt;&lt;/code&gt;</nowiki></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 <code><nowiki><pre>...</pre></nowiki></code>.▼
▲* This template takes another ''template-name'' and some associated [[wHelp:pipe-Pipe trick|pipe-tricked]] [http[m://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. Its primary use is in instruction and documentation.
▲* '''''Specifics:''''' Up to five10 pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 510 parameters can be displayed using a coded vertical-bar (as in "<small>&amp;#124;</small>''...''"). A keyword parameter can be used, whenwith taggedequals ascode a&amp;#61; nowiki-keyword:or <nowiki>"<nowiki>siz{{=10}}<\/nowiki> or in nowiki-text: "</{{tag|nowiki>|content=size=10}}" withor eachall keywordparameters parameteras surroundeda bystring in <nowiki>"<{{tag|nowiki>|o}}"</nowiki> tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see the [[w:{{TALKPAGENAME}}|this talk]] page.
▲* '''''Exceptions:''''' If the intended template lists numerous/keyword parameters, then perhaps this template should really ''not'' be used, and just hardcode the usage with <{{tag|code><|o}}{{tag|nowiki>&lt;code&gt;&lt;nowiki&gt;</code>|o}}, for example: <{{tag|code>|content={{tag|nowiki|content=<nowiki>&lt;code&gt;&lt;nowiki&gt;{{Anytemplate|arg1=23|sizsize=250px|</nowiki><var>other parameters...</var><nowiki>}}&lt;/nowiki&gt;&lt;/code&gt;</nowiki></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 <code><nowiki><{{tag|pre>...</pre></nowiki></code>}}.
 
----
 
* 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}} [[W:macroMacro (computer science)|macro]] template -- a blue link nested in [[W:brackets|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.
 
:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}})
Line 33 ⟶ 31:
* {{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.
 
== Documentation ==
----
 
;This usage also applies to interwiki capable template variations:
# {{Tl|Tlxc}} -- which links to templates on Wikimedia Commons (The Commons).
# {{Tl|Tlxm}} -- which links to templates on Meta
# {{Tl|Tlxw}} -- which links to templates on Wikipedia
 
----
 
▲==Documentation==
 
{&#123;[[Template:{{PAGENAMEBASEPAGENAME}}|{{PAGENAMEBASEPAGENAME}}]]&#125;}
is a generalization of {{TlxwTl|Tl|x}}, {{TlxwTl|Tlp|x|y}},
etcetera with arguably better readable
output. This depends on the browser, but too narrow
Line 55 ⟶ 44:
=== Usage ===
 
:<tt>{&#123;{{PAGENAMEBASEPAGENAME}}{{!}}template name&#125;}</tt>
:<tt>{&#123;{{PAGENAMEBASEPAGENAME}}{{!}}template name{{!}}param&#125;}</tt>
:<tt>{&#123;{{PAGENAMEBASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#125;}</tt>
:<tt>{&#123;{{PAGENAMEBASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&amp;#124;more&#125;}</tt>
:<tt>{&#123;{{PAGENAMEBASEPAGENAME}}{{!}}template name{{!}}param&amp;#61;value&#125;}</tt>
''Up to three10 placeholders for parameters of the specified template''
 
=== Examples ===
Line 73 ⟶ 62:
! Remark
|-
|{{Tlx|SISTER=W:|Tlx|x0}}
|{{Tlx|SISTER=W:|x0}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|Abc}}
|{{Tlx|SISTER=W:|Abc}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|ABC}}
|{{Tlx|SISTER=W:|ABC}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|AbC}}
|{{Tlx|SISTER=W:|AbC}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|x1|one}}
|{{Tlx|SISTER=W:|x1|one}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|x2|one|two}}
|{{Tlx|SISTER=W:|x2|one|two}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|x3|1<tt>&#124;</tt>|2<tt>|3|4|5|6|7|8|9&#124;</tt>310}}
|{{Tlx|SISTER=W:|x3|1|2|3|4|5|6|7|8|9|10}}
||&#160;
|-
|{{Tlx|SISTER=W:|Tlx|x4|1<tt>|2|3|4|5|6|7|8|9&#124;</tt>2<tt>10&#124;</tt>3|411}}
|{{Tlx|SISTER=W:|x4|1|2|3|4|5|6|7|8|9|10|11}}
|up to 510 parameters, then ...
|-
|{{Tlx|SISTER=W:|Tlx|x4x5|1<tt>&#124;</tt>|2<tt>|3|4|5|6|7|8|9&#124;</tt>310&amp;#124;411}}
|{{Tlx|SISTER=W:|x4x5|1|2|3|4|5|6|7|8|9|10&#124;411}}
|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|SISTER=W:|Tlx|x1|x&#61;u}}
▲|{{Tlx|SISTER=W:|x1|x=u}}
|'''=''' won't work
|-
|{{Tlx|SISTER=W:|Tlx|x1|x&amp;#61;u}}
|{{Tlx|SISTER=W:|x1|x&#61;u}}
|align="right"|<tt>&amp;#61;</tt> is okay
|-
|{{Tlx|SISTER=W:|Tlx|x1|x<nowiki>{{=}}</nowiki>u}}
|{{Tlx|SISTER=W:|x1|x{{=}}u}}
|align="right"|<tt><nowiki>{{=}}</nowiki></tt> is okay
|-
|{{Tlx|SISTER=W:|Tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
|{{Tlx|SISTER=W:|x1|<nowiki>x=u</nowiki>}}
|align="right"|sticky nowiki is okay
|-
|{{Tlx|SISTER=W:|Tlx|x2|&#160;|two}}
|{{Tlx|SISTER=W:|x2| |two}}
|empty won't work
|-
|{{Tlx|SISTER=W:|Tlx|x2|&amp;#32;|two}}
|{{Tlx|SISTER=W:|x2|&#32;|two}}
|align="right"|<tt>&amp;#32;</tt> is okay
|-
|{{Tlx|SISTER=W:|Tlx|x2|&amp;nbsp;|two}}
|{{Tlx|SISTER=W:|x2|&nbsp;|two}}
|align="right"|<tt>&amp;nbsp;</tt> is okay
|-
|{{Tlx|SISTER=W:|Tlx|x2| &amp;#124; two}}
|{{Tlx|SISTER=W:|x2| &#124; two}}
|align="right"|<tt>&amp;#124;</tt> is okay
|-
|| {{Tlx|SISTER=W:|Tlx|x2| {&#123;!&#125;} two}}
|| {{Tlx|SISTER=W:|x2| {{!}} two}}
|align="right"|{{Tlx|SISTER=W:|!}} is dubious
|-
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}}
|| {{Tlx|SISTER=W:|x2|2=|3=two}}
|empty really doesn't work
|-
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=one</nowiki>|two}}
|| {{Tlx|SISTER=W:|x2|2=one|two}}
|'''two''' clobbers '''2=one'''
|-
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
|| {{Tlx|SISTER=W:|x2|3=two|2=one}}
|align="right"|right to left okay
|}
 
== See also ==
* [[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.
[[w:Template:Para|Template:Para]] &ndash; for giving examples of template parameters and values only, instead of entire templates with parameters.▼
* [[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>.
▲* [[w:Template:Para|Template:Para]] &ndash; 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 --->
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 
<includeonly>
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE -->
[[Category:Typing-aid templates |{{PAGENAME}}]]
[[Category:Internal link templates |{{PAGENAME}}]]
[[Category:Interwiki link templates |{{PAGENAME}}]]
 
 
<!-- 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]]
Line 185:
[[ru:Template:Tlx]]
[[simple:Template:Tlx]]
[[sr:Šablon:Tlx]]
[[th:แม่แบบ:Tlx]]
[[tl:Suleras:Tlx]]
[[uk:Шаблон:Tlx]]
[[ur:سانچہ:Tlx]]
[[zh:Template:Tlx]]
</includeonly>
Retrieved from "https://crocwiki.com/wiki/Special:MobileDiff/30364...32110"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information

Navigation menu