Template:Template link expanded/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content deleted Content added
tlxb added |
m Text replacement - "\[\[Category:([^|]+)\|{{PAGENAME}}\]\]" to "Category:$1" |
||
(38 intermediate revisions by 31 users not shown) | |||
Line 1: | Line 1: | ||
<includeonly><!-----------------Interwiki Doc page pattern-------------------> |
<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>''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| |[[M:template:{{PAGENAMEE}}|Masterpage]] |
||
}}</small></includeonly><noinclude> |
}}</small></includeonly><noinclude> |
||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{-}} |
{{-}} |
||
</noinclude> |
|||
{{interwikitmp-grp |
|||
|V=D |
|||
|cats= |
|||
|inhib=yes |
|||
|wdy=|wqt=|wsr=|wnw= |
|||
|{{PAGENAME}}|{{PAGENAME}}}}</noinclude> |
|||
<!-- Parent template(s) usage begins: ---> |
<!-- Parent template(s) usage begins: ---> |
||
{{ |
: {{Tlx|Tlx|Template|first parameter|second|third|...|tenth}} → {{Tlx|Template|first parameter|second|third|...|tenth}} |
||
: {{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. |
|||
== Purpose and naming == |
== Purpose and naming == |
||
[[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx|Tl}}</tt> '''T'''emplate '''l'''ink'. |
[[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx|Tl}}</tt> ''''T'''emplate '''l'''ink'. |
||
* This template takes another ''template-name'' and some associated [[Help:Pipe trick|pipe-tricked]] [[m: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. |
* This template takes another ''template-name'' and some associated [[Help:Pipe trick|pipe-tricked]] [[m: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 |
* '''''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 "<small>&#124;</small>''...''"). 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. |
||
* '''''Exceptions:''''' If the intended template lists numerous |
* '''''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}} [[macro]] template -- a blue link nested in [[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. |
* If given no additional parameters except ''<code> 'template name' (<nowiki>{{{1}}}</nowiki>), </code>'' 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 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}}) |
:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}}) |
||
Line 32: | Line 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}}. |
* {{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 |
* 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. |
||
---- |
|||
;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 == |
== Documentation == |
||
Line 56: | Line 46: | ||
:<tt>{{{{BASEPAGENAME}}{{!}}template name}}</tt> |
:<tt>{{{{BASEPAGENAME}}{{!}}template name}}</tt> |
||
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param}}</tt> |
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param}}</tt> |
||
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3}}</tt> |
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10}}</tt> |
||
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3&#124;more}}</tt> |
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#124;more}}</tt> |
||
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param&#61;value}}</tt> |
:<tt>{{{{BASEPAGENAME}}{{!}}template name{{!}}param&#61;value}}</tt> |
||
''Up to |
''Up to 10 placeholders for parameters of the specified template'' |
||
=== Examples === |
=== Examples === |
||
Line 96: | Line 86: | ||
||  |
||  |
||
|- |
|- |
||
|{{Tlx|Tlx|x3|1 |
|{{Tlx|Tlx|x3|1|2|3|4|5|6|7|8|9|10}} |
||
|{{Tlx|x3|1|2|3}} |
|{{Tlx|x3|1|2|3|4|5|6|7|8|9|10}} |
||
||  |
||  |
||
|- |
|- |
||
|{{Tlx|Tlx|x4|1 |
|{{Tlx|Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} |
||
|{{Tlx|x4|1|2|3|4}} |
|{{Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} |
||
|up to |
|up to 10 parameters, then ... |
||
|- |
|- |
||
|{{Tlx|Tlx| |
|{{Tlx|Tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} |
||
|{{Tlx| |
|{{Tlx|x5|1|2|3|4|5|6|7|8|9|10|11}} |
||
|align="right"|<tt>&#124;</tt> for more |
|align="right"|<tt>&#124;</tt> for more |
||
|- |
|||
|colspan=2| {{Tlx|Tlx|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} |
|||
|unlimited parameters as one nowiki string |
|||
|- |
|- |
||
|{{Tlx|Tlx|x1|x=u}} |
|{{Tlx|Tlx|x1|x=u}} |
||
Line 158: | Line 151: | ||
== See also == |
== See also == |
||
⚫ | |||
<includeonly>{{interwikitmp-grp|V=6|cat=Typing-aid templates |CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}}</includeonly> |
|||
* [[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>. |
|||
⚫ | |||
⚫ | * [[ |
||
{{tl-nav}} |
|||
⚫ | |||
<!--- Categories applied to both /doc style Documentation page and to the parent templates ---> |
<!--- 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 ---> |
<!-- 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> |
<includeonly> |
||
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE --> |
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE --> |
||
[[Category:Typing-aid templates |
[[Category:Typing-aid templates ]] |
||
[[Category:Internal link templates |
[[Category:Internal link templates ]] |
||
[[Category:Interwiki link templates |
[[Category:Interwiki link templates ]] |
||
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE --> |
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE --> |
||
[[as:Template:Tlx]] |
|||
[[cy:Nodyn:Tlx]] |
|||
[[de:Vorlage:Vorlage]] |
[[de:Vorlage:Vorlage]] |
||
[[fr:Modèle:Lmp]] |
|||
[[fa:الگو:الگوب]] |
|||
[[hsb:Předłoha:Tlx]] |
[[hsb:Předłoha:Tlx]] |
||
[[hy:Կաղապար:Tlx]] |
|||
[[ko:틀:Tlx]] |
[[ko:틀:Tlx]] |
||
[[ia:Patrono:Tlx]] |
[[ia:Patrono:Tlx]] |
||
[[os:Шаблон:Tlp]] |
[[os:Шаблон:Tlp]] |
||
[[mk:Шаблон:Швп]] |
|||
[[id:Templat:Tlx]] |
|||
[[ja:Template:Tlx]] |
[[ja:Template:Tlx]] |
||
[[no:Mal:Tlx]] |
[[no:Mal:Tlx]] |
||
Line 186: | Line 185: | ||
[[ru:Template:Tlx]] |
[[ru:Template:Tlx]] |
||
[[simple:Template:Tlx]] |
[[simple:Template:Tlx]] |
||
[[sr:Šablon:Tlx]] |
|||
[[th:แม่แบบ:Tlx]] |
[[th:แม่แบบ:Tlx]] |
||
[[tl:Suleras:Tlx]] |
|||
[[uk:Шаблон:Tlx]] |
[[uk:Шаблон:Tlx]] |
||
[[ur:سانچہ:Tlx]] |
|||
[[zh:Template:Tlx]] |
|||
</includeonly> |
</includeonly> |