Ajuda:Modelos

Nota: Quando modificais esta página, estais a aceitar que a vossa contribuição se publique no marco de CC0. Olhem Páginas de ajuda de domínio público para mais informação.

Se possui textos padrão que deseja incluir em várias páginas, a funcionalidade de modelo do MediaWiki entra em ação. Ao contrário das extensões e dos ficheiros multimédia, não existe nenhum repositório central para os modelos. Os modelos podem ser escritos a partir do zero ou para evitar a duplicação de trabalho já efetuado, exportados de outra wiki (por exemplo, da Wikipédia) e importados para a wiki de destino. Templates can be newly written or, to save duplicating work already done, exported from another wiki e.g. Wikipedia, and then imported into the target wiki.

Basic usage

Os modelos são páginas wiki padrão, cujo conteúdo é destinado para ser transcrito (integrado) noutras páginas. Por convenção, os nomes dos modelos devem ter o prefixo «Template:», que os coloca nesse espaço nominal; além disto, pode criá-los como qualquer outra página wiki.

To transclude a template, you used double open & close curly brackets {{template name}}.

O uso mais simples de plantilles é o seguinte. Se criais uma página denominada "Plantilla:Bem-vinda" que contenha:

Olá! Bem-vindo à wiki.

terá criado o seu primeiro modelo. Se depois inserir o código:

{{Bem-vindo}}

em qualquer outra página, quando essa página é visualizada o texto «Olá! Bem-vindo à Wiki.» irá aparecer em vez de {{Bem-vindo}}. O conteúdo do modelo foi "transcrito" noutra página, isto é, este foi integrado nela.

Depois pode inserir o código {{Bem-vindo}} em qualquer ponto de qualquer página onde deseje dar as boas-vindas a alguém. Imagine que o utiliza em 100 páginas. Se depois alterar os conteúdos do modelo para:

Olá! Bem-vindo a esta wiki maravilhosa.

e revisitar qualquer das 100 páginas onde utilizou o modelo, verá o novo texto em vez do antigo. Desta forma, alterou o conteúdo das 100 páginas sem as editar, porque o modelo é transcrito nestas páginas.

Este é o mecanismo básico. Existem várias opções que enriquecem este mecanismo e tornam os modelos extremamente úteis.

Ways to invoke a template

Os modelos podem ser utilizados noutras páginas nas seguintes formas:

• {{Nome}} — como descrito acima, este texto da wiki é dinamicamente substituído pelo conteúdo atual da página [[Template:Nome]] quando uma página com este texto wiki for carregada. O texto wiki mantém-se inalterado no código-fonte da página.

Because the template call remains in the pages's source, any subsequent change to Template:Name will be seen on the page containing the template call. Also, the page will be listed among those that "link to" the template.

• {{subst:Nome}} — quando este texto wiki for usado numa página, ele será substituído uma única vez e definitivamente pelo conteúdo da predefinição [[Template:Nome]] no momento em que a página for gravada. No ato de gravação, uma cópia do conteúdo de [[Template:Nome]] é inserida em substituição do texto wiki. Este conteúdo torna-se, portanto, parte integrante do conteúdo da página e pode depois ser editado nesta, separadamente do original na página da predefinição. Nota: alterações posteriores da predefinição, não serão propagadas para a página de destino.

That is, a copy of the contents of Template:Name will be substituted for the template call. No link is maintained between the page and the template, so each can be edited further without affecting the other. In effect, there is little difference between substituting the content in this way and simply typing it into the page's source "manually". See Help:Substitution for more information.

• {{safesubst:Nome}} — este texto wiki foi introduzido para permitir uma forma de substituição que não quebra a transclusão; consulte w:en:Help:Substitution#The safesubst: modifier para mais detalhes.

See Help:Substitution for more information.

• {{msgnw:Nome}} este texto wiki também integra o conteúdo da predefinição na página, mas na forma não interpretada pelo analisador sintático (tal como se estivesse rodeado pelo texto wiki <nowiki>) quando a página que o contém é carregada.

For example, {{msgnw:Template:Thankyou}} displays:

<noinclude> <languages/> </noinclude> '''Obrigadinho...''' {{{reason|{{{1}}}}}}. Abraço, {{{signature|{{{2}}}}}} <noinclude> [[Category:Template examples{{#translation:}}|{{PAGENAME}}]] </noinclude>.

De facto, qualquer página normal da wiki pode ser usada como uma predefinição se for especificado o espaço nominal onde ela reside, assim:

• {{Template:Nome da página}} transclui a página [[Template:Nome da página]]

• {{Talk:Nome da página}} transclui a página [[Talk:Nome da página]]

• {{:Nome da página}} transclui a página [[Nome da página]]

• • {{subst::Nome da página}} substitui-se a si próprio pelo conteúdo da página [[Nome da página]]

Se o espaço nominal especificado não existir, o MediaWiki assume que o título completo é uma predefinição:

• {{Xpto:Nome da página}} transclui a página [[Template:Xpto:Nome da página]]

Regardless of what syntax is used, the name of the template can be relative to the current page For example, if {{/bar}} is called on page foo, it will transclude the page foo/bar.

It can also be generated dynamically. For example, {{ {{foo}} }} calls Template:foo and interprets the result as the name of another template to call.

Parâmetros

Para enriquecer o mecanismo de transclusão, o MediaWiki permite que sejam passados parâmetros a uma predefinição, quando esta é transcluída. Os parâmetros permitem que a predefinição produza resultados diferentes ou se comporte de formas diferentes.

Imagine que quer incluir uma pequena nota de agradecimento na página de discussão de outros utilizadores, como:

Obrigadinho... pelo teu esforço. Abraço, Eu

O agradecimento conterá uma razão (neste caso, «pelo teu esforço») e a assinatura de quem agradece (neste caso, «Eu»). O objetivo é que o agradecimento possa ser feito por qualquer utilizador a outro, para agradecer qualquer coisa.

Para que a nota pareça similar em qualquer lugar que seja utilizada, pode definir um modelo chamado Template:Thankyou , por exemplo: Although the note should look similar whenever a user thanks another user, its specific contents (i.e., the reason and the signature) will be different. For that reason, you should pass them as parameters. If we ignore the remaining elements to format the box and place the image, the core content of the template will be this:

'''Obrigadinho...'''
por {{{1}}}.
Abraço, {{{2}}}

Repare no uso de {{{1}}} e {{{2}}}. Esta é a forma como, dentro das predefinições, se identifica os parâmetros que serão passados quando a predefinição for usada. Note que, dentro da predefinição, cada parâmetro é rodeado por três chavetas: {{{ }}}. Isto difere do uso normal de duas chavetas para chamar predefinições.

Quando uma predefinição é usada numa página, passam-se os parâmetros separando-os com barras verticais (|). O MediaWiki permite que sejam passados parâmetros às predefinições de três formas: anonimamente, numerados e nomeados.

Parâmetros anónimos

Para passar parâmetros de forma anónima, liste os valores dos parâmetros sequencialmente, desta forma:

{{Thankyou/pt|pelo teu esforço|Eu}}

Neste caso, a predefinição {{Thankyou/pt}} recebe os parâmetros {{{1}}}=pelo teu esforço e {{{2}}}=Eu e produz:

Obrigadinho... pelo teu esforço. Abraço, Eu

Portanto, a ordem de passagem de parâmetros anónimos é crucial para o comportamento da predefinição. Inverter a ordem dos parâmetros:

{{Thankyou/pt|Eu|pelo teu esforço}}

produz este resultado:

Obrigadinho... Eu. Abraço, pelo teu esforço

Identificar parâmetros pela sua ordem (com {{{1}}}, etc.) só funciona com parâmetros anónimos. Os parâmetros identificados por nome, como será demonstrado a seguir, não são acessíveis à predefinição pelo seu número. Any parameters identified by name, as shown below, will not be accessible to the template using ordinal numbers.

Se existir um sinal de igual dentro do argumento de algum dos parâmetros anónimos de uma predefinição, o parâmetro pode ser interpretado como se estiver a ser passado por nome (como é explicado abaixo) tratando o conteúdo antes do sinal de igual como o nome do parâmetro e o conteúdo após o sinal como o valor do argumento. Este é um problema comum quando necessita de passar uma hiperligação externa, ou um elemento HTML com atributos (ver Task 16235). A forma de contorná-lo é passar os parâmetros por nome, ou por número, como explicado na próxima secção.

Parâmetros numerados

Para passar parâmetros por número, identifique o número de cada parâmetro ao passá-lo:

{{Thankyou/pt|2=Eu|1=pela tua amizade}}

Desta vez, a predefinição {{Thankyou/pt}} recebe os parâmetros {{{1}}}=pela tua amizade e {{{2}}}=Eu, embora estes tenham sido fornecidos por ordem inversa. Este código resulta no seguinte:

Obrigadinho... pela tua amizade. Abraço, Eu

Obrigadinho... your friendship. Abraço, Me

This may also be useful when any of the numbered parameters contains an "=" sign.

Exemplos

{{Thankyou|1=adding “=”|2=Me}}

produz

Obrigadinho... adiciona “=”. Abraço, Eu

Aviso:

This also requires numbering each other parameter.

Parâmetros com nome

A terceira forma de identificar os parâmetros é por um nome em vez de usar números. Neste caso, o conteúdo da predefinição seria alterado para:

'''Obrigadinho...'''
{{{razão}}}.
Abraço, {{{assinatura}}}

Assim, dentro da predefinição usa-se {{{razão}}} e {{{assinatura}}} para identificar cada parâmetro, em vez de um número. Para passar estes parâmetros por nome, identifica-se o nome de cada parâmetro ao passá-lo:

{{Thankyou/pt|assinatura=Eu|razão=por seres quem és}}

Neste caso, a predefinição {{Thankyou/pt}} recebe os parâmetros {{{razão}}}=por seres quem és e {{{assinatura}}}=Eu e produz:

Obrigadinho... {{{1}}}. Abraço, {{{2}}}

Named parameters are case-sensitive, so:

{{Thankyou/pt|assinatura=Eu|Razão=por seres quem és|razão=por seres sensível a maiúsculas e minúsculas}}

produz:

Obrigadinho... {{{1}}}. Abraço, {{{2}}}

Obrigadinho... being case-sensitive. Abraço, Me

A vantagem de usar parâmetros com nome na predefinição, para além de também ser flexível quanto à ordem de passagem dos parâmetros, é que torna o código da predefinição muito mais fácil de compreender se forem usados muitos parâmetros.

Spaces and newlines are automatically stripped from the start and end of named parameter names and values, but are preserved in unnamed parameters.

Mixing named and unnamed parameters

If the template supports it, both kinds of parameters can be used in one call.

For example, {{Thankyou|supporting both parameter types|signature=Me}} results in:

Obrigadinho... supporting both parameter types. Abraço, Me

Be careful when doing this, because it can result in conterintuitive results as unnamed parameter counts are based only on the unnamed parameters, not the named parameters. For example, {{Thankyou|Me|reason=supporting both parameter types}} results in:

Obrigadinho... supporting both parameter types. Abraço, {{{2}}}

The template is coded to prefer the named parameter for the reason over the unnamed parameter, resulting in the "Me" being lost and no signature being given. This results in a default value of {{{2}}} being shown, as explained below.

Valores predefinidos

See also: m:Help:Parameter default

Se transcluir uma predefinição que espera receber parâmetros, mas não passar os argumentos, desta forma:

{{Thankyou/pt}}

no exemplo acima dos parâmetros numerados, obterá o seguinte:

Obrigadinho... {{{1}}}. Abraço, {{{2}}}

Como não foram passados argumentos, a predefinição apresenta os parâmetros em si mesmos, em vez de apresentar os respetivos valores. Nestes casos, pode ser útil definir valores por omissão para os parâmetros, isto é, valores que serão usados se não for passado nenhum valor. Por exemplo, se alterar o conteúdo da predefinição para:

'''Obrigadinho...'''
{{{razão|por tudo}}}.
Abraço, {{{assinatura|Eu}}}

então {{{razão|por tudo}}} define que se não for passado um argumento para o parâmetro {{{razão}}}, será usado o valor por tudo. De forma semelhante, {{{assinatura|Eu}}} define que por omissão do parâmetro {{{assinatura}}} será usado o valor Eu. Agora, a mesma transclusão da predefinição sem passar quaisquer argumentos resulta no seguinte:

Obrigadinho... {{{1}}}. Abraço, {{{2}}}

The value of a parameter can be an empty string. For example, in {{foo|bar=}} or {{foo|bar=|baz=qux}}, the foo template considers the bar parameter to be "". This is different from omitting the parameter altogether, which leaves it undefined and triggers the default value mechanism described above.

If you need to treat an empty string the same way as a missing parameter, you can use a conditional operator through an extension like ParserFunctions. For instance, {{#if:{{{1|}}}|{{{1|}}}|undefined}} returns undefined if the parameter is either undefined or empty, while {{{1|undefined}}} does so only if the parameter is undefined.

Often default values are used to specify alternate names of parameters. For example, if you have {{{a|{{{b|}}} }}}, the template will first look for a parameter named "a". If it is not set, it will use the parameter named "b". If neither "a" nor "b" is set, it will output nothing.

Passing parameters to other templates

If raw parameter syntax is generated by the above template call, and then passed through to another template, it is not interpreted as a parameter. This means that {{Thankyou2 }}, which just calls {{Thankyou }} with no parameters, does not work: {{thankyou2|everything|me}} -> Obrigadinho... {{{1}}}. Abraço, {{{2}}} .

You instead need to explicitly pass the parameter to the other template, i.e if {{Thankyou3 }} contains

{{thankyou|{{{1}}}|{{{2}}}}}}

then {{thankyou3|everything|me}} -> Obrigadinho... everything. Abraço, me } works properly.

This example does not preserve emptiness vs. undefinedness in parameter values - you would need more complicated syntax if you wanted to do that.

Empty vs undefined parameters

The {{t2demo|| a }} (refer to {{T2demo }} ), with a double pipe, sets the first parameter to an empty string instead of leaving it undefined. It produces the output start--middle- a -end, similar to how {{t2demo|1=|2= a }} results in start--middle- a -end. On the other hand, explicitly setting the parameter "2" to "a," results in the first unnamed parameter being left undefined:

{{t2demo|2= a }} results in start-{{{1}}}-middle- a -end

If the second parameter should not be trimmed, it must be unnamed.

Therefore, you can assign an empty string to the first parameter, but you cannot leave it undefined.

Making emptiness and undefinedness equivalent

Good template coding practices result in passing an empty string to a parameter working the same as not assigning any value. This makes things easier and more consistent.

For example, using p= can show that a template has a parameter "p" that doesn't have a value yet.

To make an empty string and an undefined value equivalent, use the following approaches:

• Use {{{p|}}} exclusively instead of {{{p}}} or q where "q" is a non-empty value.
• Use conditional checks like {{#if:{{{p|}}}|..{{{p}}}..|..}}, to ensure {{{p}}} is only used when it has a value.

If for some reason you want to treat undefined parameters differently from empty parameters or any other possible value you can compare the same parameter twice with different defaults, i.e {{#ifeq:{{{foo|bar}}|{{{Foo|baz}}}|parameter is undefined|parameter is defined}}.

Using equals signs in unnamed parameters

Unnamed parameters can include equals signs, but this must be done indirectly. Here are some methods using template:T1demo:

Default Value for Undefined Parameter

Assign a default value to an undefined parameter:

{{T1demo|{{{1| a=b }}}}}

This renders as: start a=b end.

Using the {{=}} parser function

Use a parser function that safely includes an equals sign:

{{T1demo| a{{=}}b }}

This renders as: start a=b end.

HTML Entities

Replace the equals sign with an HTML entity for display:

{{T1demo| a=b }}

This renders as: start a=b end.

This renders correctly without affecting the other parameters.

Handling unmatched curly and square brackets

Unmatched curly brackets ({{, }}) or square brackets ([[, ]]) must be inside nowiki tags or use HTML entities:

• Rendering curly brackets have two options:
  • Use <nowiki>{{</nowiki> or { for {
  • Use <nowiki>}}</nowiki> or } for }.
• Use [ for [ and ] for ].

Below are some examples:

Unmatched curly brackets

{{T1demo| <nowiki>{{</nowiki>content<nowiki>}}</nowiki> }}

This correctly renders the braces without breaking the template.

Unmatched square brackets

{{T1demo| text [link] more text }}

This correctly renders the braces without breaking the template.

This renders as: start text [link] more text end

Unmatched pairs not placed in nowiki tags either prevent template expansion or are taken as closing braces for the template call.

Below are some examples:

{{T1demo|abc]]def[[ghi}}

This will not expand correctly because of unmatched brackets.

The correct use:

{{T1demo|abc<nowiki>]]</nowiki>def<nowiki>[[</nowiki>ghi}}

This renders as: startabc]]def[[ghiend

Template-generated brackets

An alternate technique for passing arguments with unmatched brackets is to wrap them in another template. In that situation, (which exists with {{(( }} and {{)) }}) on this wiki), the unmatched brackets will be rendered literally, and not decoded as another template call. For example:

{{t1demo|{{((}}t1demo{{))}}}}

results in: start{{t1demo}}end

When substituting a template, template inclusions are parsed once when the subst happens (with the same caveats explained above) and then a second time when rendering the resulting wikitext. For example:

{{subst:((}}t1demo|foo}}

will expand on save to:

{{((}}t1demo|foo}}

which will then render as:

startfooend

If the wikitext generated via the first subst itself includes "subst:" syntax it will not be processed on the same save, but may be on the next save. This technique may be used to implement recursive substitutions that take multiple saves to evaluate.

Using pipes in parameter values

A parameter value cannot contain a pipe character (|), because it would be interpreted as the end of that parameter and the start of the next parameter. This can be worked around by using the parser function {{!}}, or the HTML entity &124;. The two methods of doing this have slightly different behavior, which can be relevant in some corner cases like when a template is producing wikitable syntax.

Example: {{T1demo|abc|def}} produces: startabcend

The "def" doesn't display because it is treated as part of another unnamed parameter, which the template does not use.

{{T1demo|abc{{!}}def}} produces: startabc|defend

The "def" displays properly.

{{T1demo|abc|def}} produces: startabc|defend

The "def" displays properly again.

Formatting template calls using extra parameters

Since templates ignore parameters they are passed but do not handle specifically, they can be used as a way of a adding extra whitespace or unused content to the template call.

For example:

{{template name|foo|bar|baz|mumble|quux}}

is equivalent to, assuming the template doesn't recognize SPACEN as a parameter name:

{{template name|SPACE1=
|foo|SPACE1=
|bar|SPACE2=Random stuff
|baz|SPACE3=
   |mumble|SPACE4=
  quux
}}

It is also possible to use the same name for each spacer (often the empty string), but this will populate Category:Pages using duplicate arguments in template calls, which many wikis prefer to keep empty to catch instances of user error.

This can be used to make the template render in a way similar to its output, like showing each row of w:Template:Chess position on its own like to make the wikitext also look like a chessboard.

Tracking parameter usage

See also: Help:Tracking categories

It may be wise for a template to add a link or category to a page if a certain parameter or combination of parameters is used, to make if possible to easily determine what pages are using a given parameter, and thus what the impacts of changing that parameter in the template would be.

Evaluation process

This is an advanced topic which you can skip unless you need it.

Generally speaking, template parameters are substituted into the template after tokenization, but as is. They are not evaluated until they are used.

This has a few consequences:

1. If you have a Template:Start containing {{mytemplate, and a Template:End containing |foo=bar}}, and put {{start}}{{end}} on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.
2. Dead-code elimination: If you make a template call like {{foo|{{DISPLAYTITLE:Bar}} }}, and Template:Foo does not contain {{{1}}}, then the DISPLAYTITLE is not used, since it is only evaluated when needed, and there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the int: magic word that varies by user language. This isn't perfect, and in some cases even if the result of expanding a template is not used (because it is part of an if statement condition, for example), the process of evaluating it can still have side effects. For example, any links produced or other templates used will still be added to Special:WhatLinksHere even if they are not displayed.

Template parameters are pass by value, which means a template cannot modify its arguments. Parameters are treated as associative array, and parameter names are evaluated before parameter values. If the same parameter name is given more than once (either as named or unnamed), only the last instace is used, and the page is added to Category:Pages using duplicate arguments in template calls.

Template calls starting with the magic word subst: or safesubst: are evaluated in a separate first pass that only happens at save time, along with ~~~~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker". This means you cannot manipulate the results with parser functions like padleft: or similar functions from extensions, as they see the strip marker instead of the result of the parser function.

A recursividade nas predefinições

Se uma predefinição for chamada no seu próprio código, o MediaWiki não entra em recursividade infinita. O MediaWiki interrompe a recursividade e mostra o nome da predefinição a negro. Por exemplo, se o conteúdo de "Template:Aaaa" é «a {{Aaaa}} z», será mostrado como "a a z z" e exibido .

This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments. In this forbidden example template:d can either be called {{d|20200311}} or {{d|y=2020|m=3|d=11}}. If called in the first manner, it recurses into itself with the second argument structure (obtained using string parser functions), which then follows a unified processing path.

{{#if:{{{1|}}}|{{d|y={{#sub:{{{1}}}|0|4}}|m={{#sub:{{{1}}}|4|2}}|d={{#sub:{{{1}}}|6|2}}}}|<!-- processing path with arguments y,m,d regardless of original call pattern -->}}

If template:d is modified to recurse into template:d/2 and template:d/2 is an identical manual copy of template:d this idiom works fine as the self-recursion safeguard operates dynamically and not statically.

A feasible way for the MediaWiki software to loosen the self-recursion rule would be to require that each recursive call have a distinct argument count from all previous active calls, at most once recursing with the argument count non-decreasing. That would provide a strong guarantee against infinite self-recursion while enabling useful idioms such as the one described here in a flexible manner.

If the processing path is of low complexity, a simple solution using only one template is to handle each calling convention on a separate if/else branch, duplicating the logic of the processing path within each case. If the processing path is more complex, each call-structure case can delegate to an implementation template with a unified call structure which provides the final template behaviour.

Tables in parameters

Since the pipe character (|) and equality sign (=) have different meanings in template calls and wikitables, in order to use table markup in the value of a template parameter one generally needs to "escape" those characters (i.e., protect them from interpretation as template markup) using special sequences:

• the built-in magic word {{!}} provides an "escaped" version of | since MediaWiki 1.24
• the built-in magic word {{=}} provides an "escaped" version of = since MediaWiki 1.39

Before the introduction of these magic words, many wikis used templates to accomplish the same things. On such a wiki, the magic words take precendence over the same-named templates.

Example table

A	B	C
A1	B1	C1
A2	B2	C1

Table code:

{| class=wikitable
!A!!B!!C
|-
|A1||B1||C1
|-
|A2||B2||C1
|}

Escaped table code:

{{{!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!}}{{!}}B1{{!}}{{!}}C1
{{!}}-
{{!}}A2{{!}}{{!}}B2{{!}}{{!}}C2
{{!}}}

Note that the first left-brace ({) is interpreted as a literal left-brace character because it is immediately followed by the {{!}} magic word. Similarly, the last right-brace (}) is interpreted as a literal right-brace character because it is immediately preceeded by the same magic word. However, in some cases these brace characters do cause problems, so some wikis provide templates for escaping these characters, as well:

• the template call {{(}} might provide an "escaped" version of {
• the template call {{)}} might provide an "escaped" version of }

Some wikis go even further and provide other convenience templates like {{(!}}, {{!)}}, {{!!}}. On such a wiki, the code can be simplified a bit to this form:

{{(!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!!}}B1{{!!}}C1
{{!}}-
{{!}}A2{{!!}}B2{{!!}}C2
{{!)}}

Controlar a inclusão das predefinições

Por omissão, o conteúdo de uma predefinição é apresentado no seu todo, tanto quando ela é visionada diretamente como quando é transcluída noutra página. No entanto, pode controlar que partes da predefinição serão vistas e incluídas usando as tags $noinclude, $includeonly e $onlyinclude.

The template's page when viewed directly appears exactly as the template would render without any parameters. If the template requires parameters to function properly, this will result in raw wikitext syntax or errors as a result of them being missing.

However, you can control which parts of a template will be seen and included by the use of the ‎<noinclude>, ‎<includeonly> and ‎<onlyinclude> tags.

Tudo o que estiver entre ‎<noinclude> e ‎</noinclude> será visível só quando a página for vista diretamente, mas não quando a página for transcluída noutra. Isto é útil quando se pretende incluir código ou texto numa predefinição que não se pretende que sejam propagados para as páginas onde a predefinição é incluída, como em:

• Hiperligações de categorização da própria predefinição
• Inserção de hiperligações interlínguas para predefinições semelhantes noutras línguas
• Texto explicativo do uso da predefinição

Tudo o que estiver entre ‎<includeonly> e ‎</includeonly> é processado e apresentado só quanto a página é incluída noutra, mas não aparece quando a página da predefinição está a ser vista diretamente, e é útil nas seguintes situações:

• Categorização das páginas que incluem a predefinição. Nota: ao alterar as categorias que são aplicadas por uma predefinição desta forma, a categorização das páginas que incluem a predefinição pode não ser atualizada até ter passado algum tempo: isto é tratado pela fila de tarefas . Para forçar a recategorização de uma página específica, abra a página para edição e grave-a sem alterações.
• Garantir que o código da predefinição em si não é executado ao ver a própria página da predefinição. Tipicamente, isto é desejado quando a predefinição espera parâmetros e a sua execução sem parâmetros produz um resultado indesejado.

Tudo o que estiver fora das tags ‎<noinclude> e ‎<includeonly> é processado e apresentado normalmente, isto é, quando a página da predefinição está a ser vista diretamente e quando a predefinição é incluída noutra página. O foco está no que se encontra dentro destas tags.

Tudo o que estiver fora das tags ‎<onlyinclude> é descartado durante a transclusão. Até mesmo as secções que têm a tag includeonly são descartadas durante a transclusão a menos que também tenham a tag onlyinclude. O foco está no que se encontra fora desta tag.

For example, if a page like Help:Templates/onlyinclude demo has the wikitext:

abc<onlyinclude>def</onlyinclude>ghi<includeonly>jkl</includeonly>

The result of transcluding it is def.

Estas tags também podem ser intercaladas (nesting).

As três tags para transclusão parcial cobrem todas as combinações possíveis daquilo que é processado e apresentado. Os comentários também têm uma função. Inclusion tags are respected when using {{subst:templatename}}, but they are not respected when using {{msgnw:templatename}} as that displays the raw wikitext without any processing.

Section transclusion

To transclude different sections of a template on different pages, you can wrap the content in onlyinclude tags and use an if statement on parameters to select which section.

Consider "Template:Example" with this wikitext:

== Section 1 ==
{{#ifeq:{{{1|1}}}|1|
Content of section one.
}}
{{#ifeq:{{{1|1}}}|1|
== Section 2 ==
Content of section two.
}}

This will render both sections on the example page itself, and allow other pages to transclude the first section with {{example|1}} and the second section with {{example|2}}.

Another approach is to use literal parameter syntax instead:

{{{section1|
== Section 1 ==
Content of section one.
}}}
{{{section2|
== Section 2 ==
Content of section two.
}}}

Transclude the first section with {{example|section2=}} and the second section with {{example|section1=}}. If neither parameter is used, then both sections will display.

A third approach is to use Labeled Section Transclusion.

Organização de modelos

Para que os modelos sejam úteis, os utilizadores precisam de os encontrar, e saber como os utilizar.

Para os encontrar, os utilizadores podem:

1. Clicar Páginas especiais > Todas as páginas
2. Na lista Espaço nominal:, escolha Template e clique Ver.

Para fornecer informação acerca da utilização, inclua um exemplo como o seguinte na página do modelo:

<noinclude>
== Utilização ==
Agradecer aos utilizadores:
{{Thankyou/pt|razão=a sua razão|assinatura=a sua assinatura}}
</noinclude>

Assim, um editor pode simplesmente copiar e colar o exemplo para utilizar o modelo.

While editing a page, a list of all templates used is available under the editing form, in a collapsible section titled "Predefinição utilizada nesta página:" (also named "Predefinição utilizada nesta antevisão:", or "Predefinição utilizada nesta secção:" depending on the context). This list provides a convenient link to the template's page, as well as information about its protection status. Redirected templates are shown in italics, with the redirect target added as a separate list item.

Interligar com um modelo

Uma página de modelo pode ser interligada, tal como para qualquer outra página wiki. Por exemplo, a hiperligação Template:Navbar é gerada utilizando o código wiki [[Template:Navbar]].

Em muitas wikis, pode usar-se Template:Tl para mostrar uma hiperligação para uma predefinição, formatada para mostrar o código com chavetas duplas necessário para transcluir essa predefinição, sem causar a transclusão. Por exemplo, o código {{tl|Navbar}} pode ser usado para criar a hiperligação {{Navbar }}.

Este conceito é frequentemente usado na documentação das predefinições, nas páginas de ajuda e nas páginas de discussão ao referir predefinições. Pode conseguir-se o mesmo efeito usando <code>{{[[Template:Navbar|Navbar]]}}</code>, mas a abordagem {{Tl }} é mais breve. Em qualquer wiki específica a predefinição Tl, se existir, pode ou não compor o texto num elemento «code», como mostrado aqui. Se não o fizer, é possível que exista outra predefinição de nome semelhante que o faça. Veja, por exemplo, a secção «Ver também» da documentação de en:Template:Tl na Wikipédia em inglês. The same effect can be achieved by using {{[[Template:Navbar|Navbar]]}}, but the {{Tl }} approach involves much less typing. On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element or as monospace type. If not (as on this wiki), another similarly named template may do so. See, for example, the "See also" section of our Template:Tl documentation.

Template naming

The name of a template is case-sensitive excluding the first character.

You make redirects for alternate capitalizations. For example, if a template is named "AdminAbbr", you can create a redirect named "Adminabbr". This way, the template can be called with either {{AdminAbbr}} or {{adminabbr}}. If an editor prefers a mix of upper and lower case for clarity, they can use functions like lc or uc. For instance, instead of {{CURRENTINTERNETTIME}}, they could use {{ {{uc:CurrentInternetTime}} }}

Because template names are interpreted in the same way to the names of other pages, underscores are replaced with spaces, and any text after a number sign (what would be a anchor in a standard link) is ignored.

An underscore _ can be alternative to a blank space.

Possible uses of templates

Templates can be used for any situation in which one wants two or more pages to contain identical or similar content that is edited together rather than independently. They can be used to:

• Provide structured elements on many pages, like infoboxes, maintenance templates, navigational boxes, etc.
• Perform calculations used as a programming tool on various pages, like w:Template:Sum.
• Build composite pages that display the content of multiple existing pages together, like w:WP:Village pump (all) which includes content from each section of the village pump. The content of these pages can either be shown individually, or together, but the revision history, watchlist, etc. will only pick up changes to the transcluded pages and the raw wikitext of the composite page itself, not implicit changes to the composite page.
• Share some content between a few related pages. For example, the list at Help:Preferences#Beta features is duplicated at Beta Features#Current Beta Features. While on MediaWiki.org that is built using Extension:LabeledSectionTransclusion instead, it could have been done using a template.
• Store content referenced multiple times on the same page, so it only has to be written and calculated once. For example w:Template:Cite Monumentenregister/URL is called twice by w:Template:Cite Monumentenregister in two different places, and using another template means the URL pattern only has to be written once in the base template.
• Use templates as a programming element to generate a loop: if Template:A calls Template:B 10 times with different parameters, then that crudely simulates a for loop. If Template:B calls Template:C 10 times, then you have a nested loop of 100 calls of Template:C. But keep in mind that it is easy to run into the template limits when using templates as advanced programming constructs, and using Scribunto is generally clearer and easier to follow.

Copiar de uma wiki para outra

It is possible, if allowed by the wiki configuration to transclude templates from other wikis. This configuration setting is disabled on Wikimedia wikis. Otherwise, you need to manually copy the template and its dependencies from the source wiki to the destination wiki to use it.

Os modelos utilizam frequentemente código CSS ou outros modelos, e por isso, os utilizadores têm frequentemente dificuldade em copiar modelos de uma wiki para outra. Os passos seguintes em baixo deverão funcionar para a maioria dos modelos.

Código do MediaWiki

Se tem permissões de importação (especificamente, o privilégio importupload) na nova wiki:

1. Vá à página Special:Export da wiki de origem e exporte um ficheiro .xml com o historial completo e todas as predefinições necessárias, como se segue:
   • Introduza o nome da predefinição na caixa de texto grande; por exemplo, «Template:Welcome». Tenha em especial atenção as maiúsculas e minúsculas e os caracteres especiais — se o nome da predefinição não estiver exatamente igual, a exportação poderá ocorrer mas o ficheiro .xml não conterá os dados esperados.

1. • Marque a caixa «Incluir predefinições».

1. • Desmarque a caixa «Incluir apenas a edição atual, não o histórico completo».

1. • Clique em "Exportar".
2. Vá para Especial:Importar na nova wiki e envie o ficheiro .xml.

Se não tem permissões para importar páginas na nova wiki:

1. Vá à página da predefinição que pretende copiar, na wiki de origem. Vá à página de edição e copie todo o texto wiki
2. Na wiki de destino, vá à pagina com o mesmo nome que a predefinição que copiou. Clique criar/editar e insira o texto wiki que copiou. No resumo de edição de cada predefinição, coloque uma hiperligação para a página de origem, para fins de atribuição.
3. De volta à wiki de origem, abaixo da caixa de edição, procure a lista «Predefinições usadas nesta página». Para cada predefinição listada, siga estas instruções. Adicionalmente, faça o mesmo para cada predefinição que seja usada por qualquer destas predefinições, e assim por diante.

1. On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.

1. Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

Isto copia todo o código necessário e é suficiente para algumas predefinições. Note that only page elements parsed in rendering the page get exported, consequently documentation subpages are not exported as part of this process. Se este não funcionar, verifique também se existem hiperligações vermelhas listadas nas «Páginas transcritas para a versão atual desta página:», debaixo da caixa de edição. Se existirem, repita os passos acima para estas também e também copie o código nos módulos.

Depois de importar, da outra wiki, a predefinição e todas as predefinições relacionadas com ela, edite-a para adequá-la à sua wiki. Por exemplo, para alterar um logótipo, ou para remover categorias redundantes ou hiperligações vermelhas.

Extensões

Uma extensão que é frequentemente usada nas predefinições é a extensão ParserFunctions. Visite a página Ajuda:Extensão:Funções do Analisador e verifique se alguma das funções listadas nela são utilizadas nas predefinições que copiou. Se forem, tem de instalar a extensão ParserFunctions . Para instalá-la, precisará de acesso de administrador de sistema ao servidor da sua instalação do MediaWiki.

Outra dependência que pode ser utilizada nos modelos, especialmente as da Wikipédia, é Lua. Se tiver {{#invoke: }} no código do modelo é um bom sinal para este. precisa de instalar a extensão Extensão:Scribunto e também precisa de acesso de administrador. Consulte a página para mais instruções sobre a instalação e uso da extensão.

Código CSS e JavaScript

Para além do código do MediaWiki, muitas predefinições utilizam CSS e algumas dependem de JavaScript para funcionar adequadamente. Se as predefinições copiadas não tiverem o comportamento esperado, pode ser essa a causa. Para copiar o CSS e JavaScript necessários para a sua wiki, normalmente precisará de privilégios de administrador da wiki, porque terá de editar mensagens de sistema no espaço nominal «MediaWiki:».

1. Procure utilizações de classes CSS (texto como class="xpto") no texto da predefinição. Se estas classes aparecerem na mensagem de sistema «MediaWiki:Common.css» ou «MediaWiki:Monobook.css» da wiki de origem, copie-as para a mensagem de sistema «MediaWiki:Common.css» da wiki de destino e verifique se a predefinição já funciona.
2. Se a predefinição copiada continua a não funcionar como esperado, verifique se existe código em «MediaWiki:Common.js» ou «MediaWiki:Monobook.js» na wiki de origem. Se existir, pode tentar copiá-lo para «MediaWiki:Common.js» da wiki de destino. Normalmente, é boa ideia copiar código só de fontes idóneas, e examiná-lo para identificar e selecionar as partes que são relevantes. Poderá encontrar no código comentários que forneçam pistas para identificar a funcionalidade de cada parte.

Redirection

If a page uses a redirect as a template, the redirect is resolved before processing the template and the target is used instead. This won't work if the target doesn't exist (a broken redirect), or is itself a redirect (a double redirect).

A page that just includes another page as a template might look like a redirect, but there are several differences between them:

• The header of the result displays the title of the page it came from.
• No "Redirected from" message is shown.
• Buttons like edit, watch, talk, history, "what links here," and "last modified" point to the referring page. To access the target page, use a section edit link and navigate from there.
• Unless includeonly and/or noinclude tags are used, the referring page shares the same categories as the target page.
• "Double redirects" work when one or both are this type of pseudo-redirect.

Embedding works on pages that support redirects and doesn't work on pages without it.

Parser functions

Main page: Help:Parser functions

MediaWiki also supports parser functions, which function similarly to templates but follow slightly different syntax:

• Parser functions utilize a ":" instead of the initial "|".
• An edit page does not display parser functions used on that page.
• There is no "What links here" feature for parser functions to identify the pages where they are utilized.
• Parser functions templates do not generally accept named parameters, so equal signs generally have no special significance. For example:

{{ #if: not blank | x=abc }} gives x=abc

Ver também

General template usage

• m:Help:Calculation
• Help:Substitution
• w:Help:Template – a little more detail than here
• m:Ajuda:Modelos avançados – descreve as técnicas ainda mais avançadas, tais como as chamadas de modelo dinâmico e os nomes de parâmetro variável.
• Help:Multiple-instance templates - on the use of multiple instances of the same template on a page.
• m:Help:Parameter default
• m:Help:Template documentation
• w:WP:Template documentation
• m:Help:Newlines and spaces#Automatic newline

Special constructs used in templates

• Ajuda:Palavras Mágicas – elementos sofisticados que poderá encontrar em algumas predefinições
• Ajuda:Extensão:Funções do Analisador – mais funções sofisticadas de controlo como #if e #switch
• Help:Parâmetros de funções nas predefinições – diretrizes para o uso de funções do analisador sintático nas predefinições
• Ajuda:TemplateData
• Help:Extension:Parser Functions
• Extensão:Scribunto

Other relevant information

• Ajuda:Expandir Modelos
• Help:Pesquisas externas – um exemplo especial de uso de predefinições
• Manual:Importing Wikipedia infoboxes tutorial
• Extension:PageTemplates
• Manual:Creating pages with preloaded text – Using templates as the starting text of a page
• Ajuda:Transclusão – * m:Help:Embed page – incorporar páginas de outros espaços nominais, além de Template:.
• Manual:Template limits
• Help:What links here
• Special:Mostlinkedtemplates - shows the templates with the most uses
• Special:Unusedtemplates - shows templates with no uses (although they may be substituted)
• Manual:$wgEnableScaryTranscluding (using templates from other wikis)
• w:WP:Anatomy of a template
• w:Wikipedia:Transclusion costs and benefits
• Manual:Parser.php
• Help:Extension:TemplateSandbox for previewing your changes to a template as it renders elsewhere

Hiperligações externas

• Repositório de modelos do Miraheze - Modelos do MediWiki destinados para a utilização geral.