Difference between revisions of "Template:Tlg"

From The Broken Dagger Wiki
Jump to: navigation, search
(Add code parameter, update docs)
(move documentation to doc page)
Line 1: Line 1:
 
__NOTOC__<includeonly><!--
 
__NOTOC__<includeonly><!--
 +
Templates tlc, tld, tlf have the following wrapping everything; do we need it?
 +
<span style="white-space:nowrap;">
 +
--><--
 
   -- begin tt style if tt=yes given
 
   -- begin tt style if tt=yes given
 
-->{{#if:{{{tt|}}}|<tt>}}<!--
 
-->{{#if:{{{tt|}}}|<tt>}}<!--
Line 66: Line 69:
 
   -- end
 
   -- end
 
--></includeonly><noinclude>
 
--></includeonly><noinclude>
 
+
{{Documentation|Template:Tlg/doc}}
==Explanation==
+
This template is a general template for inserting a template link.  It can be used to replace or implement any of the more specific <code><nowiki>{{tl*}}</nowiki></code> templates.  Parameters are:
+
* {{code|bold{{=}}yes}}: Boldface the text, like for {{tlx|tlb}} and {{tlx|tlxb}}
+
* {{code|tt{{=}}yes}}: Use a monospaced font, like for {{tlx|tlx}} and {{tlx|tlxb}}
+
* {{code|tt{{=}}yes}}: Use the <code><nowiki><code>...</code></nowiki></code> HTML attribute (usually a monospaced font), like for {{tlx|tlc}}
+
* {{code|nolink{{=}}yes}}: Don't insert a template link, like for {{tlx|tlf}}, {{tlx|tld}}, and {{tlx|tlc}}
+
* {{code|anypage{{=}}yes}}: Allow linking to arbitrary page (not just template), as with {{tlx|tlu}}
+
* {{code|braceinside{{=}}yes}}: Put braces inside the link, like for {{tlx|tn}}
+
* {{code|subst{{=}}yes}}: Add a {{code|subst:}} prefix, like for {{tlx|tls}}
+
* {{code|alttext{{=}}FOO}}: Specify alternative surface text for a link, like for {{tlx|tla}}
+
 
+
{| class="wikitable"
+
! Code
+
! Result
+
! Remark
+
|-
+
| <code><nowiki>{{tlxb|Template name}}</nowiki></code>
+
| {{tlxb|Template name}}
+
|
+
|-
+
| <code><nowiki>{{tlxb|Template name|parameter1|parameter2}}</nowiki></code>
+
| {{tlxb|Template name|parameter1|parameter2}}
+
|
+
|-
+
| <code><nowiki>{{tlxb|Template name|parm1|parm2{{=}}foo}}</nowiki></code>
+
| {{tlxb|Template name|parm1|parm2{{=}}foo}}
+
| Equal signs need to be escaped using <code><nowiki>{{=}}</nowiki></code>.
+
|-
+
| <code><nowiki>{{tlxb}}</nowiki></code>
+
| {{tlxb}}
+
| This actually substitutes the current page name.  Useful as a self-reference; won't be linked.
+
|-
+
| <code><nowiki>{{tlxb|SISTER=m:|3x}}</nowiki></code>
+
| {{tlxb|SISTER=m:|3x}}
+
| Link to page on another wiki.
+
|}
+
 
+
I.e., it's a {{tl|tl}}-style ''template-link'' tag that boldfaces the template name, and accepts parameters. It's main use is in distinguishing between multiple templates with similar names, in documentation, talk page discussions, etc.
+
 
+
The rest of the documentation is for {{tl|tlx}}, which works the same way (although it doesn't currently behave sanely when no parameters are given; use {{tl|tlu}} instead).
+
 
+
{{Documentation|Template:Tlx/doc}}
+
 
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 
</noinclude>
 
</noinclude>

Revision as of 18:54, 10 May 2011

{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}