Template:Tlx/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
m (Park commons Tlx here pending reconciling both for all sisters)
 
(Subst {{Interwiki doc page pattern}} + Merge updated usage from Meta (Overwite all here))
Line 1: Line 1:
{{Interwiki doc page pattern}}
Snippet heading from {{Tl|Interwiki doc page pattern}}:<br>
This is commons (somewhat more dated logic...) parked here pending time to cycle back and make fixups as a proper doc file, reconcile the best logic, and then redistribute interwiki again. <b>[[User:Fabartus|Fra]]</b><font color="green">[[User talk:Fabartus|nkB]]</font> 04:47, 2 February 2007 (UTC)
;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.
<in cludeonly><!-----------------Interwiki Doc page pattern-------------------> {{-}}
<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}}
{{-}}
<!-- 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 -->
 
<!-- -----------------------------------------------------------
---- 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  -------------------------  --->
 
<!-- EDIT IN (calling) TEMPLATE CATEGORIES ABOVE THIS LINE -->
 
</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.  --->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
 
 
<!-- ---------------------------------------------------------------------------
---- 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.
 
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 -->
 
 
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.
 
* 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.
   
   
{{[[{{ns:Template}}:{{{1|Tlx}}}|{{{1|Tlx}}}]]{{#if:{{{2|}}}|<tt>&#124;</tt>{{{2}}}}}{{#if:{{{3|}}}|<tt>&#124;</tt>{{{3}}}}}{{#if:{{{4|}}}|<tt>&#124;</tt>{{{4}}}}}{{#if:{{{5|}}}|<tt>&#124;</tt><i>etc.</i>}}}}<noinclude> {{interwikitmp-grp|V=0}}
* 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.
----
 
Usage: {{Tlx|Tlx|template name|first parameter|...}}<br />
:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tlx}} versus Tlx: {{Tlx|Tl}})
Up to three parameters for the specified template are displayed as placeholders, more parameters are shown as "<tt>|</tt>''etc.''", for details see the [http://en.wikipedia.org/wiki/Template_talk:Tlx en.talk] page.
 
* 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]].
 
* 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==
==Documentation==


{&#123;[[Template:{{PAGENAME}}|{{PAGENAME}}]]&#125;}
{&#123;[[Template:{{PAGENAME}}|{{PAGENAME}}]]&#125;}
is a generalization of {{Tlx|Tl|x}}, {{Tlx|Tlp|x|y}},
is a generalization of {{Tlxw|Tl|x}}, {{Tlxw|Tlp|x|y}},
{{Tlx|Tl2|x|y|z}}, etc. with arguably better readable
etcetera with arguably better readable
output. This depends on the browser, but too narrow
output. This depends on the browser, but too narrow
uses of "'''{'''", "'''|'''", "'''}'''" in conjunction
uses of "'''{'''", "'''|'''", "'''}'''" in conjunction
Line 24: Line 75:
''Up to three placeholders for parameters of the specified template''
''Up to three placeholders for parameters of the specified template''


*{{SITENAME}}*
=== Example ===
=== Example ===
;Note: On the source sister project, en.wikipedia, '''X0, X1, X2,..., X9 are sandbox templates''' for experimentation. Here they show as redlinks, as no auto-cleansing software facility exists.
;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|
{{#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"
{| border="1" cellpadding="4" class="wikitable"
Line 32: Line 87:
! Remark
! Remark
|-
|-
|{{Tlx|Tlx|x0}}
|{{{{Tlx|SISTER=W:|Tlx|x0}}
|{{Tlx|x0}}
|{{{{Tlx|SISTER=W:|x0}}
||&#160;
||&#160;
|-
|-
|{{Tlx|Tlx|x1|one}}
|{{{{Tlx|SISTER=W:|Tlx|x1|one}}
|{{Tlx|x1|one}}
|{{{{Tlx|SISTER=W:|x1|one}}
||&#160;
||&#160;
|-
|-
|{{Tlx|Tlx|x2|one|two}}
|{{{{Tlx|SISTER=W:|Tlx|x2|one|two}}
|{{Tlx|x2|one|two}}
|{{{{Tlx|SISTER=W:|x2|one|two}}
||&#160;
||&#160;
|-
|-
|{{Tlx|Tlx|x3|1<tt>&#124;</tt>2<tt>&#124;</tt>3}}
|{{{{Tlx|SISTER=W:|Tlx|x3|1<tt>&#124;</tt>2<tt>&#124;</tt>3}}
|{{Tlx|x3|1|2|3}}
|{{{{Tlx|SISTER=W:|x3|1|2|3}}
||&#160;
||&#160;
|-
|-
|{{Tlx|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3|4}}
|{{{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3|4}}
|{{Tlx|x4|1|2|3|4}}
|{{{{Tlx|SISTER=W:|x4|1|2|3|4}}
|up to 3 parameters
|up to 3 parameters
|-
|-
|{{Tlx|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3&amp;#124;4}}
|{{{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3&amp;#124;4}}
|{{Tlx|x4|1|2|3&#124;4}}
|{{{{Tlx|SISTER=W:|x4|1|2|3&#124;4}}
|align="right"|<tt>&amp;#124;</tt> for more
|align="right"|<tt>&amp;#124;</tt> for more
|-
|-
|{{Tlx|Tlx|x1|x&#61;u}}
|{{{{Tlx|SISTER=W:|Tlx|x1|x&#61;u}}
|{{Tlx|x1|x=u}}
|{{{{Tlx|SISTER=W:|x1|x=u}}
|'''=''' won't work
|'''=''' 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
|align="right"|<tt>&amp;#61;</tt> is okay
|-
|-
|{{Tlx|Tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
|{{{{Tlx|SISTER=W:|Tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
|{{Tlx|x1|<nowiki>x=u</nowiki>}}
|{{{{Tlx|SISTER=W:|x1|<nowiki>x=u</nowiki>}}
|align="right"|sticky nowiki is okay
|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
|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
|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
|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
|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
|empty really doesn't work
|-
|-
|| {{Tlx|Tlx|x2|<nowiki>2=one</nowiki>|two}}
|| {{{{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=one</nowiki>|two}}
|| {{Tlx|x2|2=one|two}}
|| {{{{Tlx|SISTER=W:|x2|2=one|two}}
|'''two''' clobbers '''2=one'''
|'''two''' clobbers '''2=one'''
|-
|-
|| {{Tlx|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
|| {{{{Tlx|SISTER=W:|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
|| {{Tlx|x2|3=two|2=one}}
|| {{{{Tlx|SISTER=W:|x2|3=two|2=one}}
|align="right"|right to left okay
|align="right"|right to left okay
|}{{-}}
|}{{-}}
Line 103: Line 158:
[[Category:Internal link templates|{{PAGENAME}}]]
[[Category:Internal link templates|{{PAGENAME}}]]
[[Category:Templates using ParserFunctions|{{{PAGENAME}}}]]
[[Category:Templates using ParserFunctions|{{{PAGENAME}}}]]
</noinclude>
----

Revision as of 15:46, 12 February 2007

Snippet heading from {{Interwiki doc page pattern}}:

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 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.

<in cludeonly>
This 'Tlx' template documentation is transcluded for all Template:Lts tagged templates [edit].Masterpage  </in cludeonly><noin clude> Template:Template doc page viewed directly

Template:Interwikitmp-grp </no include><in cludeonly>


</in cludeonly>



Template:Interwikitmp-grp


MERGED Usage from Meta below </includeonly>Template:Interwikitmp-grp {{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}
→ (becomes) →
{{template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}

Purpose
Mnemonically 'Template list expanded'... after {{tl}} 'Template list' Template:I2This template takes another template-name and some associated pipe-tricked (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.
  • Up to five pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "|...", for details see the this talk page.
  • 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.
  • {{Tl|Tl}} display compared to {{Tlx|Tl}}: (Tl: {{Tlx}} versus Tlx: {{Tl}})
  • Comparatively, {{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 expansions1.
  • 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 {{Tlxw}} and {{Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.

Documentation

{{Tlx/doc}} is a generalization of Template:Tlxw, Template:Tlxw, 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

{{Tlx/doc|template name}}
{{Tlx/doc|template name|param}}
{{Tlx/doc|template name|1|2|3}}
{{Tlx/doc|template name|1|2|3&#124;more}}
{{Tlx/doc|template name|param&#61;value}}

Up to three placeholders for parameters of the specified template

  • Official Kodi Wiki*

Example

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:Official Kodi Wiki|Wikipedia|

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|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 3 parameters
{{{{Tlx|x4|1|2|3&#124;4}} {{{{x4|1|2|3|4}} &#124; for more
{{{{Tlx|x1|x=u}} {{{{x1}} = won't work
{{{{Tlx|x1|x&#61;u}} {{{{x1|x=u}} &#61; 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|&#32;|two}} {{{{x2| |two}} &#32; is okay
{{{{Tlx|x2|&nbsp;|two}} {{{{x2| |two}} &nbsp; is okay
{{{{Tlx|x2| &#124; two}} {{{{x2| | two}} &#124; 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