Template:Tlxb/doc

From TechInfoDepot
Jump to navigationJump to search


Usage

This template is a {{tl}}-style template-link tag that boldfaces the template name, and accepts parameters. It's the same as {{tlx}} except that it boldfaces the name of the template (or you can think of it as the same as {{tlb}} except that it uses <code>…</code> to provide a non-proportional, monospaced font instead of normal text). Its main use is in highlighting to distinguish between multiple templates with similar names, in documentation, talk page discussions, etc.

Examples

Code Result Remark
{{tlxb|Template name}} {{Template name}}
{{tlxb|Template name|parameter1|parameter2}} {{Template name|parameter1|parameter2}}
{{tlxb|Template name|parm1|parm2{{=}}foo}} {{Template name|parm1|parm2=foo}} Equal signs need to be escaped using {{=}}.
{{tlxb}} {{Tlxb/doc}} This actually substitutes the current page name. Useful as a self-reference; won't be linked.

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


Basic use

(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 Template:Tcpl:

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

{{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: Template:Tlxs.

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

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

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.
  • {{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 their style
Link style → Linked Unlinked Linked with subst Linked including braces Linked with alternative text
Text style ↓ ↓ {{tlg}} options1 → DEFAULT nolink=yes subst=yes braceinside=yes alttext=Foo
2=Foo
normal DEFAULT {{tlg}}1
{{tl}}
{{tlp}}2
{{tlu}}3
{{tln}} 		{{tlf}}2 {{tls}}
{{tlsp}} 		{{tn}} {{tla}}
code code=yes {{tl2}}
{{tlx}}
{{tlxu}}3 		{{tlc}}2
{{tld}}2
{{tnull}} 		{{tlxs}} N/A
monospace
kbd 		plaincode=yes4
kbd=yes5 		{{tltt}}5
{{tltt2}}5 		N/A {{tltts}}5
{{tltts3}}5
{{tltss}}6
bold bold=yes {{tlb}} N/A
bold+code bold=yes|code=yes {{tlxb}}
italic+code italic=yes|code=yes {{tlxi}}

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}} Template:Tlu Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} Template:Demo Shows code and example
{{xpd|Hatnote|Some hatnote text}} Template:Xpd Shows code, example and a link to expand the template code
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}}		 Template:Elc
Template:Elc		 Formats wikilink, with optional piped link text and blended suffix
{{mlx|Bananas|hello}} Template:Mlx 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}} Template:Sclx 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}} Template:Dtl Wikidata counterpart to {{tl}}

With utility links

Code example Effect
{{lt|Hatnote}} Template:Lt
{{lts|Hatnote}} Template:Hatnote (edit talk links history)
{{t links|Hatnote}} Template:T links
{{tfd links|Hatnote}} Template:Tfd links
{{tiw|Hatnote}} Template:hatnote (backlinks edit)
{{tltt|Hatnote}} Template:Tltt
{{tetl|Hatnote}} Template:Tetl
{{tsetl|Hatnote}} Template:Tsetl
{{ti|Hatnote}} {{Hatnote}}
{{tic|Hatnote}} Template:Tic
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} Template:Tlt
{{ttl|Hatnote}} Template:Ttl
{{twlh|Hatnote}} Template:Twlh



Retrieved from "https://techinfodepot.shoutwiki.com/w/index.php?title=Template:Tlxb/doc&oldid=109343"