Template:Tlb

From Wikisource
Jump to: navigation, search
Documentation icon Template documentation[view] [edit] [history] [purge]


Usage[edit]

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[edit]

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


This '{{tlx}}' template documentation is transcluded for all Tlx family templates (Tlx, Tlxc, Tlxw, Tlxb) [edit].Masterpage  


{{tlx|Template|first parameter|second|third|...|tenth}}{{template|first parameter|second|third|...|tenth}}
{{tlx|first parameter|...|third|tenth}}{{template|first parameter|second|third|...|tenth}} if they might contain "=" signs.
{{tlx|Template|<nowiki>first|second|...|999th</nowiki>}}{{template|first|second|...|999th}} (for more than 10 parameters)

Purpose and naming[edit]

Mnemonically 'Template link expanded'. After {{tl}} 'Template link'.

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" 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[edit]

  • 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 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[edit]

{{Tlb}} 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[edit]

{{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[edit]

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&#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 string
{{tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

See also[edit]

  • {{tl}} for template statements
  • {{tls}} for template statements requiring substitution
  • 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:Temt, – same as {{Tlx}}, but handles template names with the Template: prefix and templates not in the Template: namespace {{ns:10}}.
  • Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.

General-purpose formatting[edit]

  • 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 tags.
  • 3 Uses monospace font but not code.
  • 4 Allows links to templates in any namespace.