On November 27th, 2022, the 8,000th article was added to the SuccuWiki!

Template:Tlx/doc: Difference between revisions

From SuccuWiki - The Wiki of the Succubi
Jump to navigation Jump to search
Line 53: Line 53:
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name{{!}}param&amp;#61;value&#125;}</tt>
:<tt>{&#123;{{BASEPAGENAME}}{{!}}template name{{!}}param&amp;#61;value&#125;}</tt>
''Up to 10 placeholders for parameters of the specified template''
''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.
}}}}
{| border="1" cellpadding="4" class="wikitable"
! Code
! Result
! Remark
|-
|{{Tlx|Tlx|x0}}
|{{Tlx|x0}}
||&#160;
|-
|{{Tlx|Tlx|Abc}}
|{{Tlx|Abc}}
||&#160;
|-
|{{Tlx|Tlx|ABC}}
|{{Tlx|ABC}}
||&#160;
|-
|{{Tlx|Tlx|AbC}}
|{{Tlx|AbC}}
||&#160;
|-
|{{Tlx|Tlx|x1|one}}
|{{Tlx|x1|one}}
||&#160;
|-
|{{Tlx|Tlx|x2|one|two}}
|{{Tlx|x2|one|two}}
||&#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>}}
|unlimited parameters as one nowiki string
|-
|{{Tlx|Tlx|x1|x&#61;u}}
|{{Tlx|x1|x=u}}
|'''=''' won't work
|-
|{{Tlx|Tlx|x1|x&amp;#61;u}}
|{{Tlx|x1|x&#61;u}}
|align="right"|<tt>&amp;#61;</tt> is okay
|-
|{{Tlx|Tlx|x1|x<nowiki>{{=}}</nowiki>u}}
|{{Tlx|x1|x{{=}}u}}
|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|Tlx|x2|&#160;|two}}
|{{Tlx|x2| |two}}
|empty won't work
|-
|{{Tlx|Tlx|x2|&amp;#32;|two}}
|{{Tlx|x2|&#32;|two}}
|align="right"|<tt>&amp;#32;</tt> is okay
|-
|{{Tlx|Tlx|x2|&amp;nbsp;|two}}
|{{Tlx|x2|&nbsp;|two}}
|align="right"|<tt>&amp;nbsp;</tt> is okay
|-
|{{Tlx|Tlx|x2| &amp;#124; two}}
|{{Tlx|x2| &#124; two}}
|align="right"|<tt>&amp;#124;</tt> is okay
|-
|| {{Tlx|Tlx|x2| {&#123;!&#125;} two}}
|| {{Tlx|x2| {{!}} two}}
|align="right"|{{Tlx|!}} is dubious
|-
|| {{Tlx|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}}
|| {{Tlx|x2|2=|3=two}}
|empty really doesn't work
|-
|| {{Tlx|Tlx|x2|<nowiki>2=one</nowiki>|two}}
|| {{Tlx|x2|2=one|two}}
|'''two''' clobbers '''2=one'''
|-
|| {{Tlx|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
|| {{Tlx|x2|3=two|2=one}}
|align="right"|right to left okay
|}


== See also ==
== See also ==

Revision as of 08:52, 1 July 2013



Basically:

{{Tlx|Template|first parameter|second|third|...|tenth}}{{Template|first parameter|second|third|...|tenth}}

Where parameters might contain "=" characters, use {{=}} instead

{{Tlx|Template|first parameter{{=}}anything|second|third{{=}}something|...|tenth}}{{Template|first parameter=anything|second|third=something|...|tenth}}

For more than 10 parameters, possibly also containing "=", use

{{Tlx|Template|<nowiki>first|second|third=something|...|999th</nowiki>}}{{Template|first|second|third=something|...|999th}}

The three dots in the examples represent a number of arguments that have been omitted and are not an actual argument.

Purpose and naming

Mnemonically 'Template link expanded'. After {{Tl}} 'Template link'.

  • This template takes another template-name and some associated pipe-tricked (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 "&#124;..."). A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in "<nowiki>" tags; see Examples at bottom. For more details, see 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 <code><nowiki>, for example: <code><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</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 <pre>...</pre>.

  • 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: {{Tl}} versus Tlx: {{Tl}})
  • Comparatively, {{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}} 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. This is useful to indicate when a template should be substituted. For example {{Tlx|Welcome|subst=Y}} will display {{subst:Welcome}}.
  • 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

{{Tlx}} is a generalization of {{Tl}}, {{Tlp}}, 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|template name}}
{{Tlx|template name|param}}
{{Tlx|template name|1|2|3|4|5|6|7|8|9|10}}
{{Tlx|template name|1|2|3|4|5|6|7|8|9|10&#124;more}}
{{Tlx|template name|param&#61;value}}

Up to 10 placeholders for parameters of the specified template

See also

  • Template:Tlxb – same as {{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.
  • Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.

{{Template linking templates}}