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

960 bytes removed ,  1 year ago
m
Text replacement - "\[\[Category:([^|]+)\|{{PAGENAME}}\]\]" to "Category:$1"
(Subst {{Interwiki doc page pattern}} + Merge updated usage from Meta (Overwite all here))
m (Text replacement - "\[\[Category:([^|]+)\|{{PAGENAME}}\]\]" to "Category:$1")
 
(93 intermediate revisions by 64 users not shown)
Line 1:
Snippet heading from {{Tl|<includeonly><!-----------------Interwiki docDoc page pattern}}:<br------------------->
<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|&nbsp;|[[M:template:{{PAGENAMEE}}|Masterpage]]
;This page will show SIX broken commands in three block forming pairs before or after subst'ing -- all involve the partial (broken) command word 'in clude' ('''note the added space''') -- these are deliberate breakings of those [[w:wikimarkup|wikimarkup language]] keywords to ensure this whole boilerplate template will be subst'ed. Fix these after substing this page in it's destination and delete this heading, as well as the how-to guiding imbedded comments below.
&nbsp;}}</small></includeonly><noinclude>
<in cludeonly><!-----------------Interwiki Doc page pattern-------------------> {{-}}
{{Documentation subpage}}
<small>''This '{{BASEPAGENAME}}' template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all {{Lts| {{BASEPAGENAME}} }} tagged templates'' [<span class="plainlinks">[{{fullurl:Template:{{BASEPAGENAME}}/doc |action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}|Wikipedia|&nbsp;|[[W:template:{{PAGENAMEE}}|Masterpage]]
&nbsp;}}</small></in cludeonly><noin clude> {{template doc page viewed directly}}
{{-}}
</noinclude>
<!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE --->
[[Category:Template documentation|{{PAGENAME}}]]
<!-- EDIT the /doc (or THIS usage page only) Interwiki's BELOW THIS LINE -->
 
<!-- Parent template(s) usage begins: --->
<!-- -----------------------------------------------------------
---- Self declarations, this page, not the parent template.
---- ------------------------------------------------------ --->
{{interwikitmp-grp|V=D|cats=|inhib=yes|{{PAGENAME}}|{{PAGENAME}}}} <!-- Comment this out if not an tools template of
---- ---- interwikitmp-grp interest, use, or scope.-->
</no include><in cludeonly>
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE -->
[[Category:Typing-aid templates |{{PAGENAME}}]] <!-- Just some possibilities, the top two are sub-cats of Misc.[[Category:Uncategorized templates |{{PAGENAME}}]]
[[Category:Miscellaneous templates |{{PAGENAME}}]]
[[Category:Internal link templates |{{PAGENAME}}]]
[[Category:Interwiki link templates |{{PAGENAME}}]]
[[Category:Navigational templates |{{PAGENAME}}]] --- END OF BLOCK COMMENT ------------------------- --->
 
: {{Tlx|Tlx|Template|first parameter|second|third|...|tenth}} → {{Tlx|Template|first parameter|second|third|...|tenth}}
<!-- EDIT IN (calling) TEMPLATE CATEGORIES ABOVE THIS LINE -->
: {{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.
</in cludeonly> <!--- Note: This breakage deliberate... in Six different places. ----
Just text search: 'in clude' to Clean it up after subst'ing when building your usage/documentation text. --->
 
== Purpose and naming ==
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
[[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.
* '''''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>&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}}.
 
----
 
* 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 noticably clearer font and spacing on most modern browsers.
<!-- ---------------------------------------------------------------------------
---- Calling or parent template declarations, the parent template, not this page.
---- ----------------------------------------------------------------------- --->
{{interwikitmp-grp|V=1|inhib=yes|{{PAGENAME}}|{{PAGENAME}}}} <!--- This is correct placement (inside includeonly block + towards the 'doc/usage' page bottom) and the call is correct for auto-categorization of many tools templates pages' generating internal links. This template call can be located anywhere in the documentation, but
should be kept inside the includeonly fence. A bottom location like this interferes least with display and formating of comprehensible documentation, but moving it up so text ends about the same point as the template display is a good thing for later edit needs. By keeping template interwiki's inside an includeonly block, this page can be given it's own, which is unimportant when the page is a collected usage page for similar templates, but good for /doc pages.
 
:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}})
Quick Usage on V=## parameter: 1==internal links, 2==interwiki links, 3==Miscellaneous, 4==1+3, 5==2+3, 6==1+2+3 or just (1+2) when 'inhib=yes|' parameter defined as well... such as {{Tl|Commonscat1A}}, where a category link is interwiki, and a link is to main article. Parameter: 'cat=bare cat name ' supplants miscellaneous, and is used for typing-aid or uncategorized types (sub-cats of miscellaneous); 'CATS=must be given full names with square parenthesis, and add on to the V=## auto-categories. <nowiki> {{{1}}}} is pipelink sort name for the auto-cats, in 'CATS=' calls, you must add such to the pass parameter. {{{2}}} is 'universal' override name, otherwise template name defaults to {{PAGENAME}} in links built and displayed. This is primarily used in Name Case Variants, where a naming collision occurs on a sister project. --->
 
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE -->
 
* 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}}.
MERGED Usage from Meta below
</includeonly>{{interwikitmp-grp|V=0|CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}}
{{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} <br>→ (becomes) → <br>{{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}
;Purpose:Mnemonically 'Template list expanded'... after {{tlx|tl}} 'Template list' {{I2}}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 aggregates them into an 'example demonstration' of how the ''template-name'' template might be used. It's primary use is in instruction and documentation such as this passage.
 
* 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.
* Up to five pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "<tt>|</tt>''...''", for details see the [[w:{{TALKPAGENAME}}|this talk]] page.
* 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:macro|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.
 
== Documentation ==
:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tlx}} versus Tlx: {{Tlx|Tl}})
 
{&#123;[[Template:{{BASEPAGENAME}}|{{BASEPAGENAME}}]]&#125;}
* Comparatively, {{Tlx|Tl}} will not take or display additional parameters, and for minor technical reasons, may preferred for mere listing and referencing in long pages involving a lot of template expansions[[W:WP:DPP|1]].
is a generalization of {{Tl|Tl|x}}, {{Tl|Tlp|x|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==
 
{&#123;[[Template:{{PAGENAME}}|{{PAGENAME}}]]&#125;}
is a generalization of {{Tlxw|Tl|x}}, {{Tlxw|Tlp|x|y}},
etcetera with arguably better readable
output. This depends on the browser, but too narrow
Line 68 ⟶ 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 ===
*{{SITENAME}}*
{{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->|
=== Example ===
{{#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 complicated templates that need be in template space. {{#ifeq:{{SITENAME}}|Wikipedia|
;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.
{{#ifeq:{{SITENAME}}
}}}}
|Meta3||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 87 ⟶ 62:
! Remark
|-
|{{{{Tlx|SISTER=W:|Tlx|x0}}
|{{{{Tlx|SISTER=W:|x0}}
||&#160;
|-
|{{{{Tlx|SISTER=W:|Tlx|x1|oneAbc}}
|{{{{Tlx|SISTER=W:|x1|oneAbc}}
||&#160;
|-
|{{{{Tlx|SISTER=W:|Tlx|x2|one|twoABC}}
|{{{{Tlx|SISTER=W:|x2|one|twoABC}}
||&#160;
|-
|{{{{Tlx|SISTER=W:|Tlx|x3|1<tt>&#124;</tt>2<tt>&#124;</tt>3AbC}}
|{{{{Tlx|SISTER=W:|x3|1|2|3AbC}}
||&#160;
|-
|{{{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3x1|4one}}
|{{{{Tlx|SISTER=W:x1|x4|1|2|3|4one}}
||&#160;
|up to 3 parameters
|-
|{{Tlx|Tlx|x2|one|two}}
|{{{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3&amp;#124;4}}
|{{{{Tlx|SISTER=W:x2|x4one|1|2|3&#124;4two}}
||&#160;
|-
|{{Tlx|Tlx|x3|1|2|3|4|5|6|7|8|9&#124;10}}
|{{Tlx|x3|1|2|3|4|5|6|7|8|9|10}}
||&#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|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|&lt;x<nowiki&gt;x&#61;u&lt;>{{=}}</nowiki&gt;>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|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
|}{{-}}
 
[[Category:Typing-aid templates |{{PAGENAME}}]]
== See also ==
[[Category:Internal link templates|{{PAGENAME}}]]
* [[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.
[[Category:Templates using ParserFunctions|{{{PAGENAME}}}]]
* [[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>.
----
* [[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 --->
 
<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>
Retrieved from "https://crocwiki.com/wiki/Special:MobileDiff/30326...32110"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information

Navigation menu