Difference between revisions of "Template:Tl/doc"

From Crews Genealogy Wiki: focusing on the Wiregrass south, and related families
Jump to navigation Jump to search
m (1 revision)
 
m (1 revision)
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:
  
 
::<code><nowiki>{{Tl|Example}}</nowiki></code>
 
::<code><nowiki>{{Tl|Example}}</nowiki></code>
 
 
:generates
 
:generates
 +
::{{Tl|Example}}
  
::{{Tl|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.
 
More complex variations are described below.
  
===Example===
+
==Example==
 
{| class="wikitable"
 
{| class="wikitable"
 
! Code
 
! Code
Line 29: Line 38:
 
|-
 
|-
 
| <code><nowiki>{{Tl2|SISTER=wikibooks|LANG=de:|WP}}</nowiki></code>
 
| <code><nowiki>{{Tl2|SISTER=wikibooks|LANG=de:|WP}}</nowiki></code>
| <tt><nowiki>{{</nowiki>[http://de.wikibooks.org/wiki/Vorlage:WP WP]<nowiki>}}</nowiki></tt><!---
+
| <tt><nowiki>{{</nowiki>[http://de.wikibooks.org/wiki/Vorlage:WP WP]<nowiki>}}</nowiki></tt><!--
----- This is currently a fraudulent output result... the template code needs modified to work
+
––––– This is currently a fraudulent output result... the template code needs modified to work
----- per this plan, then this /doc file fixed up to match whatever the correct syntax actually is.
+
––––– per this plan, then this /doc file fixed up to match whatever the correct syntax actually is.
----- ALMOST work:  
+
––––– ALMOST work:  
 
[[:de:wikibooks:{{ns:template}}:WP|WP]]
 
[[:de:wikibooks:{{ns:template}}:WP|WP]]
 
[[de:wikibooks:{{ns:template}}:WP|WP]]
 
[[de:wikibooks:{{ns:template}}:WP|WP]]
---->
+
-->
 
|-
 
|-
 
| <code><nowiki>{{Tl|1==)}}</nowiki></code>
 
| <code><nowiki>{{Tl|1==)}}</nowiki></code>
Line 41: Line 50:
 
|}
 
|}
  
===See also===
+
==See also==
 
{{Tl-nav}}
 
{{Tl-nav}}
* [[Template:Para]]
 
  
 
<includeonly>
 
<includeonly>

Latest revision as of 20:06, 7 February 2014


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
{{Tl|Void}} {{Void}}
{{Tl2|X1}} {{X1}}
{{Tl2|SISTER=M:|3x}} {{3x}}
{{Tl2|SISTER=wikibooks|LANG=de:|WP}} {{WP}}
{{Tl|1==)}} {{=)}}

See also

Template linking templates<span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>
Link style → Linked Unlinked Linked with subst Linked including braces Linked with alternative text
Text style ↓ {{tlg}} option1 <syntaxhighlight lang="text" class="" id="" style="" inline="1">nolink=yes</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">subst=yes</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">braceinside=yes</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">alttext=FOO</syntaxhighlight>
Normal {{tl}} · {{tlp}}2 · {{tlg}}1, 2 {{tlf}}2 {{tls}} · {{tlsp}} {{tn}} {{tla}}
Code <syntaxhighlight lang="text" class="" id="" style="" inline="1">code=yes</syntaxhighlight> or
<syntaxhighlight lang="text" class="" id="" style="" inline="1">tt=yes</syntaxhighlight>
{{tlx}} {{tlc}}2 · {{tld}} · {{tnull}} {{tlxs}}  
Bold <syntaxhighlight lang="text" class="" id="" style="" inline="1">bold=yes</syntaxhighlight> {{tlb}}  
Bold code <syntaxhighlight lang="text" class="" id="" style="" inline="1">bold=yes|code=yes</syntaxhighlight> {{tlxb}}
Italic code <syntaxhighlight lang="text" class="" id="" style="" inline="1">italic=yes|code=yes</syntaxhighlight> {{tlxi}}
NOTES:  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 of ‎<span class="nowrap">...‎</span> tags.


Style comparison
  • {{tlf|Milford Haven Line|弘安源氏論議}} …renders… {{Milford Haven Line|弘安源氏論議}}
  • {{tld|Milford Haven Line|弘安源氏論議}} …renders… {{Milford Haven Line|弘安源氏論議}}
  • {{tlc|Milford Haven Line|弘安源氏論議}} …renders… {{Milford Haven Line|弘安源氏論議}}


For parameter description
  • {{para|name|{{var|value}}}} …renders… |name=value
  • {{para|name|{{varserif|value}}}} …renders… |name=value
  • {{tlx|Milford Haven Line|first parameter{{=}}first value}} …renders… {{Milford Haven Line|first parameter=first value}}

See also

Template:Tl templates