Difference between revisions of "Template:Tlp/doc"

From Kerbal Space Program Wiki
Jump to: navigation, search
m (Update)
(Update)
 
Line 24: Line 24:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
!Code !! Result !! Comment
+
! Code
 +
! Output
 +
! Comments
 
|-
 
|-
−
| {{tlc|tlp}} || {{tlp}} || Shows its own syntax.
+
|{{tlc|tlp}}
 +
|{{tlp}}
 +
|Shows its own syntax.
 
|-
 
|-
−
| {{tlc|tlp|name}} || {{tlp|name}} ||
+
|{{tlc|tlp|name}}
 +
|{{tlp|name}}
 +
|
 
|-
 
|-
−
| {{tlc|tlp|name|first}} || {{tlp|name|first}} ||
+
|{{tlc|tlp|name|first}}
 +
|{{tlp|name|first}}
 +
|
 
|-
 
|-
−
| {{tlc|tlp|name|first|last}} || {{tlp|name|first|last}} ||
+
|{{tlc|tlp|name|first|last}}
 +
|{{tlp|name|first|last}}
 +
|
 
|-
 
|-
−
| {{tlc|tlp|name|a|b|c|d|e|<nowiki>f|g|h|i|</nowiki>j}} || {{tlp|name|a|b|c|d|e|f|g|h|i|j}} || Shows up to ''eight'' parameters. The rest are dropped.
+
|{{tlc|tlp|name|a|b|c|d|e|<nowiki>f|g|h|i|</nowiki>j}}
 +
|{{tlp|name|a|b|c|d|e|f|g|h|i|j}}
 +
|Shows up to ''eight'' parameters. The rest are dropped.
 
|-
 
|-
−
| {{tlc|tlp|name|||three|four}} || {{tlp|name|||three|four}} || Also shows empty parameters.
+
|{{tlc|tlp|name||three|four}}
 +
|{{tlp|name||three|four}}
 +
|Also shows empty parameters.
 
|-
 
|-
−
| {{tlc|tlp|name|||three||}} || {{tlp|name|||three||}} ||Even shows empty parameters that come at the end.
+
|{{tlc|tlp|name||three|}}
 +
|{{tlp|name||three|}}
 +
|Even shows empty parameters that come at the end.
 
|- style="color: red;"
 
|- style="color: red;"
−
| {{tlc|tlp|name|3=first=a|4=last=b}} || {{tlp|name|first=a|last=b}} || Equal signs are a problem, but there are a couple ways to fix:
+
|{{tlc|tlp|name|3=first=a|4=last=b}}
 +
|{{tlp|name|first=a|last=b}}
 +
|Equal signs are a problem, but there are a couple ways to fix:
 
|-
 
|-
−
| {{tlc|tlp|name|3=2=first=a|4=3=last=b}} || {{tlp|name|2=first=a|3=last=b}} || Use numbered parameters to fix it. Here, parameter "{{para|2}}" is assigned the string "first{{=}}a". Start with #2, since "name" is already in the "{{para|1}}" slot. Note that ''all'' subsequent parameters after a numbered parameter ''must also'' be numbered.
+
|{{tlc|tlp|name|3=2=first=a|4=3=last=b}}
 +
|{{tlp|name|2=first=a|3=last=b}}
 +
|Use numbered parameters to fix it. Here, parameter "{{para|2}}" is assigned the string "first{{=}}a". Start with #2, since "name" is already in the "{{para|1}}" slot. Note that ''all'' subsequent parameters after a numbered parameter ''must also'' be numbered.
 
|-
 
|-
−
| {{tlc|tlp|name|3=first<nowiki>{{=}}</nowiki>a|4=last<nowiki>{{=}}</nowiki>b}} || {{tlp|name|first{{=}}a|last{{=}}b}} || Or, simply use, "<nowiki>{{=}}</nowiki>", the equal-sign template, to "escape" the symbol.
+
|{{tlc|tlp|name|3=first<nowiki>{{=}}</nowiki>a|4=last<nowiki>{{=}}</nowiki>b}}
 +
|{{tlp|name|first{{=}}a|last{{=}}b}}
 +
|Or, simply use, "<nowiki>{{=}}</nowiki>", the equal-sign template, to "escape" the symbol.
 
|-
 
|-
−
| {{tlc|tlp|name|3=2=1=a|4=3=2=b}} || {{tlp|name|2=1=a|3=2=b}} || Both techniques also work with numbered positional parameters (e.g.: "{{para|1}}", "{{para|2}}").
+
|{{tlc|tlp|name|3=2=1=a|4=3=2=b}}
 +
|{{tlp|name|2=1=a|3=2=b}}
 +
|Both techniques also work with numbered positional parameters (e.g.: "{{para|1}}", "{{para|2}}").
 
|- style="color: red;"
 
|- style="color: red;"
−
| {{tlc|tlp|name|3=2=1=a|4=last<nowiki>{{=}}</nowiki>b}} || {{tlp|name|2=1=a|last{{=}}b}} || The named parameter ("{{para|last}}") clobbered the prior one ("{{para|2}}").  Again, '''all''' subsequent parameters after a numbered parameter ''must also'' be numbered...
+
|{{tlc|tlp|name|3=2=1=a|4=last<nowiki>{{=}}</nowiki>b}}
 +
|{{tlp|name|<!--2=1=a|-->last{{=}}b}}
 +
|The named parameter ("{{para|last}}") clobbered the prior one ("{{para|2}}").  Again, '''all''' subsequent parameters after a numbered parameter ''must also'' be numbered...
 
|-
 
|-
−
| {{tlc|tlp|name|3=2=1=a|4=3=last=b}} || {{tlp|name|2=1=a|3=last=b}} || ... but that's easy to fix, by adding the position number ("{{para|3}}") to the last parameter.
+
|{{tlc|tlp|name|3=2=1=a|4=3=last=b}}
 +
|{{tlp|name|2=1=a|3=last=b}}
 +
|... but that's easy to fix, by adding the position number ("{{para|3}}") to the last parameter.
 
|}
 
|}
  

Latest revision as of 23:14, 16 April 2018

This is the template link with parameters (or {{tlp}}) template.

It can be used in documentation and talk page discussions to show how a template name would be used in code.

Here is how this template looks. Code to the left and actual rendering to the right:

{{tlp|name|parameters}} = {{name|parameters}}

Features of {{tlp}}:

  • It shows a template name with a link to that template.
  • It shows up to eight parameters.
  • It also shows empty parameters. (See examples below.)
  • It prevents line wraps in its output.
  • It uses normal text style. ({{tlx}}, for instance, uses code text style.)

This template belongs to a whole family of similar templates. See the see also section below for some of them. For instance, when writing documentation you might want to avoid a lot of unnecessary links, since it decreases readability – i.e. on the first occurrence of a template name, use {{tl}}, {{tlp}} or {{Tlx}} and thereafter use {{tlf}}, {{tlc}} or {{tld}}.

Examples

Code Output Comments
{{tlp}} {{[[Template:{{{1}}}|{{{1}}}]]}} Shows its own syntax.
{{tlp|name}} {{name}}
{{tlp|name|first}} {{name|first}}
{{tlp|name|first|last}} {{name|first|last}}
{{tlp|name|a|b|c|d|e|f|g|h|i|j}} {{name|a|b|c|d|e|f|g|h}} Shows up to eight parameters. The rest are dropped.
{{tlp|name||three|four}} {{name||three|four}} Also shows empty parameters.
{{tlp|name||three|}} {{name||three|}} Even shows empty parameters that come at the end.
{{tlp|name|first=a|last=b}} {{name}} Equal signs are a problem, but there are a couple ways to fix:
{{tlp|name|2=first=a|3=last=b}} {{name|first=a|last=b}} Use numbered parameters to fix it. Here, parameter "|2=" is assigned the string "first=a". Start with #2, since "name" is already in the "|1=" slot. Note that all subsequent parameters after a numbered parameter must also be numbered.
{{tlp|name|first{{=}}a|last{{=}}b}} {{name|first=a|last=b}} Or, simply use, "{{=}}", the equal-sign template, to "escape" the symbol.
{{tlp|name|2=1=a|3=2=b}} {{name|1=a|2=b}} Both techniques also work with numbered positional parameters (e.g.: "|1=", "|2=").
{{tlp|name|2=1=a|last{{=}}b}} {{name|last=b}} The named parameter ("|last=") clobbered the prior one ("|2="). Again, all subsequent parameters after a numbered parameter must also be numbered...
{{tlp|name|2=1=a|3=last=b}} {{name|1=a|last=b}} ... but that's easy to fix, by adding the position number ("|3=") to the last parameter.

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:Tlp/doc&oldid=81533"