Template:Tl/doc

From 'City of Adelaide' History and Genealogy Site
Jump to navigation Jump to search

{{#invoke:Message box|mbox}}


The template link template is a simple macro template used to display a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation. A short example is that the code:

{{tl|Example}}
generates
{{Example}}

<templatedata>{ "description": "This template displays a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation.", "params": { 

 "1": {
   "label": "template name",
   "description": "the template name without the namespace prefix “Template:”, which is added automatically",
   "type": "string",
   "required": true
 }

}}</templatedata>

More complex variations are described below.

Example

Code Result Notes
{{tl|Void}} {{Void}} Standard usage
{{tls|Void}} {{subst:Example}} For templates that should be substituted
{{tl2|X1}} {{X1}} This formats the link to show how it would look in code
{{tl2|SISTER=M:|3x}} {{3x}} Same as above, for templates on another Wikimedia project (such as meta)
{{tl2|SISTER=wikibooks|LANG=de:|WP}} {{[hcodep://de.wikibooks.org/wiki/Vorlage:WP WP]}} For templates on another language project
{{tl|1==)}} {{=)}} Use the format {{tl|1=templatename}} if the template contains template coding characters such as {{=)}} or {{!}}

See also

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 → N/A <syntaxhighlight lang="text" enclose="none">nolink=yes</syntaxhighlight> <syntaxhighlight lang="text" enclose="none">subst=yes</syntaxhighlight> <syntaxhighlight lang="text" enclose="none">braceinside=yes</syntaxhighlight> <syntaxhighlight lang="text" enclose="none">alttext=Foo</syntaxhighlight>
<syntaxhighlight lang="text" enclose="none">2=Foo</syntaxhighlight>
Normal N/A {{tlg}}1, 2
{{tl}}
{{tlp}}2
{{tlu}}4 		{{tlf}}2 {{tls}}
{{tlsp}} 		{{tn}} {{tla}}
Code <syntaxhighlight lang="text" enclose="none">code=yes</syntaxhighlight> or
<syntaxhighlight lang="text" enclose="none">tt=yes</syntaxhighlight> 		{{tlx}}
{{tltt}}
{{tltt2}} 		{{tlc}}2
{{tld}}2
{{tnull}} 		{{tlxs}}
{{tltts}}
{{Tltts3}}
{{Tltss}}3 		N/A
Bold <syntaxhighlight lang="text" enclose="none">bold=yes</syntaxhighlight> {{tlb}} N/A
Bold code code=yes</syntaxhighlight> {{tlxb}}
Italic code code=yes</syntaxhighlight> {{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 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}}" [1] Shows code, example and a link to expand the template code

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 · Module:hatnote)
{{tfd links|Hatnote}}
{{tiw|Hatnote}} Template:hatnote (backlinks edit)
{{tltt|Hatnote}} {{Hatnote}}
{{tetl|Hatnote}} {{ Hatnote }}
links talk view
{{Tlsetl|Hatnote}} {{ subst:Hatnote }}
 links talk view
{{ti|Hatnote}} Template:Hatnote (talk · links · 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)


Retrieved from ‘http://cityofadelaide.org/mw/index.php?title=Template:Tl/doc&oldid=15479’