Template:Tlxi

From MansunWiki
Jump to: navigation, search

{{Tlxi}}

[view] [edit] [history] [purge] Template-info.svg Template Documentation
This documentation is transcluded from Template:Tlxi/doc. (edit | history)
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.


Usage

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

Examples

{{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:Sister project Var, VAR, VAr, VaR, or var may refer to:

VAR
VaR
Var
var

See also

Template:Disambig 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:Sister project Var, VAR, VAr, VaR, or var may refer to:

VAR
VaR
Var
var

See also

Template:Disambig 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}} (edit · master page).

This template is used to show example template usage without expanding the template itself.

Basic use

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

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

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

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

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

{{tlxTemplate:\sandbox|tlx|Template|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}} produces: {{tlxTemplate:\sandbox|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><code class="nowrap" style=""><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code></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}} 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, {{tlxTemplate:\sandbox|tlx|Welcome|3=subst=Y}} produces: {{tlxTemplate:\sandbox|Welcome|subst=Y}}. This is similar to the action of the {{tlxTemplate:\sandbox|tlxs}} template: {{tlxTemplate:\sandbox|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).

Usage

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

Examples

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.

{{#invoke:aligned table|table}}

Unlimited parameters as one <nowiki>...</nowiki> string
{{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

See also

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

view · talk · edit


General-purpose formatting

Comparison of template-linking templates according to their style
Link style → Linked Unlinked Linked with subst Linked including braces Linked with alternative text
Text style ↓ ↓ {{tlg}} options1 → N/A nolink=yes subst=yes braceinside=yes alttext=Foo
2=Foo
Normal N/A {{tlg}}1, 2
{{tl}}
{{tlp}}2
{{tlu}}4 		{{tlf}}2 {{tls}}
{{tlsp}} 		{{tn}} {{tla}}
Code code=yes or
tt=yes 		{{tlx}}
{{tltt}}
{{tltt2}} 		{{tlc}}2
{{tld}}2
{{tnull}} 		{{tlxs}}
{{tltts}}
{{tltts3}}
{{tltss}}3 		N/A
Bold bold=yes {{tlb}} N/A
Bold code bold=yes|code=yes {{tlxb}}
Italic code italic=yes|code=yes {{tlxi}}
  • 1 {{tlg}} is the most general, allowing any combination of text style and/or link style options.
  • 2 Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  • 3 Uses monospace font but not <code>...</code>.
  • 4 Allows links to templates in any namespace.

Other formatting templates

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
{{xpd|Hatnote|Some hatnote text}} "{{hatnote|[[:Template:Xpd/code]]Template:Void}}" gives "{{#invoke:Hatnote|hatnote}}" [1] Shows code, example and a link to expand the template code
{{para|title|<var>book title</var>}} |title=book title Formats template parameters for display, with or without values

With utility links

Code example Effect
{{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 {{safesubst:#invoke:Toolbar|main}}
{{tiw|Hatnote}} Template:hatnote (backlinks edit)
{{tltt|Hatnote}} {{Hatnote}}
{{tetl|Hatnote}} {{ Hatnote }}
links talk view
{{tsetl|Hatnote}} {{ subst:Hatnote }}
 links talk view
{{ti|Hatnote}} Template:Hatnote (talk<dot-separator>links<dot-separator>edit)
{{tic|Hatnote}} Template:Hatnote (talk links edit)
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} {{Hatnote}} (t/l)
{{twlh|Hatnote}} Template:Hatnote (links, talk)
Retrieved from ‘http://www.mansun.wiki/index.php?title=Template:Tlxi&oldid=2450’