Jump to content
Toggle menu
  • 8 articles
  • 75 files
  • 7 users
  • 37.8K edits
Neodyland Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Tlx/doc: Difference between revisions

Template page
Updating the /doc since I have now made this template work like {{tlf}}. I will probably add a little more text to this documentation soon.
Extending/finishing the documentation due to the upgrade of this template today.
Line 3: Line 3:
{{high-use| 30,000+ }}
{{high-use| 30,000+ }}


This is the {{tl|tlp}} template.
This is the {{tl|tlp}} or '''template link with parameters''' 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:
Here is how this template looks. Code to the left and actual rendering to the right:
Line 10: Line 12:


Features of {{tlp|tlp}}:
Features of {{tlp|tlp}}:
* It shows a template name and up to eight parameters.
* 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 also shows empty parameters. (See examples below.)
* It prevents [[line wrap]]s in its output.
* It prevents [[line wrap]]s in its output.
* It uses normal text style. (While for instance {{tlx|tlx}} uses <tt>teletype</tt> text style.)
This template belongs to a whole family of similar templates. See the [[#See also|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. Then on the first occurrence of a template name use {{tl|tl}}, {{tlp|tlp}} or {{tlx|tlx}}, and then use {{tlf|tlf}}, {{tld|tld}} or {{tlc|tlc}}.


=== Examples ===
=== Examples ===

Revision as of 10:05, 19 February 2009

This is the {{Tlp}} or template link with parameters 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. (While for instance {{tlx}} uses teletype 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. Then on the first occurrence of a template name use {{Tl}}, {{tlp}} or {{tlx}}, and then use {{tlf}}, {{tld}} or {{tlc}}.

Examples

CodeResultComment
{{tlp}} {{[[Template:{{{1}}}|{{{1}}}]]}} Shows its own syntax.
{{tlp|name}} {{name}}
{{tlp|name|one}} {{name|one}}
{{tlp|name|one|two}} {{name|one|two}}
{{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 in the end.
{{tlp|one=a|two=b}} {{name}} Equal signs is a problem, but there is a fix.
{{tlp|name|2=one=a|3=two=b}} {{name|one=a|two=b}} Use numbered parameters to fix it. Remember to start from 2, since the "name" is number 1.

If you have equal signs in your template parameters then some find it simpler to code it using <nowiki> tags. Here's how to do that. Code to the left and actual rendering to the right:

{{tlp|name|<nowiki>one=a|two=b</nowiki>}} = {{name|one=a|two=b}}

See also

  • {{Tlc}} – Not linked, several parameters and text in <code></code> style.
  • {{Tld}} – Not linked, several parameters and teletype text style.
  • {{Tlf}} – Not linked, several parameters and normal text style.
  • {{Tl}} – Template link, no parameters and normal text style.
  • {{Tlp}} – Template link, several parameters and normal text style.
  • {{Tlx}} – Template link, several parameters and interwiki links, teletype text style.
  • {{Tn}} – Same as {{tl}}, but shows the braces as part of the link.


Cookies help us deliver our services. By using our services, you agree to our use of cookies.