Difference between revisions of "Template:Tlx/doc"

From MINR.ORG WIKI
(+Tlxc)
(Try to simplify and clean up documentation. Give basic TLX first.)
Line 4: Line 4:
 
{{template doc page viewed directly|yes}}
 
{{template doc page viewed directly|yes}}
 
{{-}}
 
{{-}}
<!-- Add the Categories for this doc or usage page (only-- not for the calling template) BELOW THIS LINE --->
+
{{interwikitmp-grp|V=D|cats=|inhib=yes|{{PAGENAME}}|{{PAGENAME}}}}</noinclude>
  
[[Category:Template documentation|{{PAGENAME}}]]
+
<!-- Parent template(s) usage Begins: --->
 
+
<includeonly>{{interwikitmp-grp|V=6|cat=Typing-aid templates |CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}}</includeonly>
<!-- EDIT the Tlx/doc notes (or other things that should show on ONLY on THIS common usage page only) and Interwiki's BELOW THIS LINE for this page, not the calling templates --->
 
;As of creation of 'Tlx/doc', <s>two</s> three interwiki defauted versions also share this usage page:
 
# {{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
 
  
Since these are the two repositories of templates for exports to sister projects.<br>// <b>[[User:Fabartus|Fra]]</b><font color="green">[[User talk:Fabartus|nkB]]</font> 16:23, 12 February 2007 (UTC)
+
{{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} → {{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}
<!-- -----------------------------------------------------------
 
---- 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.-->
 
</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 -->
 
{{interwikitmp-grp|V=6|cat=Typing-aid templates |CATS=[[Category:Internal link templates|Tlx]][[Category:Interwiki link templates|Tlx]]}}
 
</includeonly><!--- Categories applied to both /doc style Documentation page and to the parent templates --->
 
[[Category:Templates using ParserFunctions|{{{PAGENAME}}}]]<!--
 
 
 
---- --------------------------------------------------------------------------------- ----
 
---- Common usage below this line, Special usage in if-then-else conditionals as well. ----
 
---- --------------------------------------------------------------------------------- ----
 
 
 
Parent template(s) usage Begins:
 
--->
 
;This usage also applies to interwiki capable template variations: 'Tlxc', 'Tlxm' and 'Tlxw' which reference templates on the Commons, Meta and Wikipedia, respectively by acting as a front end for {{tl|Tlx}} and making the proper interwiki page links.<br>
 
 
 
{{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}}
 
  
 
'''<big>Purpose and naming:</big>''' [[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ist e'''x'''panded'... after {{tlx|tl}} 'Template list'  
 
'''<big>Purpose and naming:</big>''' [[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ist e'''x'''panded'... after {{tlx|tl}} 'Template list'  
Line 46: Line 16:
  
 
* 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.
 
* 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.  
 
* 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.  
  
Line 54: Line 26:
  
 
* 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. 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.
 +
 +
----
 +
 +
;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 71: Line 52:
 
:<tt>{&#123;{{PAGENAME}}|template name|1|2|3&amp;#124;more&#125;}</tt>
 
:<tt>{&#123;{{PAGENAME}}|template name|1|2|3&amp;#124;more&#125;}</tt>
 
:<tt>{&#123;{{PAGENAME}}|template name|param&amp;#61;value&#125;}</tt>
 
:<tt>{&#123;{{PAGENAME}}|template name|param&amp;#61;value&#125;}</tt>
''Up to three placeholders for parameters of the specified template''
+
''Up to three placeholders for parameters of the specified template''}}
}}
+
 
 
 
=== Examples ===
 
=== Examples ===
 
{{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->|
 
{{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->|
Line 152: Line 132:
 
|| {{Tlx|SISTER=W:|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
|}{{-}}
+
|}
----
+
 
 +
<!--- Categories applied to both /doc style Documentation page and to the parent templates --->
 +
[[Category:Templates using ParserFunctions|{{{PAGENAME}}}]]
 +
 
 +
<!-- 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}}]]
 +
[[Category:Templates using ParserFunctions|{{{PAGENAME}}}]]
 +
 
 +
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE -->
 +
[[ko:틀:Tlx]]
 +
[[ru:Template:Tlx]]
 +
</includeonly>

Revision as of 01:10, 23 February 2007

Template:Template doc page viewed directly Template:- Template:Interwikitmp-grp


{{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}{{template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}

Purpose and naming: Mnemonically 'Template list expanded'... after {{tl}} 'Template list'

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

This usage also applies to interwiki capable template variations
  1. {{Tlxc}} -- which links to templates on Wikimedia Commons (The Commons).
  2. {{Tlxm}} -- which links to templates on Meta
  3. {{Tlxw}} -- which links to templates on Wikipedia

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.


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|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 5 parameters, then ...
{{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