View source for Template:Tc/doc

<noinclude>{{doc subpage}}[[Category:Template documentation]]<!-- please consider whether changes made to the documentation here should also be made to [[Template:Tcnc/doc]] --></noinclude>
== Documentation ==

This template is used in [[:Category:Template documentation|template documentation]] to display wiki markup representing a template call, possibly including parameter values, as shown in the examples below. It should only be used on talk pages or in template documentation (or help pages, user pages, etc.), '''not in articles'''.

Unlike [[Template:Tl]], this template does not provide a link on the name of the template in the displayed markup. If you want such a link, use {{tl|tl}} instead.

If no input is given to the template, it uses the phrase "template call"<includeonly> (as seen above)</includeonly>, but this can be suppressed by passing the template ''empty'' input (i.e., {{tc|tc{{!}}}} — see the examples below).

This template styles the template call as {{code}}. To display the raw markup as plain text, {{tcnc|like this}}, use {{tl|tcnc}}.

{{template name explanation|t|emplate |c|all}}

{{high-usage-template warning}}

=== Usage ===

* {{tc-var|tc|template name}}
* {{tc-var|tc|template name|parameter}}
* {{tc-var|tc|template name|parameter1|parameter2|…|add={{pn|add|sp}}}}

Up to 19 parameters can be displayed. If you need more, you can use {{tp|add}}, as explained in the documentation of {{tc|[[Template:tc-var/doc#Using add|tc-var]]}}.

=== Examples ===

* {{tc|tc}} ⇒ {{tc}}
* {{tc|tc{{!}}}} ⇒ {{tc|}}
* {{tc|tc|tc<nowiki>{{!}}</nowiki>}} ⇒ {{tc|tc{{!}}}}
* {{tc|tc|code}} ⇒ {{tc|code}}
* {{tc|tc|code|span}} ⇒ {{tc|code|span}}
* {{tc|tc|abbr|NOK|Norwegian krone}} ⇒ {{tc|abbr|NOK|Norwegian krone}}
* <code><nowiki>{{tc|ytv|v{{=}}|t{{=}}|linktext{{=}}}}</nowiki></code> ⇒ {{tc|ytv|v{{=}}|t{{=}}|linktext{{=}}}}

As seen in the last example, when illustrating calls with multiple named parameters, there is little benefit in using this template over simply wrapping the entire sample template call in {{htag|nowiki}} tags. In particular, the same thing could be accomplished by doing:
* <code><nowiki>&lt;code>&lt;nowiki>{{ytv|v=|t=|linktext=}}&lt;/nowiki>&lt;/code></nowiki></code> ⇒ <code><nowiki>{{ytv|v=|t=|linktext=}}</nowiki></code>

But there are also variations on this template that can (arguably) make such things even easier (in this case, {{tl|tc-names}}). These are listed below.

=== See also ===

* {{tl|tcnc}} — same as this template, but renders the template link as plain text ({{tt|<u>n</u>ot <u>c</u>ode}})
* {{tl|tl}} — similar to this template, but links the template name

{{List of similar tc templates|nobold=<noinclude>y</noinclude>}}

<includeonly>
[[Category:Templates]]
[[Category:Templates for illustrating wiki markup]]
[[Category:Templates especially useful in template documentation]]
[[Category:Templates that can be called with or without input]]
</includeonly>