Template:Tlp/doc

From MansunWiki
Jump to: navigation, search


This is the {{tlp}} (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. ({{tlx}}, for instance, uses <code>...</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

{{#invoke:aligned table|table}}

See also

view · talk · edit


General-purpose formatting

  • 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 class="nowrap">...</span> tags.
  • 3 Uses monospace font but not <code>...</code>.
  • 4 Allows links to templates in any namespace.

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
{{xpd|Hatnote|Some hatnote text}} "{{hatnote|[[:Template:Xpd/code]]Template:Void}}" gives "{{#invoke:Hatnote|hatnote}}" [1] Shows code, example and a link to expand the template code
{{para|title|<var>book title</var>}} |title=book title Formats template parameters for display, with or without values

With utility links

Code example Effect
{{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}} Template:Hatnote {{safesubst:#invoke:Toolbar|main}}
{{tiw|Hatnote}} Template:hatnote (backlinks edit)
{{tltt|Hatnote}} {{Hatnote}}
{{tetl|Hatnote}} {{ Hatnote }}
links talk view
{{tsetl|Hatnote}} {{ subst:Hatnote }}
 links talk view
{{ti|Hatnote}} Template:Hatnote (talk<dot-separator>links<dot-separator>edit)
{{tic|Hatnote}} Template:Hatnote (talk links edit)
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} {{Hatnote}} (t/l)
{{twlh|Hatnote}} Template:Hatnote (links, talk)