Template:Template link general/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content deleted Content added
←Replaced content with '{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->' |
m 1 revision imported from wikipedia:Template:Template_link_general/doc |
||
(15 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 --> |
||
{{#ifeq:{{FULLPAGENAME}}|Template:Template link expanded|{{used in system}}| |
|||
{{#ifexpr:{{#invoke:Transclusion count|fetch|0}} > 2000|{{high-use}}}}}} |
|||
{{tsh|{{{1|tlg}}}|{{{2|}}}}} |
|||
{{lua|Module:Template link general}} |
|||
This template, often abbreviated as {{tlf|{{#switch:{{lc:{{ROOTPAGENAME}}}} |
|||
| tlg | template link general = tlg |
|||
| tlb | template link with bold = tlb |
|||
| tlc | template link code = tlc |
|||
| tlw ||template link with linked braces = tlw |
|||
| tlf | template link with link off = tlf |
|||
| tltss | template link with title span, subst = tltss |
|||
| tlx | template link expanded = tlx |
|||
| tlxb | template link expanded with bold = tlxb |
|||
| tlxi | template link expanded with italic = tlxi |
|||
| tlxs | template link expanded with subst = tlxs |
|||
| tls | template link with subst = tls |
|||
| tnull | template link null = tnull |
|||
| tlp | template link with parameters = tlp}} |
|||
}}, is used to provide stylized formatting to template displays without actually using the template itself. |
|||
===Parameters=== |
|||
With the exception of {{mono|alttext}}, 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 ([[#Examples|see Examples below]]). Certain templates have the parameter "on" by default; see [[#General-purpose formatting|the main table]] for all alternate options. |
|||
{| class="wikitable" |
|||
! Parameter || Action || Use with<br>{{t|example}} || Default active |
|||
|- |
|||
| brace || Include braces as part of the template link || {{tlg|brace=yes|example}} || {{tl|tlw}}/{{tl|tn}} |
|||
|- |
|||
| braceinside || Include innermost braces as part of the template link || {{tlg|example|braceinside=yes}} || |
|||
|- |
|||
| bold || Renders the template link/name in '''bold''' || {{tlg|bold=yes|example}} || {{tl|tlb}}, {{tl|tlxb}} |
|||
|- |
|||
| code || Display output using HTML [[HTML element#code|{{tag|code}}]] tags ([[monospaced font]]) || {{tlg|code=yes|example}} || {{tl|tlc}}, {{tl|Template link expanded}}, etc. |
|||
|- |
|||
| 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}} |
|||
|- |
|||
| 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}} || |
|||
|- |
|||
| plaincode || Uses {{tag|code|params=style="border:none; background:transparent;"}} || {{tlg|plaincode=yes|example}} || {{tl|tltss}} |
|||
|- |
|||
| 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)==== |
|||
This template can take any number of [[unnamed parameter]]s as parameters accompanying the template link (or name); see Examples below. |
|||
===Examples=== |
|||
{{#switch:{{SITENAME}} |Wikipedia|Meta= | |
|||
; 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. |
|||
}} |
|||
{{Aligned table |
|||
|cols=3 |class=wikitable |
|||
|style=background-color:transparent;<!-- to see background of <code>...</code> --> |
|||
| '''Code''' | '''Output''' | '''Remarks''' |
|||
| {{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}}}|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}}}|Abc}} | {{{{{1|tlg}}}|Abc}} | |
|||
| {{tlx|{{{1|tlg}}}|abC}} | {{{{{1|tlg}}}|abC}} | template names are case-sensitive |
|||
| {{tlx|{{{1|tlg}}}|abc}} | {{{{{1|tlg}}}|abc}} | first letter is case-insensitive though |
|||
| {{tlx|{{{1|tlg}}}|abc|'''<nowiki>{{spaces}}</nowiki>'''{{{1}}}'''<nowiki>{{spaces}}</nowiki>'''}} | {{{{{1|tlg}}}|abc|{{spaces}}{{{1}}}{{spaces}}}}| Using {{tl|spaces}} before and after <nowiki>{{{1}}}</nowiki> parameter. |
|||
| {{tlx|{{{1|tlg}}}|x0}} | {{{{{1|tlg}}}|x0}} | |
|||
| {{tlx|{{{1|tlg}}}|x0|code{{=}}on}} | {{{{{1|tlg}}}|x0|code=on}} | <code> style |
|||
| {{tlx|{{{1|tlg}}}|x0|plaincode{{=}}on}} | {{{{{1|tlg}}}|x0|plaincode=on}} | plaincode style |
|||
| {{tlx|{{{1|tlg}}}|x0|kbd{{=}}on}} | {{{{{1|tlg}}}|x0|kbd=on}} | <kbd> style |
|||
| {{tlx|{{{1|tlg}}}|x0|bold{{=}}on}} | {{{{{1|tlg}}}|x0|bold=on}} | bold link/name |
|||
| {{tlx|{{{1|tlg}}}|x1|one|italic{{=}}on}} | {{{{{1|tlg}}}|x1|one|italic=on}} | parameter/s in italics |
|||
| {{tlx|{{{1|tlg}}}|x0|nolink{{=}}on}} | {{{{{1|tlg}}}|x0|nolink=on}} | |
|||
| {{tlx|{{{1|tlg}}}|x0|subst{{=}}on}} | {{{{{1|tlg}}}|x0|subst=on}} | |
|||
| {{tlx|{{{1|tlg}}}|x0|brace{{=}}on}} | {{{{{1|tlg}}}|x0|brace=on}} | all braces in link |
|||
| {{tlx|{{{1|tlg}}}|x0|braceinside{{=}}on}} | {{{{{1|tlg}}}|x0|braceinside=on}} | inside braces in link |
|||
| {{tlx|{{{1|tlg}}}|x0|alttext{{=}}x0 link}} | {{{{{1|tlg}}}|x0|alttext=x0 link}} | |
|||
| {{tlx|{{{1|tlg}}}|x0|bold{{=}}on|code{{=}}on|brace{{=}}on}} | {{{{{1|tlg}}}|x0|bold=on|code=on|brace=on}} | No reason you can't combine multiple parameter settings |
|||
| {{tlx|{{{1|tlg}}}|x1|one}} | {{{{{1|tlg}}}|x1|one}} | |
|||
| {{tlx|{{{1|tlg}}}|x2|one|two}} | {{{{{1|tlg}}}|x2|one|two}} | |
|||
| {{tlx|{{{1|tlg}}}|x2|bold{{=}}on|code{{=}}on|one|two}} | {{{{{1|tlg}}}|x2|bold=on|code=on|one|two}} | Can combine named and anonymous parameters … |
|||
| {{tlx|{{{1|tlg}}}|x2|one|two|bold{{=}}on|code{{=}}on}} | {{{{{1|tlg}}}|x2|one|two|bold=on|code=on}} | … in any order … |
|||
| {{tlx|{{{1|tlg}}}|x2|one|code{{=}}on|two|bold{{=}}on|three}} | {{{{{1|tlg}}}|x2|one|code=on|two|bold=on|three}} | … even intermixed … |
|||
| {{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}}}}} | {{{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&#61;u}} | {{{{{1|tlg}}}|x1|x=u}} | {{align|right|<code>&#61;</code> is okay}} |
|||
| {{tlx|{{{1|tlg}}}|x1|x<nowiki>{{=}}</nowiki>u}} | {{{{{1|tlg}}}|x1|x{{=}}u}} | {{align|right|<code><nowiki>{{=}}</nowiki></code> is okay (see [[:template:=|template equal sign]])}} |
|||
| {{tlx|{{{1|tlg}}}|x1|x<nowiki>=</nowiki>u}} | {{{{{1|tlg}}}|x1|x<nowiki>=</nowiki>u}} | {{align|right|sticky nowiki is okay}} |
|||
| {{tlx|{{{1|tlg}}}|x2|<nowiki />|two|<nowiki />|<nowiki />}} | {{{{{1|tlg}}}|x2||two||}} | empty parameters work too, even at the end |
|||
| {{tlx|{{{1|tlg}}}|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}} | {{{{{1|tlg}}}|x2|3=two|2=one}} | {{align|right|right to left okay}} |
|||
}} |
|||
{| class="wikitable" |style="background-color:transparent;" |
|||
|+ style="text-align:left;" | Wrapping of long names (default) |
|||
|- |
|||
! Code |
|||
! style="width:15em;" | Output |
|||
|- |
|||
| {{tlx|{{{1|tlg}}}|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} |
|||
| {{{{{1|tlg}}}|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} |
|||
|} |
|||
{| class="wikitable" |style="background-color:transparent;" |
|||
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrap=on</kbd>) |
|||
|- |
|||
! Code |
|||
! style="width:15em;" | Output |
|||
|- |
|||
| {{tlx|{{{1|tlg}}}|nowrap{{=}}on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
|||
| {{{{{1|tlg}}}|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
|||
|} |
|||
{| class="wikitable" |style="background-color:transparent;" |
|||
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>) |
|||
|- |
|||
! Code |
|||
! style="width:15em;" | Output |
|||
|- |
|||
| {{tlx|{{{1|tlg}}}|nowrapname{{=}}on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
|||
| {{{{{1|tlg}}}|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
|||
|} |
|||
== See also == |
|||
{{Template-linking templates}} |
|||
<includeonly>{{Sandbox other| |
|||
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> |
|||
[[Category:Internal template-link templates]] |
|||
[[Category:Wikitext typing-aid templates]] |
|||
}}</includeonly> |