Template:Tlg/doc

From MicroWiki, the free micronational encyclopædia
Jump to navigation Jump to search

This template, often abbreviated as {{tlg}}, is used to provide stylized formatting to template displays without actually using the template itself.

Parameters

With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options.

Parameter Action Use with
{{Example}}
Default active
Default (without accessory parameters) {{example}}
brace Include braces as part of the template link {{example}} {{tlw}}/{{tn}}
braceinside Include innermost braces as part of the template link {{example}}
bold Renders the template link/name in bold {{example}} {{tlb}}, {{tlxb}}
code Display output using HTML <code>...</code> tags (monospaced font) {{example}} {{tlc}}, {{Template link expanded}}, etc.
italic Display any parameters accompanying the template link/name in italics {{example|param}} {{tlxi}}
kbd Display output using HTML <kbd>...</kbd> tags (monospaced font) {{example}}
nolink Don't render the template name as a link {{example}} {{tlf}}, {{Tnull}}
nowrap Prevent the insertion of line breaks (word wrap) in the output {{example}}
nowrapname Prevent word wrapping in the output of template name/link (parameters will wrap if needed) {{example}}
plaincode Uses <code style="border:none; background:transparent;">...</code> {{example}} {{tltss}}
subst Include a subst: prefix before the template link/name {{subst:example}} {{tls}}, {{tlxs}}, etc
|alttext=[text] Use [text] as the label for the template link {{Other}} {{tla}}
_show_result Will also display the result of the template. {{Min|7|-5}}

Unnamed (Positional)

This template can take any number of 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|Banner}} {{Banner}} Banner 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|[[:Template:Spaces]]{{{1}}}[[:Template:Spaces]]}} 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|}} {{x3|1|2|3|4|5|6|7|8|9|10}}
{{tlg}} tlg with no arguments, the current page name is substituted
{{tlg|x1|x=u}} {{x1}} = won't work
{{tlg|x1|x&#61;u}} {{x1|x=u}}
&#61; 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
Wrapping of long names (default)
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}}
Wrapping of long names (nowrap=on)
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}}
Wrapping of long names (nowrapname=on)
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

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ Template:Template link expanded options[note 1]
to achieve text style
Link style
Linked Unlinked Linked with subst Unlinked with subst Linked including braces Linked with alternative text
Template:Template link expanded options[note 1]
to achieve link style
N/A DEFAULT nolink= yes subst= yes nolink=yes|subst=yes braceinside= yes alttext= Foo
2= Foo
normal DEFAULT {{tlg}}[note 1]
{{tl}}
{{tlp|1|2|...}}[note 2]
Template:Tlu[note 3]
{{tlf}}[note 2]
<template link>
Template:Tls
Template:Tlsu[note 3]
{{tlsf}}[note 2]
<template link>
Template:Tn {{tla}}
code code= yes Template:Tl2
Template:Template link expanded
Template:Tlxu[note 3]
{{tlc}}[note 2]
<template link>
{{tnull}}<template link>
Template:Tlxs Template:Tlsc[note 2]
<template link>
N/A
monospace plaincode= yes[note 4] N/A Template:Tltss[note 5] N/A
kbd kbd= yes[note 5]
bold bold= yes Template:Tlb N/A
bold+code bold=yes|code=yes Template:Tlxb
italic+code italic=yes|code=yes Template:Tlxi
  1. 1.0 1.1 1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. 2.0 2.1 2.2 2.3 2.4 Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  3. 3.0 3.1 3.2 Allows links to templates in any namespace.
  4. {{tlg|plaincode= yes}} uses <code style="border:none; background-color:transparent;">...</code>.
  5. 5.0 5.1 Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{tl2|Hatnote|lang=fr}} Template:Tl2 Supports linking to sister projects (e.g., fr:Hatnote)
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}
{{hatnote|lang=fr|Some text}}

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}} Template:Ml Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}} {{#invoke:Example|hello}} 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>
Template:Xtag
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:}} {{uc:}} 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