Difference between revisions of "Template:Tlg/doc"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Update)
m (fix align)
Line 136: Line 136:
 
|{{tlx|tlg|x5|1|2|3|4|5|6|7|8|9|10|11}}
 
|{{tlx|tlg|x5|1|2|3|4|5|6|7|8|9|10|11}}
 
|{{tlg|x5|1|2|3|4|5|6|7|8|9|10|11}}
 
|{{tlg|x5|1|2|3|4|5|6|7|8|9|10|11}}
−
|{{align|right|<code>&amp;#124;</code> for more}}
+
|align="right"|<code>&amp;#124;</code> for more
 
|-
 
|-
 
|{{tlx|tlg}}
 
|{{tlx|tlg}}
Line 148: Line 148:
 
|{{tlx|tlg|x1|x&amp;#61;u}}
 
|{{tlx|tlg|x1|x&amp;#61;u}}
 
|{{tlg|x1|x&#61;u}}
 
|{{tlg|x1|x&#61;u}}
−
|{{align|right|<code>&amp;#61;</code> is okay}}
+
|align="right"|<code>&amp;#61;</code> is okay
 
|-
 
|-
 
|{{tlx|tlg|x1|x<nowiki>{{=}}</nowiki>u}}
 
|{{tlx|tlg|x1|x<nowiki>{{=}}</nowiki>u}}
 
|{{tlg|x1|x{{=}}u}}
 
|{{tlg|x1|x{{=}}u}}
−
|{{align|right|<code><nowiki>{{=}}</nowiki></code> is okay}}
+
|align="right"|<code><nowiki>{{=}}</nowiki></code> is okay
 
|-
 
|-
 
|{{tlx|tlg|x1|x&lt;nowiki&gt;&#61;&lt;/nowiki&gt;u}}
 
|{{tlx|tlg|x1|x&lt;nowiki&gt;&#61;&lt;/nowiki&gt;u}}
 
|{{tlg|x1|x<nowiki>=</nowiki>u}}
 
|{{tlg|x1|x<nowiki>=</nowiki>u}}
−
|{{align|right|sticky nowiki is okay}}
+
|align="right"|sticky nowiki is okay
 
|-
 
|-
 
|{{tlx|tlg|x2|<nowiki />|two|<nowiki />|<nowiki />}}
 
|{{tlx|tlg|x2|<nowiki />|two|<nowiki />|<nowiki />}}
Line 164: Line 164:
 
|{{tlx|tlg|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
 
|{{tlx|tlg|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
 
|{{tlg|x2|3=two|2=one}}
 
|{{tlg|x2|3=two|2=one}}
−
|{{align|right|right to left okay}}
+
|align="right"|right to left okay
 
|-
 
|-
 
|{{tlx|tlg|convert|<nowiki>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}}
 
|{{tlx|tlg|convert|<nowiki>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}}

Revision as of 22:49, 16 April 2018

{{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 HTML code tags (monospaced) {{tlc}}, {{tlx}}, etc.
plaincode Uses code
kbd Display output using HTML 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 {{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

{{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|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|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}} = 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

These tables:

General-purpose formatting

Comparison of template-linking templates according to their style
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=Foo
2=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=yes4
kbd=yes5 		{{tltt}}5
{{tltt2}}5 		N/A {{tltts}}5
{{tltss}}6
bold bold=yes {{tlb}} N/A
bold+code bold=yes|code=yes {{tlxb}}
italic+code italic=yes|code=yes {{tlxi}}
  • 1  {{tlg}} is the most general, allowing any combination of text style and/or link style options.
  • 2  Prevents wrapping of text by placing it inside span tags.
  • 3  Allows links to templates in any namespace.
  • 4  {{tlg|plaincode=yes}} uses code.
  • 5  Displays w:monospaced font using kbd tags (changed from tt for HTML 5 compliance).
  • 6  Displays monospaced font using span.

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
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} Template:Demo Shows code and example
{{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
{{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}} Template:Sclx Takes a shortcut suffix in project namespace and displays it with brackets.
{{tag|ref}}
{{xtag|templatedata}} 		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}}

With utility links

Code example Effect
{{lt|Hatnote}} Template:Lt
{{lts|Hatnote}} Template:Hatnote(edit talk links history)
{{t links|Hatnote}} Hatnote (edit talk history links /subpages /doc /doc edit /sbox /sbox diff /test)
{{tfd links|Hatnote}} main}}
{{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)
{{tim|Hatnote}} Template:Tim
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} {{Hatnote}} (t/l)
{{twlh|Hatnote}} Template:Hatnote (links, talk)


Retrieved from "https://wiki.kerbalspaceprogram.com/index.php?title=Template:Tlg/doc&oldid=81529"