Template:Tlc/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Davidgothberg
(Intermediate save.)
meta>Davidgothberg
(Starting to look like documentation.)
Line 10: Line 10:
* {{tlf|tlf}} – Works the same, but looks like this: {{tlf|name|parameter}}
* {{tlf|tlf}} – Works the same, but looks like this: {{tlf|name|parameter}}


When writing documentation you might want to avoid a lot of unnecessary links, since it decreases readability. So on the first occurrence of a template name use {{tl|tl}} or {{tlx|tlx}}, and then use {{tlc|tlc}}, {{tld|tld}} or {{tlf|tlf}}.


Writing {{tlc|tlc|template name|parameter}} corresponds to writing
Features of {{tlc|tlc}}, {{tld|tld}} and {{tlf|tlf}}:
<code><nowiki>&lt;code>&lt;nowiki>{{template&nbsp;name|parameter}}&lt;/nowiki>&lt;/code></nowiki></code> and produces the output {{tlc|template name|parameter}}.
* They show a template name and up to eight parameters.
 
* They understand empty parameters and show them. (See examples below.)
 
* They prevent their output from [[line wrap]]ping.
When writing documentation you might want to avoid a lot of unnecessary links, since it decreases readability. So on the first occurrence of a template name use {{tl|tl}} or {{tlx|tlx}}, and then use {{tlc|tlc}}, {{tld|tld}} or {{tlf|tlf}}.


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


Wikitables like this one make the <code>&lt;code></code> tags transparent, that's why we don't see the "<code>code colouring</code>" in these examples.  
Wikitables like this one make the <code>&lt;code></code> tags transparent, that's why the "<code>code colouring</code>" is missing in these examples.  


<table class="wikitable">
<table class="wikitable">
Line 32: Line 32:


</table>
</table>


=== See also ===
=== See also ===

Revision as of 07:21, 21 March 2008

This is the {{tlc}} template.

This template helps writing documentation which mentions {{templates}}, or even {{templates|that|has|parameters}}. It works similarly to {{tl}} and {{tlx}}, but it doesn't make the template name into a link.

This page is also the documentation for some other templates:

  • {{tld}} – Works the same, but looks like this: {{name|parameter}}
  • {{tlf}} – Works the same, but looks like this: {{name|parameter}}

When writing documentation you might want to avoid a lot of unnecessary links, since it decreases readability. So on the first occurrence of a template name use {{tl}} or {{tlx}}, and then use {{tlc}}, {{tld}} or {{tlf}}.

Features of {{tlc}}, {{tld}} and {{tlf}}:

  • They show a template name and up to eight parameters.
  • They understand empty parameters and show them. (See examples below.)
  • They prevent their output from line wrapping.

Examples

Wikitables like this one make the <code> tags transparent, that's why the "code colouring" is missing in these examples.

CodeResultComment
{{tlc}} {{tlc|...}} Shows its own syntax
{{tlc|name}} {{name}}
{{tlc|name|one}} {{name|one}}
{{tlc|name|one|two}} {{name|one|two}}
{{tlc|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.
{{tlc|name|||three|four}} {{name|||three|four}} Also shows empty parameters.
{{tlc|name|||three||}} {{name|||three||}} Even shows empty parameters that come in the end.

See also