42,316
edits
Template:Tlsc/doc: Difference between revisions
m
remove { from templates
(Created page with '{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> This is the '''{{tlc|tlsc}}''' template. This page also provides the full doc…') |
m (remove { from templates) |
||
| Line 4: | Line 4: | ||
This is the '''{{tlc|tlsc}}''' template. | This is the '''{{tlc|tlsc}}''' template. | ||
This page also provides the full documentation for the templates ''' | This page also provides the full documentation for the templates '''tlx tlsd''' and '''tlx tlsf''', 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|tlsc}}, | 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|tlsc}}, tlc tlsd, or tlc tlsf templates. | ||
These templates work similarly to {{tlc|tls}} and {{tlc|tlsp}}, 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|tls}} or {{tlx|tlsp}}, and then use {{tlc|tlsc}}, | These templates work similarly to {{tlc|tls}} and {{tlc|tlsp}}, 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|tls}} or {{tlx|tlsp}}, and then use {{tlc|tlsc}}, tlc tlsd or tlc tlsf thereafter. | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 22: | Line 22: | ||
| 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 tlsd | ||
| '''T'''emplate '''l'''ink '''s'''ubstitution '''d'''ialup-host | | '''T'''emplate '''l'''ink '''s'''ubstitution '''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|tlsx}}. | | Uses the <code><nowiki><tt>...</tt></nowiki></code> tags sometimes used for showing programming code. Essentially the non-linking equivalent of {{tlx|tlsx}}. | ||
| Line 31: | Line 31: | ||
|} | |} | ||
The three names were based on {{tlx|tls}} '''t'''emplate '''s'''ubstitution '''l'''ink', despite the fact that, unlike the actual {{tlc|tls}} template, these three don't include an actual link. The mnemonics for | The three names were based on {{tlx|tls}} '''t'''emplate '''s'''ubstitution '''l'''ink', despite the fact that, unlike the actual {{tlc|tls}} template, these three don't include an actual link. The mnemonics for tlc tlsd and tlc tlsf 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=== | ||
| Line 38: | Line 38: | ||
:{{tlc|tlsc|name|parameters}} = {{tlsc|name|parameters}} | :{{tlc|tlsc|name|parameters}} = {{tlsc|name|parameters}} | ||
: | :tlc tlsd name parameters = tlsd name parameters | ||
: | :tlc tlsf name parameters = tlsf name parameters | ||
===Use with editprotected templates=== | ===Use with editprotected templates=== | ||
| Line 55: | Line 55: | ||
* This template takes another ''template-name'' and some associated [[Help:Pipe trick|pipe-tricked]] [[m:Parameter#Parameters|(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. | * This template takes another ''template-name'' and some associated [[Help:Pipe trick|pipe-tricked]] [[m:Parameter#Parameters|(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??? <!-- Coding details, other parameters (SUBST?), other notes? Cf. [[Template:Tlx]] --> | *Specifics here??? <!-- Coding details, other parameters (SUBST?), other notes? Cf. [[Template:Tlx]] --> | ||
*Features of {{tlc|tlsc}}, | *Features of {{tlc|tlsc}}, tlc tlsd and tlc tlsf: | ||
** They show the "subst:" needed in order to substitute a template. | ** They show the "subst:" needed in order to substitute a template. | ||
** They show a template name and up to eight parameters. | ** They show a template name and up to eight parameters. | ||
| Line 100: | Line 100: | ||
* {{tl|tlsc}} – Not linked, several parameters and text in <code><code></code></code> style. | * {{tl|tlsc}} – Not linked, several parameters and text in <code><code></code></code> style. | ||
* | * tl tlsd – Not linked, several parameters and <tt>teletype</tt> text style. | ||
* | * tl tlsf – Not linked, several parameters and normal text style. | ||
* {{tl|tls}} – Template link, no parameters and normal text style. | * {{tl|tls}} – Template link, no parameters and normal text style. | ||