Predefinição:Template link general/doc: diferenças entre revisões

Conteúdo apagado Conteúdo adicionado
 
mSem resumo de edição
Linha 2:
{{Subpágina de documentação}}
 
{{tsh|{{{1|tlg}}}|{{{2|}}}}}
:<small>''Esta documentação é transcluída nas páginas das predefinições {{Lp|Lpx}}, {{Lp|Lpxc}}, {{Lp|Lpxm}} e {{Lp|Lpxw}}''</small><noinclude>
{{lua|Module:Template link general}}
{{-}}
</noinclude>
 
This template, often abbreviated as {{tlf|{{#switch:{{lc:{{ROOTPAGENAME}}}}
<!-- Parent template(s) usage Begins: --->
| 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
| tlc | template link code = tlc
| tlp | template link with parameters = tlp}}
}}, is used to provide stylized formatting to template displays without actually using the template itself.
 
===Parameters===
{{tlx|tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}} → {{tlx|template|first parameter|second|third|fourth|fifth|sixth|seventh|eight|ninth}}
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"
==Purpose and naming==
! Parameter || Action || Use with<br>{{t|example}} || Default active
[[wikt:mnemônica|Mnemonically]] ''''T'''emplate '''l'''ink e'''x'''panded'... after <code>{{tlx|tl}}</code> '''T'''emplate '''l'''ink'
 
* This template takes another ''template-name'' and some associated [[w:pipe-trick|pipe-tricked]] [[meta: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:''''' Up to five pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 5 parameters can be displayed using a coded vertical-bar (as in "<small>&amp;#124;</small>''...''"). A keyword parameter can be used, when tagged as a nowiki-keyword: <nowiki>"<nowiki>siz=10<\nowiki>"</nowiki> with each keyword parameter surrounded by <nowiki>"<nowiki>"</nowiki> tags; see ''[[#Examples|Examples]]'' at bottom. For more details, see the [[w:{{TALKPAGENAME}}|this talk]] page.
* '''''Exceptions:''''' If the intended template lists numerous/keyword parameters, then perhaps this template should really ''not'' be used, and just hardcode the usage with <code><nowiki>&lt;code&gt;&lt;nowiki&gt;</code>, for example: <code><nowiki>&lt;code&gt;&lt;nowiki&gt;{{Anytemplate|arg1=23|siz=250px|</nowiki><var>other parameters...</var><nowiki>}}&lt;/nowiki&gt;&lt;/code&gt;</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>.
 
----
 
* If given no additional parameters except ''<code>&nbsp;'template&nbsp;name'&nbsp;(<nowiki>{{{1}}}</nowiki>), </code>''&nbsp;it presents the same as the similar {{tl|Tl}} [[W:macro|macro]] template -- a blue link nested in [[W:brackets|curly-braces]]-- the same as a user would apply the template without parameters, but with a noticably clearer font and spacing on most modern browsers.
 
:* {{Tlx|Tl|Tl}} display compared to {{Tlx|Tlx|Tl}}: (Tl: {{Tl|Tl}} versus Tlx: {{Tlx|Tl}})
 
* Comparatively, {{Tlx|Tl}} will not take or display additional parameters, and for minor technical reasons, may be preferred for mere listing and referencing in long pages involving a lot of template expansions.
 
* {{tlx|Tlx}} has a named parameter ''subst''. Setting this parameter to any string of length 1 or greater will place the string "subst:" before the template name, linked to [[w:Ajuda:Substituição]]. This is useful to indicate when a template should be substituted. For example {{tlx|Tlx|Welcome|<nowiki>subst=Y</nowiki>}} will display {{Tlx|Welcome|subst=Y}}.
 
* Additionally, Tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=W:', 'Tlx|SISTER=M:', 'Tlx|SISTER=Q:', 'Tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries. Small 'front end' Shell or convience templates {{Tlx|Tlxw}} and {{tlx|Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.
 
----
 
'''This usage also applies to interwiki capable template variations:'''
# {{Tl|Tlxc}} -- que contém links para templates na Wikimedia Commons (O Commons).
# {{Tl|Tlxm}} -- que contém links para templates no Meta
# {{Tl|Tlxw}} -- que contém links para templates na Wikipedia
 
----
 
==Documentação==
 
{&#123;[[Template:{{PAGENAME}}|{{PAGENAME}}]]&#125;}
is a generalization of {{Tlxw|Tl|x}}, {{Tlxw|Tlp|x|y}},
etcetera with arguably better readable
output. This depends on the browser, but too narrow
uses of "'''{'''", "'''|'''", "'''}'''" in conjunction
with links can be hard to read.
 
=== Usage ===
 
:<code>{&#123;{{PAGENAME}}{{!}}template name&#125;}</code>
:<code>{&#123;{{PAGENAME}}{{!}}template name{{!}}param&#125;}</code>
:<code>{&#123;{{PAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3&#125;}</code>
:<code>{&#123;{{PAGENAME}}{{!}}template name{{!}}1{{!}}2{{!}}3&amp;#124;more&#125;}</code>
:<code>{&#123;{{PAGENAME}}{{!}}template name{{!}}param&amp;#61;value&#125;}</code>
''Up to three placeholders for parameters of the specified template''
 
=== Examples ===
{{#ifeq:{{SITENAME}}|Wikipedia|<!-- Skip message--->|
{{#ifeq:{{SITENAME}}|Meta|<!-- No note needed --->|<!-- Other Sisters Note: --->
;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.
}}}}
 
{| border="1" cellpadding="4" class="wikitable"
! Code
! Result
! Remark
|-
| brace || Include braces as part of the template link || {{tlg|brace=yes|example}} || {{tl|tlw}}/{{tl|tn}}
|{{Tlx|SISTER=W:|Tlx|x0}}
|{{Tlx|SISTER=W:|x0}}
||&#160;
|-
| braceinside || Include innermost braces as part of the template link || {{tlg|example|braceinside=yes}} ||
|{{Tlx|SISTER=W:|Tlx|Abc}}
|{{Tlx|SISTER=W:|Abc}}
||&#160;
|-
| bold || Renders the template link/name in '''bold''' || {{tlg|bold=yes|example}} || {{tl|tlb}}, {{tl|tlxb}}
|{{Tlx|SISTER=W:|Tlx|ABC}}
|{{Tlx|SISTER=W:|ABC}}
||&#160;
|-
| code || Display output using HTML [[w:en:HTML element#code|{{tag|code}}]] tags ([[w:en:monospaced font|monospaced font]]) || {{tlg|code=yes|example}} || {{tl|tlc}}, {{tl|tlx}}, etc.
|{{Tlx|SISTER=W:|Tlx|AbC}}
|{{Tlx|SISTER=W:|AbC}}
||&#160;
|-
| italic || Display any parameters accompanying the template link/name in ''italics'' ||| {{tlg|italic=yes|example|param}} || {{tl|tlxi}}
|{{Tlx|SISTER=W:|Tlx|x1|one}}
|{{Tlx|SISTER=W:|x1|one}}
||&#160;
|-
| kbd || Display output using HTML [[w:en:HTML element#kbd|{{tag|kbd}}]] tags (monospaced font) || {{tlg|kbd=yes|example}} ||
|{{Tlx|SISTER=W:|Tlx|x2|one|two}}
|{{Tlx|SISTER=W:|x2|one|two}}
||&#160;
|-
| nolink || Don't render the template name as a link || {{tlg|nolink=yes|example}} || {{tl|tlf}}, {{t|tlc}}, {{t|tnull}}
|{{Tlx|SISTER=W:|Tlx|x3|1<code>&#124;</code>2<code>&#124;</code>3}}
|{{Tlx|SISTER=W:|x3|1|2|3}}
||&#160;
|-
| nowrap || Prevent the insertion of line breaks ([[w:en:word wrap|word wrap]]) in the output || {{tlg|nowrap=yes|example}} ||
|{{Tlx|SISTER=W:|Tlx|x4|1<code>&#124;</code>2<code>&#124;</code>3|4}}
|{ {Tlx|SISTER=W:|x4|1|2|3|4}}
|up to 5 parameters, then ...
|-
| nowrapname || Prevent word wrapping in the output of template name/link (parameters will wrap if needed) || {{tlg|nowrapname=yes|example}} ||
|{{Tlx|SISTER=W:|Tlx|x4|1<code>&#124;</code>2<code>&#124;</code>3&amp;#124;4}}
|{{Tlx|SISTER=W:|x4|1|2|3&#124;4}}
|style="text-align: right;" |<code>&amp;#124;</code> for more
|-
| plaincode || Uses {{tag|code|params=style="border:none; background:transparent;"}} || {{tlg|plaincode=yes|example}} || {{tl|tltss}}
|{{Tlx|SISTER=W:|Tlx|x1|x&#61;u}}
|{{Tlx|SISTER=W:|x1|x=u}}
|'''=''' won't work
|-
| subst || Include a [[w:en:Help:Substitution|subst:]] prefix before the template link/name || {{tlg|subst=yes|example}} || {{tl|tls}}, {{tl|tlxs}}, etc
|{{Tlx|SISTER=W:|Tlx|x1|x&amp;#61;u}}
|{{Tlx|SISTER=W:|x1|x&#61;u}}
|style="text-align: right;" |<code>&amp;#61;</code> is okay
|-
| {{para|alttext|[text]}} || Use [text] as the label for the template link || {{tlg|alttext=Other|example}} || {{tl|tla}}
|{{Tlx|SISTER=W:|Tlx|x1|x<nowiki>{{=}}</nowiki>u}}
|}
|{{Tlx|SISTER=W:|x1|x{{=}}u}}
 
|style="text-align: right;" |<code><nowiki>{{=}}</nowiki></code> is okay
====Unnamed (Positional)====
This template can take any number of [[w:en:unnamed parameter|unnamed parameters]] 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}}}|Termometro}} | {{{{{1|tlg}}}|Termometro}} | {{error|Termometro}} 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>&lt;nowiki>14|m|ftin|abbr=out|sp=us&lt;/nowiki></nowiki>}} | {{{{{1|tlg}}}|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | Unlimited parameters as one {{tag|nowiki|link=yes}} [[w:en: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}} | &lt;code&gt; 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}} | &lt;kbd&gt; 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&#61;u}} | {{{{{1|tlg}}}|x1|x=u}} | '''{{=}}''' won't work
| {{tlx|{{{1|tlg}}}|x1|x&amp;#61;u}} | {{{{{1|tlg}}}|x1|x&#61;u}} | {{align|right|<code>&amp;#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&lt;nowiki&gt;&#61;&lt;/nowiki&gt;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
|{{Tlx|SISTER=W:|Tlx|x1|&lt;nowiki&gt;x&#61;u&lt;/nowiki&gt;}}
! style="width:15em;" | Output
|{{Tlx|SISTER=W:|x1|<nowiki>x=u</nowiki>}}
|style="text-align: right;" |sticky nowiki is okay
|-
| {{tlx|{{{1|tlg}}}|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}}
|{{Tlx|SISTER=W:|Tlx|x2|&#160;|two}}
| {{{{{1|tlg}}}|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}}
|{{Tlx|SISTER=W:|x2| |two}}
|}
|empty won't work
 
{| class="wikitable" |style="background-color:transparent;"
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrap=on</kbd>)
|-
! Code
|{{Tlx|SISTER=W:|Tlx|x2|&amp;#32;|two}}
! style="width:15em;" | Output
|{{Tlx|SISTER=W:|x2|&#32;|two}}
|style="text-align: right;" |<code>&amp;#32;</code> is okay
|-
| {{tlx|{{{1|tlg}}}|nowrap{{=}}on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|{{Tlx|SISTER=W:|Tlx|x2|&amp;nbsp;|two}}
| {{{{{1|tlg}}}|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|{{Tlx|SISTER=W:|x2|&nbsp;|two}}
|}
|style="text-align: right;" |<code>&amp;nbsp;</code> is okay
 
{| class="wikitable" |style="background-color:transparent;"
|+ style="text-align:left;" | Wrapping of long names (<kbd>nowrapname=on</kbd>)
|-
! Code
|{{Tlx|SISTER=W:|Tlx|x2| &amp;#124; two}}
! style="width:15em;" | Output
|{{Tlx|SISTER=W:|x2| &#124; two}}
|style="text-align: right;" |<code>&amp;#124;</code> is okay
|-
| {{tlx|{{{1|tlg}}}|nowrapname{{=}}on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|| {{Tlx|SISTER=W:|Tlx|x2| {&#123;!&#125;} two}}
| {{{{{1|tlg}}}|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|| {{Tlx|SISTER=W:|x2| {{!}} two}}
|style="text-align: right;" |{{Tlx|SISTER=W:|!}} is dubious
|-
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=</nowiki>|<nowiki>3=two</nowiki>}}
|| {{Tlx|SISTER=W:|x2|2=|3=two}}
|empty really doesn't work
|-
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>2=one</nowiki>|two}}
|| {{Tlx|SISTER=W:|x2|two}}
|'''two''' overrides "2{{=}}one"
|-
|| {{Tlx|SISTER=W:|Tlx|x2|<nowiki>3=two</nowiki>|<nowiki>2=one</nowiki>}}
|| {{Tlx|SISTER=W:|x2|3=two|2=one}}
|style="text-align: right;" |right to left okay
|}
<!----
 
== VerSee tambémalso ==
{{Template-linking templates}}
* {{Lp|Lp}} - para criar ligações para outras predefinições sem a necessidade de parâmetros;
------>
* {{Lp|Lpu}} ou {{Lp|tlu}} – para ligações semelhantes a páginas que não são predefinições;
* {{Lp|Lpp}} ou {{Lp|tlp}} – para indicar a necessidade de ''um'' parâmetro;
* {{Lp|Lps}} ou {{Lp|tls}} – para indicar que a predefinição deve ser [[w:Wikipédia:Substituição|substituída]];
* {{Lp|Tn}} - igual a {{Tld|Lp}} mas com os colchetes como parte do link;
* {{Lp|tlf}} ou {{Lp|tld}} ou {{Lp|tlc}}- para citar a predefinição sem o link para a mesma;
<!--- Categories applied to both /doc style Documentation page and to the parent templates --->
<includeonly>
<!-- EDIT IN (calling) TEMPLATE CATEGORIES BELOW THIS LINE -->
[[Categoria:!Predefinições de ligação para predefinição|!Predefinições de ligação para predefinição]]
 
<!-- EDIT/ADD TEMPLATE interwikis BELOW THIS LINE -->