మూస:Tlxi/doc

వికీపీడియా నుండి
Jump to navigation Jump to search


This template is a {{tl}}-style template-link tag that accepts and italicizes parameters. It's the same as {{tlx}} except that the template parameters are shown in italics. It's main use is in template documentation, to give example input where the parameters are unnamed sequential ones and we're showing variable, sample input. It really should mark up the parameter with ‎<var>...‎</var>, not just typographic italics, but the underlying Template:Tlg doesn't have an option to execute that markup (yet).

{{Tlxi|Template|first parameter|second|third|...|eleventh}}{{Template|first parameter|second|third|...|eleventh}}
{{Tlxi|Template|2=first parameter|3=second|4=third|...|12=eleventh}}{{Template|first parameter|second|third|...}} if they might contain "=" signs (note the off-by-one notation – parameter 1 remains the name of the template)
{{Tlxi|Template|<nowiki>first|second|...|999th</nowiki>}}{{Template|first|second|...|999th}} (for more than 10 parameters)

If Template is to be passed more than nine parameters (using up to the tenth of {{Tlxi}}'s own parameters), the remaining parameters have to be baked into the actual eleventh parameter of {{Tlxi}}:

{{Tlxi|Template|first parameter|second|third|fourth|fifth|sixth|seventh|eighth|ninth|<nowiki>tenth|eleventh|twelfth|thirteenth|...</nowiki>}}
or
{{Tlxi|Template|first parameter|second|third|fourth|fifth|sixth|seventh|eighth|ninth|tenth{{!}}eleventh{{!}}twelfth{{!}}thirteenth{{!}}...}}
or
{{Tlxi|Template|2=first parameter|3=second|4=third|5=fourth|6=fifth|7=sixth|8=seventh|9=eighth|10=ninth|11=<nowiki>tenth|eleventh|twelfth|thirteenth|...</nowiki>}}
{{Template|first parameter|second|third|fourth|fifth|sixth|seventh|eighth|ninth|tenth|eleventh|twelfth|thirteenth|...}}

If a twelfth parameter is passed to {{Tlxi}} (i.e., an 11th to the Template it calls in parameter 1), that parameter's value will be output as "…" and subsequent parameters ignored.

The rest of the documentation is for {{tlx}}, which works the same way.


Note: This documentation for {{tlx}} is also transcluded by its derivatives {{tlxb}}, {{tlxc}}, {{tlxw}}, {{tlxU}} (edit · master page).


(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)

{{tlx|Template|first parameter|second parameter|third|…|tenth}} produces: {{Template|first parameter|second parameter|third|…|tenth}}

Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{=}}:

{{tlx|Template|first{{=}}something|second|third{{=}}something|...|tenth}} produces: {{Template|first=something|second|third=something|...|tenth}}

For more than ten parameters, possibly also containing equals-signs, use ‎<nowiki>...‎</nowiki> thus:

{{tlx|Template|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}} produces: {{Template|first|second|third=something|...|999th}}

Purpose and naming

[మార్చు]

Mnemonically, "[t]emplate [l]ink e[x]panded" (after {{tl}}, "[t]emplate [l]ink").

This template allows an example of calling a template, accompanied by one or more parameters, to be displayed without also causing the template to be called.

Up to ten of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than 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>.

Parameters

[మార్చు]
  • If the only parameter supplied is {{{1}}}, i.e. a template's name, {{tlx}}'s output is the same as {{tl}} – i.e. a link within braces – but in a monospaced font:
    • {{tl|tl}} produces: {{tl}}
    • {{tlx|tl}} produces: {{tl}}
{{tl}} will also not take nor display additional parameters.
Named parameters

|subst=

Setting this parameter to any non-blank value will prefix the string subst: linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example, {{tlx|Welcome|subst=Y}} produces: {{subst:Welcome}}. This is similar to the action of the {{tlxs}} template: {{tlxs|Welcome}} produces: {{subst:Welcome}}.

|SISTER=

For an interwiki link to other sister projects, such as: |SISTER=M: (Meta), |SISTER=Q: (WikiQuote), |SISTER=S: (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

|LANG=

For a link to Wikipedias in other languages, such as: |LANG=de: (German), |LANG=sv: (Swedish), etc, facilitating cross-language template documentation and/or discussion.

Documentation

[మార్చు]

{{Tlx}} is a generalization of {{tl}}, {{tlp}} etc, with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "{ ", "| ", "} " and links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}, see {{tlw}}, which makes the click target bigger).

{{tlx|Templatename}}
{{tlx|Templatename|param}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10&#124;more}}
{{tlx|Templatename|param&#61;value}}

There are up to 10 placeholders for parameters of the specified template.

Note
At the en.wikipedia and Meta sites, 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 Remarks
{{tlx|x0}} {{x0}}  
{{tlx|Abc}} {{Abc}}  
{{tlx|ABC}} {{ABC}}  
{{tlx|AbC}} {{AbC}}  
{{tlx|x1|one}} {{x1|one}}  
{{tlx|x2|one|two}} {{x2|one|two}}  
{{tlx|x3|1|2|3|4|5|6|7|8|9|10}} {{x3|1|2|3|4|5|6|7|8|9|10}}  
{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} {{x4|1|2|3|4|5|6|7|8|9|10|11}} up to 10 parameters...
{{tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} {{x5|1|2|3|4|5|6|7|8|9|10|11}}
...&#124; for more
{{tlx|x1|x=u}} {{x1}} the straightforward equals-sign won't work...
{{tlx|x1|x&#61;u}} {{x1|x=u}}
...but &#61; is okay
{{tlx|x1|x{{=}}u}} {{x1|x=u}}
...and {{=}} is okay
{{tlx|x1|<nowiki>x=u</nowiki>}} {{x1|x=u}}
sticky nowiki also okay
{{tlx|x2| |two}} {{x2|two}} empty won't work...
{{tlx|x2|&#32;|two}} {{x2| |two}}
...but &#32; is okay
{{tlx|x2|&nbsp;|two}} {{x2| |two}}
...&nbsp; is also okay
{{tlx|x2|‎<nowiki />|two}} {{x2||two}}
‎<nowiki /> handles the space
{{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" overrides "2=one"
{{tlx|x2|3=two|2=one}} {{x2|one|two}}
irregular parameter order is okay
Unlimited parameters as one ‎<nowiki>...‎</nowiki> string
{{tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}
  • {{tlxb}}, a version of {{tlx}} where the template name is shown in bold.
    {{tlb}}, a version of {{tl}} where the template name is shown in bold.
  • {{tlxplain}} (tlxpl), a version of {{tlx}} with plainer <code> styling.
  • {{temt}}, a version of {{tlx}} that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
  • {{para}}, for the presentation of template parameters and values (e.g. |paraname=val, |another=, etc).

Template-linking templates

[మార్చు]

General-purpose formatting

[మార్చు]
Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ {{tlg}} options[note 1]
to achieve text style
Link style
Linked Unlinked Linked with subst Linked including braces Linked with alternative text
{{tlg}} options[note 1]
to achieve link style
DEFAULT nolink=yes subst=yes braceinside=yes alttext=Foo
2=Foo
normal DEFAULT {{tlg}}[note 1]
{{tl}}
{{tlp|1|2|...}}[note 2]
{{Template:tlu}}[note 3]
{{tlf}}[note 2]
<template link>
{{subst:tls}}
{{subst:Template:tlsu}}[note 3]
{{tn}} {{tla}}
code code=yes {{tl2}}
{{tlx}}
{{Template:tlxu}}3[note 3]
{{tlc}}[note 2]
<template link>
{{tnull}}<template link>
{{subst:tlxs}}
monospace plaincode=yes[note 4] {{subst:tltss}}[note 5]
kbd kbd=yes[note 5]
bold bold=yes {{tlb}}
bold+code bold=yes|code=yes {{tlxb}}
italic+code italic=yes|code=yes {{tlxi}}
  1. 1.0 1.1 1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. 2.0 2.1 2.2 Prevents wrapping of text by placing it inside ‎<span class="nowrap">...‎</span> tags.
  3. 3.0 3.1 3.2 Allows links to templates in any namespace.
  4. {{tlg|plaincode=yes}} uses ‎<code style="border:none; background-color:transparent;">...‎</code>.
  5. 5.0 5.1 Displays monospaced font using ‎<span style="font-family:monospace;">...‎</span>.

Other formatting templates

[మార్చు]
Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{tl2|Hatnote|lang=fr}} {{hatnote}} Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}} {{User:Ahunt/SSHFS}} Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}
{{hatnote|lang=fr|Some text}}
Shows code and example
{{xpd|Hatnote|Some hatnote text}} "{{hatnote|Some hatnote text}}" gives "" [1] Shows code, example and a link to expand the template code
{{tln|Hatnote}} Template:Hatnote Produces a normal link to the template
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}}
[[Template:Hatnote]]
[[Template:Hatnote|Hatnote]]
Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tlx}} for linking to Lua modules
{{para|title|<var>book title</var>}} |title=book title Formats template parameters for display, with or without values
{{sclx|LASTING}} [[WP:LASTING]] Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a ‎<code>...‎</code> tag.
{{tag|ref}}
{{xtag|templatedata}}
‎<ref>...‎</ref>
<templatedata>
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}} {{d:Ping project}} Wikidata counterpart to {{tl}}
{{pf|if}}
{{pf|if|{{{1}}}|true|false}}
{{#if}}
{{#if:{{{1}}}|true|false}}
Parser function equivalent to {{tl}}
[మార్చు]
Templates producing utility links for a given template (Hatnote used here as example)
Code example Effect
{{lt|Hatnote}} Template:Hatnote (edit | talk | history | links | watch | logs)
{{lts|Hatnote}} Template:Hatnote(edit talk links history)
{{t links|Hatnote}} Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{tfd links|Hatnote}} Template:Hatnote (edit · talk · history · links · transclusions · logs · subpages · delete)
{{tetl|Hatnote}} {{Hatnote}}
links talk view
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk view
{{ti|Hatnote}} Template:Hatnote (talk · links · edit)
{{tic|Hatnote}} Template:Hatnote (talk links edit)
{{tim|Hatnote}} m:Template:Hatnote (backlinks edit)
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} {{Hatnote}} (t/l)
{{twlh|Hatnote}} Template:Hatnote (links, talk)



"https://te.wikipedia.org/w/index.php?title=మూస:Tlxi/doc&oldid=1376646" నుండి వెలికితీశారు