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
mNo edit summary
mNo edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
<includeonly><!-----------------Interwiki Doc page pattern------------------->
<includeonly><!-----------------Interwiki Doc page pattern------------------->
<small>''This '{{Tlx|Tlx}}' template documentation is transcluded for all ''Tlx family templates (Tlx, Tlxc, Tlxw, Tlxb)'' [<span class="plainlinks">[{{fullurl:Template:Tlx/doc |action=edit}} edit]</span>].</small></includeonly><noinclude>  
<small>''This '{{Tlx|Tlx}}' template documentation is 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]]
&nbsp;}}</small></includeonly><noinclude>  
{{Documentation subpage}}
{{Documentation subpage}}
{{-}}
{{-}}
Line 7: Line 8:
<!-- Parent template(s) usage begins: --->
<!-- Parent template(s) usage begins: --->


Basically:
: {{Tlx|Tlx|Template|first parameter|second|third|...|tenth}} → {{Tlx|Template|first parameter|second|third|...|tenth}}
: {{Tlx|Tlx|Template|first parameter|second|third|...|tenth}} → {{Tlx|Template|first parameter|second|third|...|tenth}}
: {{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.
Where parameters might contain "=" characters, use {{Tlx|{{=}}}} instead
: {{Tlx|Tlx|Template|&lt;nowiki>first|second|...|999th&lt;/nowiki>}} → {{Tlx|Template|<nowiki>first|second|...|999th</nowiki>}} (for more than 10 parameters)
: {{Tlx|Tlx|Template|<nowiki>first parameter{{=}}anything|second|third{{=}}something|...|tenth</nowiki>}} → {{Tlx|Template|first parameter{{=}}anything|second|third{{=}}something|...|tenth}}
For more than 10 parameters, possibly also containing "=", use
: {{Tlx|Tlx|Template|&lt;nowiki><nowiki>first|second|third=something|...|999th</nowiki>&lt;/nowiki>}} → {{Tlx|Template|<nowiki>first|second|third=something|...|999th</nowiki>}}


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


== Purpose and naming ==
== Purpose and naming ==
[[Wikt:mnemonic|Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'. After <tt>{{tlx|Tl}}</tt> ''''T'''emplate '''l'''ink'.
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 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.
* 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 "<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.
* '''''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 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}}.
* '''''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}}.


Line 29: Line 32:
* 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.
* 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 Substitution. This is useful to indicate when a template should be substituted. For example {{tlx|Tlx|Welcome|<nowiki>subst=Y</nowiki>}}.
* {{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. This is useful to indicate when a template should be substituted.


* 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.
* 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.
Line 50: 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''
== See also ==
* [[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.
* [[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 --->
<!--- Categories applied to both /doc style Documentation page and to the parent templates --->
Line 61: Line 69:
[[Category:Interwiki link templates |{{PAGENAME}}]]
[[Category:Interwiki link templates |{{PAGENAME}}]]


<!-- EDIT/ADD TEMPLATE Interwiki's BELOW THIS LINE -->
</includeonly>
<includeonly>
</includeonly>
</includeonly>

Latest revision as of 08:59, 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.
  • 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}}