Difference between revisions of "Template:Tlx/doc"

From Slicer Wiki
Jump to: navigation, search
(remove cat)
 
(Created page with '{{documentation subpage}} ==Usage== Code: <pre> * {{tlx|example|parameter1|parameter2...}} * {{tlx|SISTER=W:|example|parameter1|parameter2...}} </pre> Result: * {{tlx|example|pa…')
Line 1: Line 1:
<includeonly><!-----------------Interwiki Doc page pattern------------------->
+
{{documentation subpage}}
<small>''This '{{Tlx|Tlx}}' template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all ''Tlx family templates (Tlx, Tlxc, Tlxm, Tlxw, Tlxb)'' [<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}}
 
{{-}}
 
</noinclude>
 
  
<!-- Parent template(s) usage begins: --->
+
==Usage==
 +
Code:
 +
<pre>
 +
* {{tlx|example|parameter1|parameter2...}}
 +
* {{tlx|SISTER=W:|example|parameter1|parameter2...}}
 +
</pre>
 +
Result:
 +
* {{tlx|example|parameter1|parameter2...}}
 +
* {{tlx|SISTER=W:|example|parameter1|parameter2...}}
  
: {{Tlx|Tlx|Template|first parameter|second|third|...|tenth}} → {{Tlx|Template|first parameter|second|third|...|tenth}}
+
This template creates example usage syntax for a template, and links the name to the template page. The "SISTER" parameter specifies an interwiki prefix to link to another wiki.
: {{Tlx|Tlx|Template|2=first parameter|3=second|4=third|...|11=tenth}} → {{Tlx|Template|first parameter|second|third|...|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)
 
 
 
== Purpose and naming ==
 
[[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: "&lt;nowiki>size=10&lt;/nowiki>" or all parameters as a string in <nowiki>"<nowiki>"</nowiki> 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 {{nobr|<code><nowiki>&lt;code&gt;&lt;nowiki&gt;</nowiki></code>}}, for example: {{nobr|<code><nowiki>&lt;code&gt;&lt;nowiki&gt;{{Anytemplate|arg1=23|size=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 {{nobr|<code><nowiki><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}} [[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}})
 
 
 
* 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}}.
 
 
 
* 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.
 
 
 
== Documentation ==
 
 
 
{&#123;[[Template:{{BASEPAGENAME}}|{{BASEPAGENAME}}]]&#125;}
 
is a generalization of {{Tl|Tl|x}}, {{Tl|Tlp|x|y}},
 
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 ===
 
 
 
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name&#125;}</tt>
 
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name{{!}}param&#125;}</tt>
 
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&#125;}</tt>
 
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3{{!}}4{{!}}5{{!}}6{{!}}7{{!}}8{{!}}9{{!}}10&amp;#124;more&#125;}</tt>
 
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name{{!}}param&amp;#61;value&#125;}</tt>
 
''Up to 10 placeholders for parameters of the specified template''
 
 
 
=== Examples ===
 
{{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->|
 
{{#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 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.
 
}}}}
 
  
 +
===Examples===
 
{| border="1" cellpadding="4" class="wikitable"
 
{| border="1" cellpadding="4" class="wikitable"
 
! Code
 
! Code
Line 60: Line 19:
 
! Remark
 
! Remark
 
|-
 
|-
|{{Tlx|Tlx|x0}}
+
|{{Tlx|SISTER=W:|Tlx|x0}}
|{{Tlx|x0}}
+
|{{Tlx|SISTER=W:|x0}}
||&#160;
 
|-
 
|{{Tlx|Tlx|Abc}}
 
|{{Tlx|Abc}}
 
 
||&#160;
 
||&#160;
 
|-
 
|-
|{{Tlx|Tlx|ABC}}
+
|{{Tlx|SISTER=W:|Tlx|x1|one}}
|{{Tlx|ABC}}
+
|{{Tlx|SISTER=W:|x1|one}}
 
||&#160;
 
||&#160;
 
|-
 
|-
|{{Tlx|Tlx|AbC}}
+
|{{Tlx|SISTER=W:|Tlx|x2|one|two}}
|{{Tlx|AbC}}
+
|{{Tlx|SISTER=W:|x2|one|two}}
 
||&#160;
 
||&#160;
 
|-
 
|-
|{{Tlx|Tlx|x1|one}}
+
|{{Tlx|SISTER=W:|Tlx|x3|1<tt>&#124;</tt>2<tt>&#124;</tt>3}}
|{{Tlx|x1|one}}
+
|{{Tlx|SISTER=W:|x3|1|2|3}}
 
||&#160;
 
||&#160;
 
|-
 
|-
|{{Tlx|Tlx|x2|one|two}}
+
|{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3|4}}
|{{Tlx|x2|one|two}}
+
|{{Tlx|SISTER=W:|x4|1|2|3|4}}
||&#160;
+
|up to 7 parameters, then ...
 
|-
 
|-
|{{Tlx|Tlx|x3|1|2|3|4|5|6|7|8|9&#124;10}}
+
|{{Tlx|SISTER=W:|Tlx|x4|1<tt>&#124;</tt>2<tt>&#124;</tt>3&amp;#124;4}}
|{{Tlx|x3|1|2|3|4|5|6|7|8|9|10}}
+
|{{Tlx|SISTER=W:|x4|1|2|3&#124;4}}
||&#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
 
|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
 
|'''=''' 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|x<nowiki>{{=}}</nowiki>u}}
+
|{{Tlx|SISTER=W:|Tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
|{{Tlx|x1|x{{=}}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
 
|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
 
|}
 
|}
  
== See also ==
+
==Technical documentation==
* [[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.
+
===Naming===
* [[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>.
+
The name is derived from "'''T'''emplate '''l'''ist e'''x'''panded".
* [[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 --->
+
===Behaviour===
 +
* Up to 7 pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "<tt>|</tt>''...''", for details see the [[w:Talk:Tlx/doc|the Wikipedia talk page]].
 +
 +
* If given no additional parameters except ''<code>'template name' (<nowiki>{{{1}}}</nowiki>),</code>'' it displays a simple link wrapped in braces (similar to {{[[template:tl|tl]]}}).
  
<includeonly>
+
<!-- template categories and interwiki links -->
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE -->
+
<includeonly>
[[Category:Typing-aid templates |{{PAGENAME}}]]  
+
[[Category:Typing-aid templates|Tlx]]  
[[Category:Internal link templates |{{PAGENAME}}]]
+
[[Category:Internal link templates|Tlx]]
[[Category:Interwiki link templates |{{PAGENAME}}]]
+
[[Category:Interwiki link templates|Tlx]]
  
<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE -->
+
[[en:Template:Tlx]]
[[cy:Nodyn:Tlx]]
 
[[de:Vorlage:Vorlage]]
 
[[fr:Modèle:Lmp]]
 
[[fa:الگو:الگوب]]
 
[[hsb:Předłoha:Tlx]]
 
[[hy:Կաղապար:Tlx]]
 
 
[[ko:틀:Tlx]]
 
[[ko:틀:Tlx]]
[[ia:Patrono:Tlx]]
 
[[os:Шаблон:Tlp]]
 
[[mk:Шаблон:Швп]]
 
[[ja:Template:Tlx]]
 
[[no:Mal:Tlx]]
 
[[pt:Predefinição:Tlx]]
 
[[ro:Format:Tlx]]
 
 
[[ru:Template:Tlx]]
 
[[ru:Template:Tlx]]
[[simple:Template:Tlx]]
 
[[sr:Šablon:Tlx]]
 
[[th:แม่แบบ:Tlx]]
 
[[tl:Suleras:Tlx]]
 
[[uk:Шаблон:Tlx]]
 
[[ur:سانچہ:Tlx]]
 
[[zh:Template:Tlx]]
 
 
</includeonly>
 
</includeonly>

Revision as of 20:55, 21 October 2011

Home < Template:Tlx < doc

Usage

Code:

* {{tlx|example|parameter1|parameter2...}}
* {{tlx|SISTER=W:|example|parameter1|parameter2...}}

Result:

  • {{example|parameter1|parameter2...}}
  • {{example|parameter1|parameter2...}}

This template creates example usage syntax for a template, and links the name to the template page. The "SISTER" parameter specifies an interwiki prefix to link to another wiki.

Examples

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

Technical documentation

Naming

The name is derived from "Template list expanded".

Behaviour

  • Up to 7 pass parameters (numbered) for the specified template are displayed as 'placeholders', and more parameters are shown as "|...", for details see the the Wikipedia talk page.
  • If given no additional parameters except 'template name' ({{{1}}}), it displays a simple link wrapped in braces (similar to {{tl}}).