Template:Tlc/doc - Revision history

Zwarburg: /* Examples */

2012-08-28T15:23:22Z

Examples

@@ Line 57: / Line 57: @@
 {{tlc|Tlf|Template|first_parameter|second|third|fourth|...|eighth}} → {{Tlf|Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}
-=== Examples ===
+=== Examples  ===
 Note: Wikitables make the <code>&lt;code&gt;&lt;/code&gt;</code> tags transparent, unfortunately, so the "<code>code colouring</code>" is missing in these examples.
-<table class="wikitable">
+{| border="1" class="wikitable"
  <code><nowiki>{{tlc|name|one{{=}}{{tlf|IPA|/tʃ/}}|two}}</nowiki></code>
 you can use
  <code><nowiki>{{name|one={{IPA|/tʃ/}}|two}}</nowiki></code>
 If a vertical display with parameters on their own lines is desired, this can also be laid out manually in this manner, or more rapidly done with <code><nowiki><pre>...</pre></nowiki></code>.
 Here are the codes to emulate {{tlc|tlf}}, {{tlc|tld}} and {{tlc|tlc}} using <code>&lt;nowiki&gt;</code>:
 {|
 |-
-|style="padding-right: 50px;"| <code><nowiki>&lt;nowiki&gt;{{name|one=a|two=b}}&lt;/nowiki&gt;</nowiki></code>
+! Using <code>&lt;nowiki&gt;</code>:
 |-
-|style="padding-right: 50px;"| <code><nowiki>{{tld|name|one{{=}}a|two{{=}}b}}</nowiki></code>
+| style="padding-right: 50px;" | <code><nowiki>{{tld|name|one{{=}}a|two{{=}}b}}</nowiki></code>
-|style="padding-right: 50px;"| <code><nowiki>&lt;tt&gt;&lt;nowiki&gt;{{name|one=a|two=b}}&lt;/nowiki&gt;&lt;/tt&gt;</nowiki></code>
+| style="padding-right: 50px;" | <code><nowiki><tt><nowiki>{{name|one=a|two=b}}</nowiki></tt></nowiki></code>
-|<tt><nowiki>{{name|one=a|two=b}}</nowiki></tt>
+| <tt><nowiki>{{name|one=a|two=b}}</nowiki></tt>
 |-
-|style="padding-right: 50px;"| <code><nowiki>{{tlc|name|one{{=}}a|two{{=}}b}}</nowiki></code>
+| style="padding-right: 50px;" | <code><nowiki>{{tlc|name|one{{=}}a|two{{=}}b}}</nowiki></code>
-|style="padding-right: 50px;"| <code><nowiki>&lt;code&gt;&lt;nowiki&gt;{{name|one=a|two=b}}&lt;/nowiki&gt;&lt;/code&gt;</nowiki></code>
+| style="padding-right: 50px;" | <code><nowiki><code><nowiki>{{name|one=a|two=b}}</nowiki></code></nowiki></code>
-|<code><nowiki>{{name|one=a|two=b}}</nowiki></code>
+| <code><nowiki>{{name|one=a|two=b}}</nowiki></code>
 |}

Zwarburg: /* Purpose and naming */

2012-08-28T15:22:54Z

Purpose and naming

← Older revision		Revision as of 15:22, 28 August 2012
Line 3:		Line 3:
	This page also provides the full documentation for the templates '''{{tlx\|tld}}''' and '''{{tlx\|tlf}}''', which work almost exactly identically.		This page also provides the full documentation for the templates '''{{tlx\|tld}}''' and '''{{tlx\|tlf}}''', which work almost exactly identically.

	== Purpose and naming ==		== 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 {{tlc\|tlc}}, {{tlc\|tld}}, or {{tlc\|tlf}} templates.		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 {{tlc\|tlc}}, {{tlc\|tld}}, or {{tlc\|tlf}} templates.

	These templates work similarly to {{tlc\|tl}} and {{tlc\|tlx}}, 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 {{tlx\|tl}} or {{tlx\|tlx}}, and then use {{tlc\|tlc}}, {{tlc\|tld}} or {{tlc\|tlf}} thereafter.		These templates work similarly to {{tlc\|tl}} and {{tlc\|tlx}}, 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 {{tlx\|tl}} or {{tlx\|tlx}}, and then use {{tlc\|tlc}}, {{tlc\|tld}} or {{tlc\|tlf}} thereafter.


	{\| class="wikitable"		{\| border="1" class="wikitable"
	\|-		\|-
	! Template		! Template
	! style="width:15em;"\|[[~~Wikt~~:mnemonic\|Mnemonic]]		! style="width:15em;" \| [[wikt:mnemonic\|Mnemonic]]
	! Format differentiation		! Format differentiation
	\|-		\|-
	\| {{tlc\|tlc}}		\| {{tlc\|tlc}}
	\| '''T'''emplate '''l'''ink '''c'''ode		\| '''T'''emplate '''l'''ink '''c'''ode
	\| Uses the <code><nowiki><code>...</code></nowiki></code> tags meant for showing programming code.		\| Uses the <code><nowiki><code>...</code></nowiki></code> tags meant for showing programming code.
	\|-		\|-
	\| {{tlc\|tld}}		\| {{tlc\|tld}}
	\| '''T'''emplate '''l'''ink '''d'''ialup-host		\| '''T'''emplate '''l'''ink '''d'''ialup-host
	\| Uses the <code><nowiki><tt>...</tt></nowiki></code> tags sometimes used for showing programming code. Essentially the non-linking equivalent of {{tlx\|tlx}}.		\| Uses the <code><nowiki><tt>...</tt></nowiki></code> tags sometimes used for showing programming code. Essentially the non-linking equivalent of {{tlx\|tlx}}.
	\|-		\|-
	\| {{tlc\|tlf}}		\| {{tlc\|tlf}}
	\| '''T'''emplate '''l'''ink '''f'''ormat-normal		\| '''T'''emplate '''l'''ink '''f'''ormat-normal
	\| Uses proportional-spaced font as is normal for regular text rather than a monospace font as typically used with programming code.		\| Uses proportional-spaced font as is normal for regular text rather than a monospace font as typically used with programming code.
	\|}		\|}

	The three names were based on {{tlx\|tl}} '''t'''emplate '''l'''ink', despite the fact that, unlike the actual {{tlc\|tl}} template, these three don't include an actual link. The mnemonics for {{tlc\|tld}} and {{tlc\|tlf}} were invented after the fact, since the template creator used the single letters still available rather than the preferred {{tlc\|tlt}} (using <nowiki><tt></nowiki>) and {{tlc\|tln}} (using "normal", non-coded text style) monikers.		The three names were based on {{tlx\|tl}} '''t'''emplate '''l'''ink', despite the fact that, unlike the actual {{tlc\|tl}} template, these three don't include an actual link. The mnemonics for {{tlc\|tld}} and {{tlc\|tlf}} were invented after the fact, since the template creator used the single letters still available rather than the preferred {{tlc\|tlt}} (using <nowiki><tt></nowiki>) and {{tlc\|tln}} (using "normal", non-coded text style) monikers.

	===Basic operation===		=== Basic operation ===

	Here is how these templates look. Code is to the left; actual rendering to the right:		Here is how these templates look. Code is to the left; actual rendering to the right:

	:{{tlc\|tlc\|name\|parameters}} = {{tlc\|name\|parameters}}		:{{tlc\|tlc\|name\|parameters}} = {{tlc\|name\|parameters}}
	:{{tlc\|tld\|name\|parameters}} = {{tld\|name\|parameters}}		:{{tlc\|tld\|name\|parameters}} = {{tld\|name\|parameters}}
	:{{tlc\|tlf\|name\|parameters}} = {{tlf\|name\|parameters}}		:{{tlc\|tlf\|name\|parameters}} = {{tlf\|name\|parameters}}

Zwarburg at 15:20, 28 August 2012

2012-08-28T15:20:13Z

← Older revision		Revision as of 15:20, 28 August 2012
Line 71:		Line 71:
	<tr><td>{{tlc\|tlc\|name\|\|\|three\|\|}} <td>{{tlc\|name\|\|\|three\|\|}} <td>Even shows empty parameters that come in the end.		<tr><td>{{tlc\|tlc\|name\|\|\|three\|\|}} <td>{{tlc\|name\|\|\|three\|\|}} <td>Even shows empty parameters that come in the end.

	<tr><td>{{tlc\|tlc\|name\|one{{=}}a\|two{{=}}b}} <td>{{tlc\|name\|one=a\|two=b}} <td>The use of equal signs is a problem, but there is a fix; see next row.
	</table>		</table>

Zwarburg: Created page with "This is the '''{{tlc|tlc}}''' template. This page also provides the full documentation for the templates '''{{tlx|tld}}''' and '''{{tlx|tlf}}''', which work almost exactly ident…"

2012-08-28T15:19:33Z

Created page with "This is the '''{{tlc|tlc}}''' template. This page also provides the full documentation for the templates '''{{tlx|tld}}''' and '''{{tlx|tlf}}''', which work almost exactly ident…"

New page

This is the '''{{tlc|tlc}}''' template.

This page also provides the full documentation for the templates '''{{tlx|tld}}''' and '''{{tlx|tlf}}''', which work almost exactly identically.

== 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 {{tlc|tlc}}, {{tlc|tld}}, or {{tlc|tlf}} templates.

These templates work similarly to {{tlc|tl}} and {{tlc|tlx}}, 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 {{tlx|tl}} or {{tlx|tlx}}, and then use {{tlc|tlc}}, {{tlc|tld}} or {{tlc|tlf}} thereafter.

{| class="wikitable"
|-
! Template
! style="width:15em;"|[[Wikt:mnemonic|Mnemonic]]
! Format differentiation
|-
| {{tlc|tlc}}
| '''T'''emplate '''l'''ink '''c'''ode
| Uses the <code><nowiki><code>...</code></nowiki></code> tags meant for showing programming code.
|-
| {{tlc|tld}}
| '''T'''emplate '''l'''ink '''d'''ialup-host
| Uses the <code><nowiki><tt>...</tt></nowiki></code> tags sometimes used for showing programming code. Essentially the non-linking equivalent of {{tlx|tlx}}.
|-
| {{tlc|tlf}}
| '''T'''emplate '''l'''ink '''f'''ormat-normal
| Uses proportional-spaced font as is normal for regular text rather than a monospace font as typically used with programming code.
|}

The three names were based on {{tlx|tl}} '''t'''emplate '''l'''ink', despite the fact that, unlike the actual {{tlc|tl}} template, these three don't include an actual link. The mnemonics for {{tlc|tld}} and {{tlc|tlf}} were invented after the fact, since the template creator used the single letters still available rather than the preferred {{tlc|tlt}} (using <nowiki><tt></nowiki>) and {{tlc|tln}} (using "normal", non-coded text style) monikers.

===Basic operation===

Here is how these templates look. Code is to the left; actual rendering to the right:

:{{tlc|tlc|name|parameters}} = {{tlc|name|parameters}}
:{{tlc|tld|name|parameters}} = {{tld|name|parameters}}
:{{tlc|tlf|name|parameters}} = {{tlf|name|parameters}}

==Documentation==

===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.
*Specifics here??? 
*Features of {{tlc|tlc}}, {{tlc|tld}} and {{tlc|tlf}}:
** They show a template name and up to eight parameters.
** They also show empty parameters. (See examples hereafter.)
** They prevent line wraps in their output.

===Usage===

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

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

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

=== Examples ===

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>{{tlc|tlc}} <td>{{tlc}} <td>Shows its own syntax.
<tr><td>{{tlc|tlc|name}} <td>{{tlc|name}} <td>
<tr><td>{{tlc|tlc|name|one}} <td>{{tlc|name|one}} <td>
<tr><td>{{tlc|tlc|name|one|two}} <td>{{tlc|name|one|two}} <td>
<tr><td><code><nowiki>{{tlc|name|a|b|c|d|e|f|g|h|i|j}}</nowiki></code> <td>{{tlc|name|a|b|c|d|e|f|g|h|i}} <td>Shows up to eight parameters. The rest are dropped.
<tr><td>{{tlc|tlc|name|||three|four}} <td>{{tlc|name|||three|four}} <td>Also shows empty parameters.
<tr><td>{{tlc|tlc|name|||three||}} <td>{{tlc|name|||three||}} <td>Even shows empty parameters that come in the end.

<tr><td>{{tlc|tlc|name|one{{=}}a|two{{=}}b}} <td>{{tlc|name|one=a|two=b}} <td>The use of equal signs is a problem, but there is a fix; see next row.
</table>

An alternative to using constructs such as <code><nowiki>{{=}}</nowiki></code> and <code><nowiki>{{tlf|...}}</nowiki></code> to prevent characters from getting interpreted syntactically is to use <code><nowiki><code><nowiki>...</nowiki></code></nowiki></code>, which will prevent '''all''' characters from being interpreted. For example, in place of
<code><nowiki>{{tlc|name|one{{=}}{{tlf|IPA|/tʃ/}}|two}}</nowiki></code>
you can use
<code><nowiki><code><nowiki>{{name|one={{IPA|/tʃ/}}|two}}</nowiki></code></nowiki></code>
Both render as
<code><nowiki>{{name|one={{IPA|/tʃ/}}|two}}</nowiki></code>

If a vertical display with parameters on their own lines is desired, this can also be laid out manually in this manner, or more rapidly done with <code><nowiki><pre>...</pre></nowiki></code>.

Here are the codes to emulate {{tlc|tlf}}, {{tlc|tld}} and {{tlc|tlc}} using <code><nowiki></code>:

{|
! Using templates: !! Using <code><nowiki></code>: !! Rendered result:
|-
|style="padding-right: 50px;"| <code><nowiki>{{tlf|name|one{{=}}a|two{{=}}b}}</nowiki></code>
|style="padding-right: 50px;"| <code><nowiki><nowiki>{{name|one=a|two=b}}</nowiki></nowiki></code>
|<nowiki>{{name|one=a|two=b}}</nowiki>
|-
|style="padding-right: 50px;"| <code><nowiki>{{tld|name|one{{=}}a|two{{=}}b}}</nowiki></code>
|style="padding-right: 50px;"| <code><nowiki><tt><nowiki>{{name|one=a|two=b}}</nowiki></tt></nowiki></code>
|<tt><nowiki>{{name|one=a|two=b}}</nowiki></tt>
|-
|style="padding-right: 50px;"| <code><nowiki>{{tlc|name|one{{=}}a|two{{=}}b}}</nowiki></code>
|style="padding-right: 50px;"| <code><nowiki><code><nowiki>{{name|one=a|two=b}}</nowiki></code></nowiki></code>
|<code><nowiki>{{name|one=a|two=b}}</nowiki></code>
|}