Difference between revisions of "Template:Tlg/doc"
From Kerbal Space Program Wiki
m (add {{En-WP attribution notice}}, cleanup, and replace {{Aligned table}} with old wikitable from WP history) |
(Update) |
||
Line 6: | Line 6: | ||
===Parameters=== | ===Parameters=== | ||
− | + | ====Named==== | |
− | With the exception of {{mono|alttext}}, {{tlf|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): | + | With the exception of {{mono|alttext}}, {{tlf|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): |
{| class="wikitable" | {| class="wikitable" | ||
! Parameter || Action || As in | ! Parameter || Action || As in | ||
|- | |- | ||
− | + | | braceinside || Include innermost braces as part of the template link || {{tl|tlw}} | |
|- | |- | ||
− | + | | bold<br/>boldlink<br/>boldname || Renders the template link/name in '''bold''' || {{tl|tlb}}, {{tl|tlx}}, etc. | |
|- | |- | ||
− | + | | code || Display output using HTML [[HTML element#code|{{tag|code}}]] tags ([[w:Monospaced font|monospaced]]) || {{tl|tlc}}, {{tl|tlx}}, etc. | |
|- | |- | ||
− | + | | plaincode || Uses {{tag|code|params=style="border:none; background:transparent;"}} || | |
|- | |- | ||
− | + | | kbd || Display output using HTML [[HTML element#kbd|{{tag|kbd}}]] tags (monospaced font) || {{tl|tltt}}, {{tl|tltt2}}, etc. | |
|- | |- | ||
− | + | | italic<br/>italics || Display any parameters accompanying the template link/name in ''italic/s'' || {{tl|tlxi}} | |
|- | |- | ||
− | + | | nolink || Don't render the template name as a link || {{tl|tln}} | |
|- | |- | ||
− | + | | nowrap || Prevent the insertion of line breaks ([[w:word wrap|word wrap]]) in the output || {{tl|tlp}}, {{tl|tlf}}, etc. | |
+ | |- | ||
+ | | nowrapname || Prevent word wrapping in the output of template name/link (parameters will wrap if needed) || | ||
+ | |- | ||
+ | | 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}} | ||
|} | |} | ||
− | + | ====Unnamed==== | |
{{tlf|tlg}} may take up to ten unnamed parameters as parameters accompanying the template link (or name); see Examples below. | {{tlf|tlg}} may take up to ten unnamed parameters as parameters accompanying the template link (or name); see Examples below. | ||
Line 37: | Line 43: | ||
{| border="1" cellpadding="4" class="wikitable" | {| border="1" cellpadding="4" class="wikitable" | ||
! Code | ! Code | ||
− | ! | + | ! Output |
− | ! | + | ! Remarks |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|Abc}} |
− | |{{ | + | |{{tlg|Abc}} |
− | | | + | | |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|abC}} |
− | |{{ | + | |{{tlg|abC}} |
|template names are case-sensitive | |template names are case-sensitive | ||
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|abc}} |
− | |{{ | + | |{{tlg|abc}} |
|first letter is case-insensitive though | |first letter is case-insensitive though | ||
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x0}} |
− | |{{ | + | |{{tlg|x0}} |
− | |& | + | | |
+ | |- | ||
+ | |{{tlx|tlg|x0|code{{=}}on}} | ||
+ | |{{tlg|x0|code=on}} | ||
+ | |<code> style | ||
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x0|plaincode{{=}}on}} |
− | |{{ | + | |{{tlg|x0|plaincode=on}} |
− | | | + | |plaincode style |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x0|kbd{{=}}on}} |
− | |{{ | + | |{{tlg|x0|kbd=on}} |
− | | | + | |<kbd> style |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x0|bold{{=}}on}} |
− | |{{ | + | |{{tlg|x0|bold=on}} |
− | | | + | |bold link/name |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x1|one|italic{{=}}on}} |
− | |{{ | + | |{{tlg|x1|one|italic=on}} |
− | | | + | |parameter/s in italics |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x0|nolink{{=}}on}} |
− | |{{ | + | |{{tlg|x0|nolink=on}} |
− | | | + | | |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x0|subst{{=}}on}} |
− | |{{ | + | |{{tlg|x0|subst=on}} |
− | | | + | | |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x0|braceinside{{=}}on}} |
− | |{{ | + | |{{tlg|x0|braceinside=on}} |
− | | | + | | |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x0|alttext{{=}}x0 link}} |
− | |{{ | + | |{{tlg|x0|alttext=x0 link}} |
− | | | + | | |
|- | |- | ||
− | |{{ | + | |{{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 |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x1|one}} |
− | |{{ | + | |{{tlg|x1|one}} |
− | | | + | | |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x2|one|two}} |
− | |{{ | + | |{{tlg|x2|one|two}} |
+ | | | ||
+ | |- | ||
+ | |{{tlx|tlg|x2|bold{{=}}on|code{{=}}on|one|two}} | ||
+ | |{{tlg|x2|bold=on|code=on|one|two}} | ||
|Can combine named and anonymous parameters … | |Can combine named and anonymous parameters … | ||
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x2|one|two|bold{{=}}on|code{{=}}on}} |
− | |{{ | + | |{{tlg|x2|one|two|bold=on|code=on}} |
|… in any order … | |… in any order … | ||
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x2|one|code{{=}}on|two|bold{{=}}on|three}} |
− | |{{ | + | |{{tlg|x2|one|code=on|two|bold=on|three}} |
|… even intermixed … | |… 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. | |… with many different configurations. | ||
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x3|1|2|3|4|5|6|7|8|9|10}} |
− | |{{ | + | |{{tlg|x3|1|2|3|4|5|6|7|8|9|10}} |
− | | | + | | |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x4|1|2|3|4|5|6|7|8|9|10|11}} |
− | |{{ | + | |{{tlg|x4|1|2|3|4|5|6|7|8|9|10|11}} |
|up to 10 parameters, then … | |up to 10 parameters, then … | ||
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} |
− | |{{ | + | |{{tlg|x5|1|2|3|4|5|6|7|8|9|10|11}} |
− | |align | + | |{{align|right|<code>&#124;</code> for more}} |
|- | |- | ||
− | + | |{{tlx|tlg}} | |
− | + | |{{tlg}} | |
− | |||
− | |{{ | ||
− | |{{ | ||
|with no arguments, the current page name is substituted | |with no arguments, the current page name is substituted | ||
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x1|x=u}} |
− | |{{ | + | |{{tlg|x1|x=u}} |
− | |'''=''' won't work | + | |'''{{=}}''' won't work |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x1|x&#61;u}} |
− | |{{ | + | |{{tlg|x1|x=u}} |
− | |align | + | |{{align|right|<code>&#61;</code> is okay}} |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x1|x<nowiki>{{=}}</nowiki>u}} |
− | |{{ | + | |{{tlg|x1|x{{=}}u}} |
− | |align | + | |{{align|right|<code><nowiki>{{=}}</nowiki></code> is okay}} |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x1|x<nowiki>=</nowiki>u}} |
− | |{{ | + | |{{tlg|x1|x<nowiki>=</nowiki>u}} |
− | |align | + | |{{align|right|sticky nowiki is okay}} |
|- | |- | ||
− | |{{ | + | |{{tlx|tlg|x2|<nowiki />|two|<nowiki />|<nowiki />}} |
− | |{{ | + | |{{tlg|x2||two||}} |
|empty parameters work too, even at the end | |empty parameters work too, even at the end | ||
|- | |- | ||
− | |{{ | + | |{{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|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} | ||
+ | |{{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | ||
+ | |Unlimited parameters as one nowiki string | ||
+ | |} | ||
+ | |||
+ | {| class="wikitable" |style="border:1; cellpadding:4; background-color:transparent;" | ||
+ | |+ style="text-align:left;" | Wrapping of long names (default) | ||
+ | |- | ||
+ | ! Code | ||
+ | ! style="width:15em;" | Output | ||
+ | |- | ||
+ | | {{tlx|tlg|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} | ||
+ | | {{tlg|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} | ||
+ | |} | ||
+ | |||
+ | {| class="wikitable" |style="border:1; cellpadding:4; background-color:transparent;" | ||
+ | |+ style="text-align:left;" | Wrapping of long names (<kbd>nowrap=on</kbd>) | ||
+ | |- | ||
+ | ! Code | ||
+ | ! style="width:15em;" | Output | ||
+ | |- | ||
+ | | {{tlx|tlg|nowrap{{=}}on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} | ||
+ | | {{tlg|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} | ||
+ | |} | ||
+ | |||
+ | {| class="wikitable" |style="border:1; cellpadding:4; background-color:transparent;" | ||
+ | |+ style="text-align:left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>) | ||
+ | |- | ||
+ | ! Code | ||
+ | ! style="width:15em;" | Output | ||
|- | |- | ||
− | |{{ | + | | {{tlx|tlg|nowrapname{{=}}on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
− | |{{ | + | | {{tlg|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
− | |||
|} | |} | ||
Revision as of 22:46, 16 April 2018
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This is a documentation subpage for Template:Tlg. It contains usage information, categories and other content that is not part of the original template page. |
This template uses material from the Wikipedia template Template:Tlg/doc, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors). | Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
{{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.
Contents
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|11}}
|
{{x5|1|2|3|4|5|6|7|8|9|10|11}} | Template:Align |
{{tlg}}
|
{{Tlg/doc}} | with no arguments, the current page name is substituted |
{{tlg|x1|x=u}}
|
{{x1}} | = won't work |
{{tlg|x1|x=u}}
|
{{x1|x=u}} | Template:Align |
{{tlg|x1|x{{=}}u}}
|
{{x1|x=u}} | Template:Align |
{{tlg|x1|x<nowiki>=</nowiki>u}}
|
{{x1|x=u}} | Template:Align |
{{tlg|x2||two||}}
|
{{x2||two||}} | empty parameters work too, even at the end |
{{tlg|x2|3=two|2=one}}
|
{{x2|one|two}} | Template:Align |
{{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 |
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}} |
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}} |
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
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=yes 4kbd=yes 5
|
{{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}}
| ||||
|
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}} |
{{tsetl|Hatnote}} |
{{subst:Hatnote}} |
{{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) |