One of a series of test instances for migrating the Koha Wiki MediaWiki database.
For the current Koha Wiki, visit https://wiki.koha-community.org .Template:Template link general
{{Template:Template link general}}
Lua error in Module:Lua_banner at line 113: attempt to index field 'edit' (a nil value).
{{tlg}} (abbreviating "[t]emplate [l]ink (with) [g]eneral (options)") is a generalised version of the {{tl}} ("template link") template. It can be used to replace or implement {{tl}} and related templates such as {{tlb}}, {{tlx}}, etc.
Parameters
Named
With the exception of alttext, {{tlg}}'s named parameters are toggles that are either omitted (default) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below):
| Parameter | Action | As in |
|---|---|---|
| brace | Include braces as part of the template link | |
| braceinside | Include innermost braces as part of the template link | {{tlw}} |
| bold boldlink boldname |
Renders the template link/name in bold | {{tlb}}, {{tlx}}, etc. |
| code | Display output using HTML <code>...</code> tags (monospaced font) |
{{tlc}}, {{tlx}}, etc. |
| plaincode | Uses <code style="border:none; background:transparent;">...</code> |
|
| kbd | Display output using HTML <kbd>...</kbd> tags (monospaced font) |
{{tltt}}, {{tltt2}}, etc. |
| italic italics |
Display any parameters accompanying the template link/name in italic/s | {{tlxi}} |
| nolink | Don't render the template name as a link | {{tlf}} |
| nowrap | Prevent the insertion of line breaks (word wrap) in the output | {{tlp}}, {{tlf}}, etc. |
| nowrapname | Prevent word wrapping in the output of template name/link (parameters will wrap if needed) | |
| subst | Include a subst: prefix before the template link/name | {{tls}} |
| |alttext=[text] | Use [text] as the label for the template link | {{tla}} |
Unnamed (Positional)
{{tlg}} may take up to ten unnamed parameters as parameters accompanying the template link (or name); see Examples below.
Examples
- Note
- On the source sister projects, en.wikipedia and Meta, 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 | Output | Remarks |
| {{tlg|Termometro}} | {{Termometro}} | Termometro template does not exist. Be aware with linking to non-existing templates, although desired. |
| {{tlg|ok}} | {{ok}} | ok template does exist |
| {{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | {{convert|14|m|ftin|abbr=out|sp=us}} | Unlimited parameters as one <nowiki>...</nowiki> string |
| {{tlg|Abc}} | {{Abc}} | |
| {{tlg|abC}} | {{abC}} | template names are case-sensitive |
| {{tlg|abc}} | {{abc}} | first letter is case-insensitive though |
| {{tlg|abc|{{spaces}}{{{1}}}{{spaces}}}} | {{abc| {{{1}}} }} | Using {{spaces}} before and after {{{1}}} parameter. |
| {{tlg|x0}} | {{x0}} | |
| {{tlg|x0|code=on}} | {{x0}} | <code> style |
| {{tlg|x0|plaincode=on}} | {{x0}} | plaincode style |
| {{tlg|x0|kbd=on}} | {{x0}} | <kbd> style |
| {{tlg|x0|bold=on}} | {{x0}} | bold link/name |
| {{tlg|x1|one|italic=on}} | {{x1|one}} | parameter/s in italics |
| {{tlg|x0|nolink=on}} | {{x0}} | |
| {{tlg|x0|subst=on}} | {{subst:x0}} | |
| {{tlg|x0|brace=on}} | {{x0}} | all braces in link |
| {{tlg|x0|braceinside=on}} | {{x0}} | inside braces in link |
| {{tlg|x0|alttext=x0 link}} | {{x0 link}} | |
| {{tlg|x0|bold=on|code=on|brace=on}} | {{x0}} | No reason you can't combine multiple parameter settings |
| {{tlg|x1|one}} | {{x1|one}} | |
| {{tlg|x2|one|two}} | {{x2|one|two}} | |
| {{tlg|x2|bold=on|code=on|one|two}} | {{x2|one|two}} | Can combine named and anonymous parameters … |
| {{tlg|x2|one|two|bold=on|code=on}} | {{x2|one|two}} | … in any order … |
| {{tlg|x2|one|code=on|two|bold=on|three}} | {{x2|one|two|three}} | … even intermixed … |
| {{tlg|x2|one|code=on|two|bold=on|three|italic=on}} | {{x2|one|two|three}} | … with many different configurations. |
| {{tlg|x3|1|2|3|4|5|6|7|8|9|10}} | {{x3|1|2|3|4|5|6|7|8|9|10}} | |
| {{tlg|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, then … |
| {{tlg|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 |
| {{tlg}} | {{Template:Template link general}} | with no arguments, the current page name is substituted |
| {{tlg|x1|x=u}} | {{x1}} | = won't work |
| {{tlg|x1|x=u}} | {{x1|x=u}} | = is okay |
| {{tlg|x1|x{{=}}u}} | {{x1|x=u}} | {{=}} is okay (see template equal sign) |
| {{tlg|x1|x<nowiki>=</nowiki>u}} | {{x1|x=u}} | sticky nowiki is okay |
| {{tlg|x2||two||}} | {{x2||two||}} | empty parameters work too, even at the end |
| {{tlg|x2|3=two|2=one}} | {{x2|one|two}} | right to left okay |
| Code | Output |
|---|---|
| {{tlg|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} | {{long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} |
| Code | Output |
|---|---|
| {{tlg|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} | {{long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
| Code | Output |
|---|---|
| {{tlg|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} | {{long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
See also
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=Foo2=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=yes4kbd=yes5
|
{{tltt}}5 {{tltt2}}5 |
N/A | {{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}} | Template:Tl2 | 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>}} | lang=fr|Some text}} |
Shows code and example |
| {{xpd|Hatnote|Some hatnote text}} | Template:Xpd | 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}} | [[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}} | Template:Dtl | Wikidata counterpart to {{tl}} |
| {{pf|if}} {{pf|if|{{{1}}}|true|false}} |
Template:Pf Template:Pf |
Parser function equivalent to {{tl}} |
With utility links
| Code example | Effect |
|---|---|
| {{lt|Hatnote}} | Template:Lt |
| {{lts|Hatnote}} | Template:Lts |
| {{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) |
| {{tltt|Hatnote}} | Template:Tltt |
| {{tetl|Hatnote}} | {{Hatnote}} |
| {{tsetl|Hatnote}} | {{subst:Hatnote}} |
| {{ti|Hatnote}} | Template:Ti |
| {{tic|Hatnote}} | Template:Tic |
| {{tim|Hatnote}} | m:Template:Hatnote (backlinks edit) |
| {{tiw|Hatnote}} | Template:Hatnote (backlinks edit) |
| {{tlt|Hatnote}} | Template:Tlt |
| {{ttl|Hatnote}} | {{Hatnote}} (t/l) |
| {{twlh|Hatnote}} | Template:Twlh |
| The above documentation is transcluded from Template:Template link general/doc. (edit | history) Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages. Please add categories to the /doc subpage. Subpages of this template. |