Template:Tlg/doc

From Hârn
Jump to navigation Jump to search

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

Named[edit source]

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 [[HTML element#code|TAG]] tags (monospaced font) {{tlc}}, {{tlx}}, etc.
plaincode Uses TAG
kbd Display output using HTML [[HTML element#kbd|TAG]] 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 {{tln}}
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[edit source]

{{tlg}} may take up to ten unnamed parameters as parameters accompanying the template link (or name); see Examples below.

Examples[edit source]

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|Abc}} {{Abc}}
{{tlg|abC}} {{abC}} template names are case-sensitive
{{tlg|abc}} {{abc}} first letter is case-insensitive though
{{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&#124;11}} {{x5|1|2|3|4|5|6|7|8|9|10|11}}
&#124; for more
{{tlg}} {{Tlg/doc}} 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
{{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
{{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} {{convert|14|m|ftin|abbr=out|sp=us}} Unlimited parameters as one nowiki string
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[edit source]

Link templates[edit source]

Page Type Normal Link Longer Link Usage Link
Template Template:ltb Template:lt General:{{tlg}}
Normal: {{tl}}
Code:{{tlx}}
File Template:lfb Template:lf Template:fl
User Template:lub Template:lu Template:ul
Category Template:lcb Template:lc Template:cl
Module Template:lmb Template:lm Template:ml
Wikipedia Template:lwb Template:lw
Portal Template:lpb Template:lp
Book Template:lb2 Template:lb
Article Template:lab Template:la

General-purpose formatting[edit source]

Other formatting templates[edit source]

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>}}
{{hatnote|lang=fr|Some text}}

Shows code and example
{{xpd|Hatnote|Some hatnote text}} "{{hatnote|Some hatnote text}}" gives "" [1] Shows code, example and a link to expand the template code
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}}
[[Template:Hatnote]]
[[Template:Hatnote|Hatnote]]
Formats wikilink, with optional piped link text and blended suffix
{{mli|Bananas|hello}}
{{mlix|BananasArgs|hello|Fred}}
{{#invoke:Bananas|hello}}
{{#invoke:BananasArgs|hello|Fred}}
Counterparts to {{tl}} and {{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 [[WP:CODE|TAG]] tag.
{{tag|ref}}
{{xtag|templatedata}}
TAG
<templatedata>
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing

With utility links[edit source]

Code example Effect
{{lts|Hatnote}} Template:Hatnote (Edit Discussion links Page history)
{{t links|Hatnote}} Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test) · Module:hatnote
{{tfd links|Hatnote}} Template:Hatnote (edit · talk · history · links · logs · subpages · delete)
{{tiw|Hatnote}} Template:hatnote (backlinks edit)
{{tltt|Hatnote}} {{Hatnote}}
{{tetl|Hatnote}} {{Hatnote}}
links talk view
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk view
{{ti|Hatnote}} Template:Hatnote (talk · links · edit)
{{tic|Hatnote}} Template:Hatnote (talk links edit)
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} {{Hatnote}} (t/l)
{{twlh|Hatnote}} Template:Hatnote (links, talk)

See also[edit source]

Page Type Normal Link Longer Link Usage Link
Template Template:ltb Template:lt General:{{tlg}}
Normal: {{tl}}
Code:{{tlx}}
File Template:lfb Template:lf Template:fl
User Template:lub Template:lu Template:ul
Category Template:lcb Template:lc Template:cl
Module Template:lmb Template:lm Template:ml
Wikipedia Template:lwb Template:lw
Portal Template:lpb Template:lp
Book Template:lb2 Template:lb
Article Template:lab Template:la