Goraf: +Category:Formatting and function templates

2015-12-02T14:50:39Z

+Category:Formatting and function templates

← Older revision		Revision as of 17:50, 2 December 2015
Line 51:		Line 51:
	<includeonly>		<includeonly>
	<!-- Categories go here -->		<!-- Categories go here -->
			[[Category:Formatting and function templates]]
	</includeonly>		</includeonly>

Goraf: Template:Tc/doc

2015-11-29T21:03:49Z

Template:Tc/doc

New page

{{Documentation subpage}}

This page provides documentation for {{Tl|Tc}}.

== Purpose and naming ==

When a template name with braces is to be shown in documentation, the braces have to be escaped in some way so it doesn't become an actual call to the template. Instead of using <code><nowiki></nowiki></code> tags you can write it more simply and concisely by using the {{Tc|Tc}} template.

This template works similarly to {{Tc|Tl}}, but don't make the template name into a link. When writing documentation you might want to avoid a lot of unnecessary links, since they can decrease readability. So on the first occurrence of a template name use {{Tl|Tl}}, and then use {{Tc|Tc}}.

== Functional details ==

* This template takes another ''template-name'' and some associated pipe-tricked (numbered) parameters (or 'pass parameters'), and displays them as an 'example demonstration' of how the ''template-name'' template could be coded, literally. Its primary use is in instruction and documentation.
* Features:
** shows a template name and a lot of parameters,
** also show empty parameters, (See examples hereafter.)
** prevent line wraps in their output by default. (Can be changed using the <code>linewrap=yes</code> parameter.)

== Usage ==

{{Tc|Tc|Template|first_parameter|second|third|fourth|...|eighth}} → {{Tc|Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

== Examples ==
{{Todo| needs revision, adjustments}}
Note: Wikitables make the <code><code></code></code> tags transparent, unfortunately, so the "<code>code colouring</code>" is missing in these examples.

<table class="wikitable">
<tr><th>Code<th>Result<th>Comment
<tr><td>{{Tc|Tc}} <td>{{Tc}} <td>Shows its own syntax.
<tr><td>{{Tc|Tc|name}} <td>{{Tc|name}} <td>
<tr><td>{{Tc|Tc|name|one}} <td>{{Tc|name|one}} <td>
<tr><td>{{Tc|Tc|name|one|two}} <td>{{Tc|name|one|two}} <td>
<tr><td><code><nowiki>{{Tc|name|a|b|c|d|e|f|g|h|i|j}}</nowiki></code> <td>{{Tc|name|a|b|c|d|e|f|g|h|i}} <td>Shows up to eight parameters. The rest are dropped.
<tr><td>{{Tc|Tc|name|||three|four}} <td>{{Tc|name|||three|four}} <td>Also shows empty parameters.
<tr><td>{{Tc|Tc|name|||three||}} <td>{{Tc|name|||three||}} <td>Even shows empty parameters that come in the end.

<tr><td>{{Tc|Tc|name|one{{=}}a|two{{=}}b}} <td>{{Tc|name|one=a|two=b}} <td>The use of equal signs is a problem, but there is a fix; see next row.
<tr><td>{{Tc|Tc|name|one{{lb}}{{=}}{{rb}}a|two{{lb}}{{=}}{{rb}}b}} <td>{{Tc|name|one{{=}}a|two{{=}}b}} <td>Use <code><nowiki>{{=}}</nowiki></code> in place of an equal sign, so that it gets rendered properly.

<tr><td>{{Tc|Tc|name|{{Tc|IPA|/tʃ/}}|two}} <td>{{Tc|Tc|name|{{IPA|/tʃ/}}|two}} <td>Nested template calls also cause problems ...
<tr><td><code><nowiki>{{Tc|name|{{Tc|IPA|/tʃ/}}|two}}</nowiki></code> <td>{{Tc|Tc|name|{{Tc|IPA|/tʃ/}}|two}} <td>... but there are ways to get around this issue, also.
<tr><td><code><nowiki>{{Tc|name|{{((}}IPA{{!}}/tʃ/{{))}}|two}}</nowiki></code> <td>{{Tc|Tc|name|{{Tc|IPA|/tʃ/}}|two}} <td>... another way to do the same thing, using <code><nowiki>{{((}}</nowiki></code>, <code><nowiki>{{!}}</nowiki></code> and <code><nowiki>{{))}}</nowiki></code> to insert literal <code><nowiki>{{</nowiki></code>, <code><nowiki>|</nowiki></code> and <code><nowiki>}}</nowiki></code>, respectively.
</table>

== See also ==
* {{Tl|Tl}}

<includeonly>


</includeonly>

Template:Tc/doc - Revision history

Goraf: +Category:Formatting and function templates

Goraf: Template:Tc/doc