Template:Template link general/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content deleted Content added
Reverted 1 edit by 2001:56A:770D:9800:2120:54BA:99AA:B6B6 (talk): Unexplained blanking |
m 1 revision imported from wikipedia:Template:Template_link_general/doc |
||
(14 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> |
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> |
||
⚫ | |||
{{#ifexpr:{{#invoke:Transclusion count|fetch|0}} > 2000|{{high-use}}}} |
{{#ifexpr:{{#invoke:Transclusion count|fetch|0}} > 2000|{{high-use}}}}}} |
||
⚫ | |||
{{tsh|{{{1|tlg}}}|{{{2|}}}}} |
{{tsh|{{{1|tlg}}}|{{{2|}}}}} |
||
{{lua|Module:Template link general}} |
{{lua|Module:Template link general}} |
||
Line 19: | Line 19: | ||
| tls | template link with subst = tls |
| tls | template link with subst = tls |
||
| tnull | template link null = tnull |
| tnull | template link null = tnull |
||
| tlc | template link code = tlc |
|||
| tlp | template link with parameters = tlp}} |
| tlp | template link with parameters = tlp}} |
||
}}, is used to provide stylized |
}}, is used to provide stylized formatting to template displays without actually using the template itself. |
||
===Parameters=== |
===Parameters=== |
||
Line 27: | Line 26: | ||
{| class="wikitable" |
{| class="wikitable" |
||
! Parameter || Action || Default active |
! Parameter || Action || Use with<br>{{t|example}} || Default active |
||
|- |
|||
⚫ | |||
|- |
|- |
||
| |
| braceinside || Include innermost braces as part of the template link || {{tlg|example|braceinside=yes}} || |
||
|- |
|- |
||
⚫ | |||
⚫ | |||
|- |
|- |
||
⚫ | |||
⚫ | |||
|- |
|- |
||
| italic || Display any parameters accompanying the template link/name in ''italics'' ||| {{tlg|italic=yes|example|param}} || {{tl|tlxi}} |
|||
⚫ | |||
|- |
|- |
||
| |
| kbd || Display output using HTML [[HTML element#kbd|{{tag|kbd}}]] tags (monospaced font) || {{tlg|kbd=yes|example}} || |
||
|- |
|- |
||
| nolink || Don't render the template name as a link || {{tlg|nolink=yes|example}} || {{tl|tlf}}, {{t|tnull}} |
|||
| kbd || Display output using HTML [[HTML element#kbd|{{tag|kbd}}]] tags (monospaced font) || |
|||
|- |
|- |
||
| |
| nowrap || Prevent the insertion of line breaks ([[word wrap]]) in the output || {{tlg|nowrap=yes|example}} || |
||
|- |
|- |
||
| |
| nowrapname || Prevent word wrapping in the output of template name/link (parameters will wrap if needed) || {{tlg|nowrapname=yes|example}} || |
||
|- |
|- |
||
⚫ | |||
| nowrapname || Prevent word wrapping in the output of template name/link (parameters will wrap if needed) || |
|||
|- |
|- |
||
| subst || Include a [[Help:Substitution|subst:]] prefix before the template link/name || {{tlg|subst=yes|example}} || {{tl|tls}}, {{tl|tlxs}}, etc |
|||
⚫ | |||
|- |
|- |
||
| |
| {{para|alttext|[text]}} || Use [text] as the label for the template link || {{tlg|alttext=Other|example}} || {{tl|tla}} |
||
|- |
|- |
||
| |
| _show_result || Will also display the result of the template. || {{tlx|Min|7|-5|_show_result=y}} || |
||
|} |
|} |
||
====Unnamed (Positional)==== |
====Unnamed (Positional)==== |
||
This template |
This template can take any number of [[unnamed parameter]]s as parameters accompanying the template link (or name); see Examples below. |
||
===Examples=== |
===Examples=== |
||
Line 66: | Line 67: | ||
|style=background-color:transparent;<!-- to see background of <code>...</code> --> |
|style=background-color:transparent;<!-- to see background of <code>...</code> --> |
||
| '''Code''' | '''Output''' | '''Remarks''' |
| '''Code''' | '''Output''' | '''Remarks''' |
||
| {{tlx|{{{1|tlg}}}| |
| {{tlx|{{{1|tlg}}}|Banner}} | {{{{{1|tlg}}}|Banner}} | {{error|Banner}} template does not exist. Be aware with linking to non-existing templates, although desired. |
||
| {{tlx|{{{1|tlg}}}|ok}} | {{{{{1|tlg}}}|ok}} | ok template does exist |
| {{tlx|{{{1|tlg}}}|ok}} | {{{{{1|tlg}}}|ok}} | ok template does exist |
||
| {{tlx|{{{1|tlg}}}|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} | {{{{{1|tlg}}}|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | Unlimited parameters as one {{tag|nowiki|link=yes}} [[Help:Wikitext#Nowiki|string]] |
| {{tlx|{{{1|tlg}}}|convert|<nowiki><nowiki>14|m|ftin|abbr=out|sp=us</nowiki></nowiki>}} | {{{{{1|tlg}}}|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | Unlimited parameters as one {{tag|nowiki|link=yes}} [[Help:Wikitext#Nowiki|string]] |
||
Line 92: | Line 93: | ||
| {{tlx|{{{1|tlg}}}|x2|one|code{{=}}on|two|bold{{=}}on|three|italic{{=}}on}} | {{{{{1|tlg}}}|x2|one|code=on|two|bold=on|three|italic=on}} | … with many different configurations. |
| {{tlx|{{{1|tlg}}}|x2|one|code{{=}}on|two|bold{{=}}on|three|italic{{=}}on}} | {{{{{1|tlg}}}|x2|one|code=on|two|bold=on|three|italic=on}} | … with many different configurations. |
||
| {{tlx|{{{1|tlg}}}|x3|1|2|3|4|5|6|7|8|9|10}} | {{{{{1|tlg}}}|x3|1|2|3|4|5|6|7|8|9|10}} | |
| {{tlx|{{{1|tlg}}}|x3|1|2|3|4|5|6|7|8|9|10}} | {{{{{1|tlg}}}|x3|1|2|3|4|5|6|7|8|9|10}} | |
||
| <code><nowiki>{{tlg|x4|1|2|3|4|5|6|7|8|9|10|11}}</nowiki></code> | {{{{{1|tlg}}}|x4|1|2|3|4|5|6|7|8|9|10|11}} | up to 10 parameters, then … |
|||
| <code><nowiki>{{tlg|x5|1|2|3|4|5|6|7|8|9|10&#124;11}}</nowiki></code> | {{{{{1|tlg}}}|x5|1|2|3|4|5|6|7|8|9|10|11}} | {{align|right|<code>&#124;</code> for more}} |
|||
| {{tlx|{{{1|tlg}}}}} | {{{1|tlg}}} | with no arguments, the current page name is substituted |
| {{tlx|{{{1|tlg}}}}} | {{{1|tlg}}} | with no arguments, the current page name is substituted |
||
| {{tlx|{{{1|tlg}}}|x1|x=u}} | {{{{{1|tlg}}}|x1|x=u}} | '''{{=}}''' won't work |
| {{tlx|{{{1|tlg}}}|x1|x=u}} | {{{{{1|tlg}}}|x1|x=u}} | '''{{=}}''' won't work |
||
Line 103: | Line 102: | ||
}} |
}} |
||
{| class="wikitable" |style=" |
{| class="wikitable" |style="background-color:transparent;" |
||
|+ style="text-align:left;" | Wrapping of long names (default) |
|+ style="text-align:left;" | Wrapping of long names (default) |
||
|- |
|- |
||
Line 113: | Line 112: | ||
|} |
|} |
||
{| class="wikitable" |style=" |
{| class="wikitable" |style="background-color:transparent;" |
||
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrap=on</kbd>) |
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrap=on</kbd>) |
||
|- |
|- |
||
Line 123: | Line 122: | ||
|} |
|} |
||
{| class="wikitable" |style=" |
{| class="wikitable" |style="background-color:transparent;" |
||
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>) |
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>) |
||
|- |
|- |
Latest revision as of 15:03, January 29, 2022
This is a documentation subpage for Template:Template link general. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This template, often abbreviated as {{tlg}}, is used to provide stylized formatting to template displays without actually using the template itself.
Parameters
With the exception of Template:Mono, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options.
Parameter | Action | Use with {{example}} |
Default active |
---|---|---|---|
brace | Include braces as part of the template link | {{Template:!((:Template:Example|example]]}} | {{tlw}}/{{tn}} |
braceinside | Include innermost braces as part of the template link | Template:!((:Template:Example|{{example}}]] | |
bold | Renders the template link/name in bold | {{Template:!((:Template:Example|example]]}} | {{tlb}}, {{tlxb}} |
code | Display output using HTML <code>...</code> tags (monospaced font) |
{{Template:!((:Template:Example|example]]}} |
{{tlc}}, {{Template link expanded}}, etc. |
italic | Display any parameters accompanying the template link/name in italics | {{Template:!((:Template:Example|example]]|param}} | {{tlxi}} |
kbd | Display output using HTML <kbd>...</kbd> tags (monospaced font) |
{{Template:!((:Template:Example|example]]}} | |
nolink | Don't render the template name as a link | {{example}} | {{tlf}}, {{tnull}} |
nowrap | Prevent the insertion of line breaks (word wrap) in the output | {{Template:!((:Template:Example|example]]}} | |
nowrapname | Prevent word wrapping in the output of template name/link (parameters will wrap if needed) | {{Template:!((:Template:Example|example]]}} | |
plaincode | Uses <code style="border:none; background:transparent;">...</code> |
{{Template:!((:Template:Example|example]]}} | {{tltss}} |
subst | Include a subst: prefix before the template link/name | {{subst:Template:!((:Template:Example|example]]}} | {{tls}}, {{tlxs}}, etc |
|alttext=[text] |
Use [text] as the label for the template link | {{Template:!((:Template:Example|Other]]}} | {{tla}} |
_show_result | Will also display the result of the template. | {{Min|7|-5}} → -5 |
Unnamed (Positional)
This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.
Examples
- Note
- On the source sister projects, en.wikipedia and Meta, X0, X1, X2, …, X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other Sister projects.
Script error: No such module "aligned table".
Code | Output |
---|---|
{{tlg|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}}
|
{{Template:!((:Template:Long template name that would wrap to new line|long template name that would wrap to new line]]|this is a long value for the 1st parameter that would wrap}} |
Code | Output |
---|---|
{{tlg|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|
{{Template:!((:Template:Long template name that would wrap to new line|long template name that would wrap to new line]]|long value for the 1st parameter that would wrap}} |
Code | Output |
---|---|
{{tlg|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|
{{Template:!((:Template:Long template name that would wrap to new line|long template name that would wrap to new line]]|long value for the 1st parameter that would wrap}} |
See also
Template:Template-linking templates