Fyrimynd:Tlg/doc

Dokumentation

Hetta er dokumentatiónssíðan fyri Fyrimynd:Tlg. Henda síðan er ikki neyðturviliga hugsað at skula vísast beinleiðis. Um hon nýtir variablar, so kunnu nøkur leinki sýnast sum brotin. Tú mást ikki útskifta variablarnir við beinleiðis tittlar ella URL.

{{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
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 the (monospaced) HTML <code> formatting	{{tlc}} {{tlx}} 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
subst	Include a subst: prefix before the template link/name	{{tls}}
|alttext=[text]	Use [text] as the label for the template link	{{tla}}

Unnamed

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

Examples

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|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|braceinside=on}}	{{x0}}
{{tlg|x0|alttext=x0 link}}	{{x0 link}}
{{tlg|x0|bold=on|code=on|braceinside=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|x=u}}	= 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|2=one|two}}	{{x2|2=one|two}}	two clobbers 2=one
{{tlg|x2|3=two|2=one}}	{{x2|3=two|2=one}}	right to left okay

Unlimited parameters as one nowiki string

{{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

See also

General-purpose formatting

• ¹ {{tlg}} is the most general, allowing any combination of text style and/or link style options.
• ² Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
• ³ Uses monospace font but not <code>...</code>.
• ⁴ Allows links to templates in any namespace.

Other formatting templates

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
{{xpd|Hatnote|Some hatnote text}}	"{{hatnote|Some hatnote text}}" gives " Some hatnote text " [1]	Shows code, example and a link to expand the template code

With utility links

Code example	Effect
{{lts|Hatnote}}	Template:Hatnote(rætta kjak leinkjur søgan)
{{t links|Hatnote}}	Hatnote (edit · talk · history · links · /subpages · /doc · /doc edit · /sbox · /sbox diff · /test · Module:hatnote)
{{tfd links|Hatnote}}	Template:Hatnote (rætta⧼tpt-languages-separator⧽kjak⧼tpt-languages-separator⧽søga⧼tpt-languages-separator⧽leinkjur⧼tpt-languages-separator⧽loggar⧼tpt-languages-separator⧽undirsíðir⧼tpt-languages-separator⧽strika)
{{tiw|Hatnote}}	Template:hatnote (backlinks rætta)
{{tltt|Hatnote}}	{{Hatnote}}
{{tetl|Hatnote}}	{{ Hatnote }} links talk view
{{tsetl|Hatnote}}	{{ subst:Hatnote }}  leinkjur kjak vís
{{ti|Hatnote}}	Fyrimynd:Hatnote (kjak · links · rætta)
{{tic|Hatnote}}	Fyrimynd:Hatnote (kjak links rætta)
{{tiw|Hatnote}}	Template:Hatnote (backlinks rætta)
{{tlt|Hatnote}}	{{Hatnote}} (kjak)
{{ttl|Hatnote}}	{{Hatnote}} (t/l)
{{twlh|Hatnote}}	Fyrimynd:Hatnote (links, kjak)