Template:Tl2/doc

From Daedalus Dock
Jump to navigation Jump to search

This is the {{tl2}} template.

{{tl2}} is similar to {{tl}}. Tl stands for Template link. {{tl2}} is a macro template used to display a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation.

{{tl2}} differs from {{tl}} in that it displays with a wider, monospaced text style (like {{tlx}}) and also takes the named parameters |sister= and |lang= so that it may also be used to list and link templates on other English and non-English-language sister projects.

Related template

{{tlx}} displays with the same enhanced presentation and can also expand several placeholder parameters to generate a sample template call.

Usage

{{tl2|template_name}}
equivalent to {{tl|template_name}}
{{tl2 |sister=sister_id |template_name}}
to display a template from a sister project (e.g. {{tl2 |sister=V |template_name}} for Wikiversity)
{{tl2 |lang=lang_id |sister=sister_id |template_name}}
to display a template from a sister project in another language (e.g. {{tl2 |lang=fr |sister=V |template_name}} for a template from the French Wikisource project)

Examples

Code Result
{{tl|x0}} {{x0}}
{{tl2|x1}} {{x1}}
{{tl2|sister=M|3x}} {{3x}}
{{tl2|sister=wikibooks|lang=de|WP}} {{WP}}

See also

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ {{tlg}} optionsTemplate:NoteTag
to achieve text style
Link style
Linked Unlinked Linked with subst Unlinked with subst Linked including braces Linked with alternative text
{{tlg}} optionsTemplate:NoteTag
to achieve link style
Template:N/a Template:N/a nolink=yes subst=yes nolink=yes|subst=yes braceinside=yes alttext=Foo
2=Foo
normal Template:N/a {{tlg}}Template:NoteTag
{{tl}}
Template:TlpTemplate:NoteTag
Template:TluTemplate:NoteTag
{{tlf}}Template:NoteTag
<template link>
{{subst:tls}}
Template:TlsuTemplate:NoteTag
Template:TlsfTemplate:NoteTag
<template link>
Template:Tn {{tla}}
code code=yes {{tl2}}
{{tlx}}
Template:TlxuTemplate:NoteTag
{{tlc}}Template:NoteTag
<template link>
{{tnull}}<template link>
Template:Tlxs Template:TlscTemplate:NoteTag
<template link>
colspan="2" rowspan="3" Template:N/a
monospace plaincode=yesTemplate:NoteTag colspan="2" rowspan="2" Template:N/a Template:TltssTemplate:NoteTag rowspan="2" Template:N/a
kbd kbd=yesTemplate:NoteTag
bold bold=yes {{tlb}} colspan="5" rowspan="3" Template:N/a
bold+code bold=yes|code=yes Template:Tlxb
italic+code italic=yes|code=yes Template:Tlxi

Template:NoteFoot

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}}
{{HatnoteLua error: expandTemplate: template "Template journal/arg" does not exist.
}}
Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext">
{{Hatnote
   | Some text
   | selfref = yes
   | category = no
   | lang = fr
}}
</syntaxhighlight>
{{Hatnote
    | Some text
    | selfref = yes
    | category = no
    | lang = fr
}}
Same as above
{{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}} {{Hatnote|Some text|selfref=yes|category=no|lang=fr}} Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight> {{Hatnote|Some text|selfref=yes|category=no|lang=fr}} Same as above
{{tl2|Hatnote|lang=fr}} {{hatnote}} Supports linking to sister projects (e.g., fr:Hatnote)
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} Template:Demo Shows code and example
{{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}} {{#invoke:Example|hello}} Counterpart to {{tl}} for linking to Lua modules
{{mfl|Example|hello}} Template:Mfl Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
{{mlx|Example|hello}} Template:Mlx Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example|hello}} Template:Ml-lua Link to Lua modules and built-in libraries, showing Lua code.
{{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}}
{{pf|if}}
{{pf|if|{{{1}}}|true|false}}
Template:Pf
Template:Pf
Parser function equivalent to {{tl}}
{{magic word|uc:}} Template:Magic word Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)
Code example Effect
{{lt|Hatnote}} Template:Lt
{{lts|Hatnote}} Template:Lts
{{t links|Hatnote}} Template:T links
{{tfd links|Hatnote}} Template:Tfd links
{{tetl|Hatnote}} Template:Tetl
{{tsetl|Hatnote}} Template:Tsetl
{{ti|Hatnote}} Template:Ti
{{tic|Hatnote}} Template:Tic
{{tim|Hatnote}} Template:Tim
{{tiw|Hatnote}} Template:Tiw
{{tlt|Hatnote}} Template:Tlt
{{ttl|Hatnote}} Template:Ttl
{{twlh|Hatnote}} Template:Twlh