Difference between revisions of "Template:Tlg/doc"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Import from Wikipedia (CC BY-SA license))
 
m (add {{En-WP attribution notice}}, cleanup, and replace {{Aligned table}} with old wikitable from WP history)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 +
{{En-WP attribution notice}}
 
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
  
Line 14: Line 15:
 
  | bold<br/>boldlink<br/>boldname || Renders the template link/name in '''bold'''                  || {{tl|tlb}} {{tl|tlx}} etc.
 
  | bold<br/>boldlink<br/>boldname || Renders the template link/name in '''bold'''                  || {{tl|tlb}} {{tl|tlx}} etc.
 
|-
 
|-
−
  | code        || Display output using the ([[Monospaced font|monospaced]]) HTML <nowiki><code></nowiki> formatting || {{tl|tlc}} {{tl|tlx}} etc.
+
  | code        || Display output using the ([[w:Monospaced font|monospaced]]) HTML <nowiki><code></nowiki> formatting || {{tl|tlc}} {{tl|tlx}} etc.
 
|-
 
|-
 
  | italic<br/>italics || Display any parameters accompanying the template link/name in ''italic/s'' || {{tl|tlxi}}
 
  | italic<br/>italics || Display any parameters accompanying the template link/name in ''italic/s'' || {{tl|tlxi}}
Line 20: Line 21:
 
  | nolink      || Don't render the template name as a link                                          || {{tl|tln}}
 
  | nolink      || Don't render the template name as a link                                          || {{tl|tln}}
 
|-
 
|-
−
  | nowrap      || Prevent the insertion of line breaks ([[word wrap]]) in the output                ||  
+
  | nowrap      || Prevent the insertion of line breaks ([[w:word wrap|word wrap]]) in the output                ||  
 
|-
 
|-
−
  | subst      || Include a [[Help:Substitution|subst:]] prefix before the template link/name      || {{tl|tls}}
+
  | subst      || Include a [[w:Help:Substitution|subst:]] prefix before the template link/name      || {{tl|tls}}
 
|-
 
|-
 
  | <nowiki>|alttext=[text]</nowiki> || Use [text] as the label for the template link  || {{tl|tla}}
 
  | <nowiki>|alttext=[text]</nowiki> || Use [text] as the label for the template link  || {{tl|tla}}
Line 34: Line 35:
 
; 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.
 
; 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.
 
}}
 
}}
−
{{Aligned table
+
{| border="1" cellpadding="4" class="wikitable"
−
|cols=3 |class=wikitable |style=border:1;cellpadding:4;
+
! Code
−
| '''Code'''                        | '''Output'''              | '''Remarks'''
+
! Result
−
| {{tlx|tlg|Abc}}                   | {{tlg|Abc}}               |
+
! Remark
−
| {{tlx|tlg|abC}}                   | {{tlg|abC}}               | template names are case-sensitive
+
|-
−
| {{tlx|tlg|abc}}                   | {{tlg|abc}}               | first letter is case-insensitive though
+
|{{Tlx|Tlg|Abc}}
−
| {{tlx|tlg|x0}}                     | {{tlg|x0}}                 |  
+
|{{Tlg|Abc}}
−
| {{tlx|tlg|x0|code{{=}}on}}         | {{tlg|x0|code=on}}         | &lt;code&gt; style
+
|&nbsp;
−
| {{tlx|tlg|x0|plaincode{{=}}on}}   | {{tlg|x0|plaincode=on}}   | plaincode style
+
|-
−
| {{tlx|tlg|x0|bold{{=}}on}}         | {{tlg|x0|bold=on}}         | bold link/name
+
|{{Tlx|Tlg|abC}}
−
| {{tlx|tlg|x1|one|italic{{=}}on}}   | {{tlg|x1|one|italic=on}}   | parameter/s in italics
+
|{{Tlg|abC}}
−
| {{tlx|tlg|x0|nolink{{=}}on}}       | {{tlg|x0|nolink=on}}       |  
+
|template names are case-sensitive
−
| {{tlx|tlg|x0|subst{{=}}on}}       | {{tlg|x0|subst=on}}       |
+
|-
−
| {{tlx|tlg|x0|braceinside{{=}}on}} | {{tlg|x0|braceinside=on}} |  
+
|{{Tlx|Tlg|abc}}
−
| {{tlx|tlg|x0|alttext{{=}}x0 link}} | {{tlg|x0|alttext=x0 link}} |
+
|{{Tlg|abc}}
−
| {{tlx|tlg|x0|bold{{=}}on|code{{=}}on|braceinside{{=}}on}} | {{tlg|x0|bold=on|code=on|braceinside=on}} | No reason you can't combine multiple parameter settings
+
|first letter is case-insensitive though
−
| {{tlx|tlg|x1|one}}                 | {{tlg|x1|one}}             |
+
|-
−
| {{tlx|tlg|x2|one|two}}             | {{tlg|x2|one|two}}         |  
+
|{{Tlx|Tlg|x0}}
−
| {{tlx|tlg|x2|bold{{=}}on|code{{=}}on|one|two}} | {{tlg|x2|bold=on|code=on|one|two}} | Can combine named and anonymous parameters …
+
|{{Tlg|x0}}
−
| {{tlx|tlg|x2|one|two|bold{{=}}on|code{{=}}on}} | {{tlg|x2|one|two|bold=on|code=on}} | … in any order …
+
|&nbsp;
−
| {{tlx|tlg|x2|one|code{{=}}on|two|bold{{=}}on|three}} | {{tlg|x2|one|code=on|two|bold=on|three}} | … even intermixed …
+
|-
−
| {{tlx|tlg|x2|one|code{{=}}on|two|bold{{=}}on|three|italic{{=}}on}} | {{tlg|x2|one|code=on|two|bold=on|three|italic=on}} | … with many different configurations.
+
|{{Tlx|Tlg|x0|code{{=}}yes}}
−
| {{tlx|tlg|x3|1|2|3|4|5|6|7|8|9&#124;10}}               | {{tlg|x3|1|2|3|4|5|6|7|8|9|10}}     |  
+
|{{Tlg|x0|code=yes}}
−
| {{tlx|tlg|x4|1|2|3|4|5|6|7|8|9&#124;10&#124;11}}       | {{tlg|x4|1|2|3|4|5|6|7|8|9|10|11}}   | up to 10 parameters, then …
+
|code style
−
| {{tlx|tlg|x5|1|2|3|4|5|6|7|8|9&#124;10&amp;#124;11}}   | {{tlg|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} | {{align|right|<code>&amp;#124;</code> for more}}
+
|-
−
| {{tlx|tlg}}                                            | {{tlg}}                              | with no arguments, the current page name is substituted
+
|{{Tlx|Tlg|x0|bold{{=}}yes}}
−
| {{tlx|tlg|x1|x&#61;u}}                                 | {{tlg|x1|x{{=}}u}}                  | '''{{=}}''' won't work
+
|{{Tlg|x0|bold=yes}}
−
| {{tlx|tlg|x1|x&amp;#61;u}}                             | {{tlg|x1|x&#61;u}}                   | {{align|right|<code>&amp;#61;</code> is okay}}
+
|bold style
−
| {{tlx|tlg|x1|x<nowiki>{{=}}</nowiki>u}}               | {{tlg|x1|x{{=}}u}}                  | {{align|right|<code><nowiki>{{=}}</nowiki></code> is okay}}
+
|-
−
| {{tlx|tlg|x1|x&lt;nowiki&gt;&#61;&lt;/nowiki&gt;u}}   | {{tlg|x1|x<nowiki>=</nowiki>u}}      | {{align|right|sticky nowiki is okay}}
+
|{{Tlx|Tlg|x1|one|italic{{=}}yes}}
−
| {{tlx|tlg|x2|<nowiki />|two|<nowiki />|<nowiki />}}   | {{tlg|x2||two||}}                    | empty parameters work too, even at the end
+
|{{Tlg|x1|one|italic=yes}}
−
| {{tlx|tlg|x2|<nowiki>2=one</nowiki>|two}}             | {{tlg|x2|2{{=}}one|two}}            | '''two''' clobbers '''2{{=}}one'''
+
|italic style
−
| {{tlx|tlg|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | {{tlg|x2|3{{=}}two|2{{=}}one}} | {{align|right|right to left okay}}
+
|-
−
}}
+
|{{Tlx|Tlg|x0|nolink{{=}}yes}}
−
; Unlimited parameters as one nowiki string
+
|{{Tlg|x0|nolink=yes}}
−
{{tlx|tlg|convert|<nowiki>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}}
+
|&nbsp;
 +
|-
 +
|{{Tlx|Tlg|x0|subst{{=}}yes}}
 +
|{{Tlg|x0|subst=yes}}
 +
|&nbsp;
 +
|-
 +
|{{Tlx|Tlg|x0|braceinside{{=}}yes}}
 +
|{{Tlg|x0|braceinside=yes}}
 +
|&nbsp;
 +
|-
 +
|{{Tlx|Tlg|x0|alttext{{=}}Link to x0 template}}
 +
|{{Tlg|x0|alttext=Link to x0 template}}
 +
|&nbsp;
 +
|-
 +
|{{Tlx|Tlg|x0|bold{{=}}yes|code{{=}}yes|braceinside{{=}}yes}}
 +
|{{Tlg|x0|bold=yes|code=yes|braceinside=yes}}
 +
|No reason you can't combine multiple parameter settings.
 +
|-
 +
|{{Tlx|Tlg|x1|one}}
 +
|{{Tlg|x1|one}}
 +
|&nbsp;
 +
|-
 +
|{{Tlx|Tlg|x2|one|two}}
 +
|{{Tlg|x2|one|two}}
 +
|&nbsp;
 +
|-
 +
|{{Tlx|Tlg|x2|bold{{=}}yes|code{{=}}yes|one|two}}
 +
|{{Tlg|x2|bold=yes|code=yes|one|two}}
 +
|Can combine named and anonymous parameters …
 +
|-
 +
|{{Tlx|Tlg|x2|one|two|bold{{=}}yes|code{{=}}yes}}
 +
|{{Tlg|x2|one|two|bold=yes|code=yes}}
 +
|… in any order …
 +
|-
 +
|{{Tlx|Tlg|x2|one|code{{=}}yes|two|bold{{=}}yes|three}}
 +
|{{Tlg|x2|bold=yes|one|code=yes|two|bold=yes|three}}
 +
|… even intermixed …
 +
|-
 +
|{{Tlx|Tlg|x2|one|code{{=}}yes|two|bold{{=}}yes|three|italic{{=}}yes}}
 +
|{{Tlg|x2|bold=yes|one|code=yes|two|bold=yes|three|italic=yes}}
 +
|… with many different configurations.
 +
|-
 +
|{{Tlx|Tlg|x3|1|2|3|4|5|6|7|8|9&#124;10}}
 +
|{{Tlg|x3|1|2|3|4|5|6|7|8|9|10}}
 +
|&nbsp;
 +
|-
 +
|{{Tlx|Tlg|x4|1|2|3|4|5|6|7|8|9&#124;10&#124;11}}
 +
|{{Tlg|x4|1|2|3|4|5|6|7|8|9|10|11}}
 +
|up to 10 parameters, then …
 +
|-
 +
|{{Tlx|Tlg|x5|1|2|3|4|5|6|7|8|9&#124;10&amp;#124;11}}
 +
|{{Tlg|x5|1|2|3|4|5|6|7|8|9|10&#124;11}}
 +
|align="right"|<code>&amp;#124;</code> for more
 +
|-
 +
|colspan=2| {{Tlx|Tlg|convert|<nowiki>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}}
 +
|unlimited parameters as one nowiki string
 +
|-
 +
|{{Tlx|Tlg}}
 +
|{{Tlg}}
 +
|with no arguments, the current page name is substituted
 +
|-
 +
|{{Tlx|Tlg|x1|x&#61;u}}
 +
|{{Tlg|x1|x=u}}
 +
|'''=''' won't work
 +
|-
 +
|{{Tlx|Tlg|x1|x&amp;#61;u}}
 +
|{{Tlg|x1|x&#61;u}}
 +
|align="right"|<code>&amp;#61;</code> is okay
 +
|-
 +
|{{Tlx|Tlg|x1|x<nowiki>{{=}}</nowiki>u}}
 +
|{{Tlg|x1|x{{=}}u}}
 +
|align="right"|<code><nowiki>{{=}}</nowiki></code> is okay
 +
|-
 +
|{{Tlx|Tlg|x1|x&lt;nowiki&gt;&#61;&lt;/nowiki&gt;u}}
 +
|{{Tlg|x1|x<nowiki>=</nowiki>u}}
 +
|align="right"|sticky nowiki is okay
 +
|-
 +
|{{Tlx|Tlg|x2|<nowiki />|two|<nowiki />|<nowiki />}}
 +
|{{Tlg|x2||two||}}
 +
|empty parameters work too, even at the end
 +
|-
 +
|{{Tlx|Tlg|x2|<nowiki>2=one</nowiki>|two}}
 +
|{{Tlg|x2|2=one|two}}
 +
|'''two''' clobbers '''2=one'''
 +
|-
 +
|{{Tlx|Tlg|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
 +
|{{Tlg|x2|3=two|2=one}}
 +
|align="right"|right to left okay
 +
|}
  
 
== See also ==
 
== See also ==

Revision as of 02:45, 4 June 2015

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

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 Result Remark
{{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=yes}} {{x0}} code style
{{Tlg|x0|bold=yes}} {{x0}} bold style
{{Tlg|x1|one|italic=yes}} {{x1|one}} italic style
{{Tlg|x0|nolink=yes}} {{x0}}  
{{Tlg|x0|subst=yes}} {{subst:x0}}  
{{Tlg|x0|braceinside=yes}} {{x0}}  
{{Tlg|x0|alttext=Link to x0 template}} {{Link to x0 template}}  
{{Tlg|x0|bold=yes|code=yes|braceinside=yes}} {{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=yes|code=yes|one|two}} {{x2|one|two}} Can combine named and anonymous parameters …
{{Tlg|x2|one|two|bold=yes|code=yes}} {{x2|one|two}} … in any order …
{{Tlg|x2|one|code=yes|two|bold=yes|three}} {{x2|one|two|three}} … even intermixed …
{{Tlg|x2|one|code=yes|two|bold=yes|three|italic=yes}} {{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|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} unlimited parameters as one nowiki string
{{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|2=one|two}} {{x2|two}} two clobbers 2=one
{{Tlg|x2|3=two|2=one}} {{x2|one|two}} right to left okay

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=64123"