Difference between revisions of "Template:Tlb"
(Import from Wikipedia (CC BY-SA license)) |
(No difference)
|
Latest revision as of 13:27, 1 June 2015
{{Tlb}}
This template uses material from the Wikipedia template Template:Tlb, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors). | Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
Contents
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 and uses Wikipedia's default font instead of a non-proptional, monospaced font, as used by the variant {{tlxb}}
(which is more commonly used because it has that code-style monospaced look). Its main use is in highlighting to distinguish between multiple templates with similar names, on projectpages, in talk page discussions, and for nesting an example of a template-link call inside another template-link call that has already applied the code markup.
Examples
Code | Result | Remark |
---|---|---|
{{tlb|Template name}}
|
{{Template name}} | |
{{tlb|Template name|parm1|parm2}}
|
{{Template name|parm1|parm2}} | |
{{tlb|Template name|parm1|parm2{{=}}foo}}
|
{{Template name|parm1|parm2=foo}} | Equal signs need to be escaped using {{=}} .
|
{{tlb}}
|
{{Tlb}} | 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}}
(edit · master page).
This template uses material from the Wikipedia template Template:Tlb, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors). | Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
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.)
-
{{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 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 "|..."). A keyword parameter can be used with equals code = or {{=}} or in nowiki-text: "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 codenowiki. For example:
- 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.
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 w: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).
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|more}}
{{tlx|Templatename|param=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.
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|...}}
|
up to 10 parameters... |
{{tlx|x5|1|2|3|4|5|6|7|8|9|10|11}}
|
{{x5|1|2|3|4|5|6|7|8|9|10|11}}
|
...| for more |
{{tlx|x1|x=u}}
|
{{x1}}
|
the straightforward equals-sign won't work... |
{{tlx|x1|x=u}}
|
{{x1|x=u}}
|
...but = 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| |two}}
|
{{x2| |two}}
|
...but   is okay |
{{tlx|x2| |two}}
|
{{x2| |two}}
|
... is also okay |
{{tlx|x2|nowiki|two}}
|
{{x2||two}}
|
nowiki handles the space |
{{tlx|x2| | two}}
|
{{x2| | two}}
|
| 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 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.
- {{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=
).
Template-linking templates
General-purpose formatting
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
|
{{tlf}} 2
|
{{tls}} {{tlsp}} {{tlsu}} 3
|
{{tn}}
|
{{tla}}
|
code
|
code=yes
|
{{tl2}} {{tlx}} {{tlxu}} 3
|
{{tlc}} 2{{tld}} 2{{tnull}}
|
{{tlxs}}
|
N/A | |
monospace kbd |
plaincode=yes 4kbd=yes 5
|
{{tltt}} 5{{tltt2}} 5
|
N/A | {{tltts}} 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}} |
{{User:Ahunt/SSHFS}} | Supports linking to any namespace |
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} |
Template:Demo | Shows code and example |
{{xpd|Hatnote|Some hatnote text}} |
"{{hatnote|Some hatnote text}}" gives "Some hatnote text " [1] |
Shows code, example and a link to expand the template code |
{{tln|Hatnote}} |
Template:Tln | Produces a normal link to the template |
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}} |
Template:Elc Template:Elc |
Formats wikilink, with optional piped link text and blended suffix |
{{ml|Example|hello}} |
Template:Ml | Counterpart to {{tl}} for linking to Lua modules |
{{mlx|Example|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. |
{{tag|ref}} {{xtag|templatedata}} |
ref Template:Xtag |
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}} |
Hatnote (edit talk history links /subpages /doc /doc edit /sbox /sbox diff /test) |
{{tfd links|Hatnote}} |
main}} |
{{tltt|Hatnote}} |
{{Hatnote}}
|
{{tetl|Hatnote}} |
{{Hatnote}} |
{{tsetl|Hatnote}} |
{{subst:Hatnote}} |
{{ti|Hatnote}} |
Template:Hatnote (talk • links • edit) |
{{tic|Hatnote}} |
Template:Hatnote (talk links edit) |
{{tim|Hatnote}} |
Template:Tim |
{{tiw|Hatnote}} |
Template:Hatnote (backlinks edit) |
{{tlt|Hatnote}} |
{{Hatnote}} (talk) |
{{ttl|Hatnote}} |
{{Hatnote}} (t/l) |
{{twlh|Hatnote}} |
Template:Hatnote (links, talk) |
The above documentation is transcluded from Template:Tlb/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |