Help:Predefinições

Nota: Ao editar esta página, você concorda em publicar a sua contribuição no âmbito da licença CC0. Veja as páginas de ajuda do domínio público para mais informações.

Se você tiver textos padrão que deseja incluir em várias páginas, o recurso de predefinição MediaWiki entra em jogo. Ao contrário de extensões e arquivos multimídia, não há um repositório central para predefinições. Predefinições podem ser escritas do zero ou, para diminuir retrabalho, exportadas de outras wikis, p. ex. Wikipédia, e então importadas na wiki de destino. Os templates podem ser escritos do zero ou, para evitar duplicar o trabalho já feito, exportados de outra wiki, como a Wikipédia, e então importados para a wiki de destino.

Uso básico

Templates são páginas padrão da wiki cujo conteúdo é projetado para ser transcluído (incorporado) dentro de outras páginas. Os templates seguem uma convenção em que o nome é precedido por "Template:", atribuindo-o a esse namespace; além disso, você pode criá-los como qualquer outra página da wiki.

Para transcluir um template, você deve usar chaves duplas de abertura e fechamento {{nome do template}}.

O uso mais simples de templates é o seguinte: Crie uma página chamada Template:Welcome com o conteúdo abaixo:

Olá! Bem-vindo à wiki.

Você criou seu primeiro template! Agora, insira o código abaixo em uma nova página:

{{Welcome}}

Quando a nova página for visualizada, o texto "Hello! Welcome to the wiki." aparecerá no lugar de {{Welcome}}. O conteúdo do template é transcluído para a outra página, ou seja, é integrado à página.

Você pode então inserir {{Welcome}} em qualquer ponto de qualquer página onde deseje dar as boas-vindas a alguém. Suponha que seja usado em 100 páginas. Se você então alterar o conteúdo do template para:

Oi! Bem-vindo a esta maravilhosa wiki.

E ao revisitar qualquer uma das 100 páginas onde o template foi usado, você verá o novo texto em vez do original. Dessa forma, você alterou o conteúdo de 100 páginas sem precisar editá-las, pois o template é translucido nessas páginas.

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

Formas de invocar um template

As predefinições podem ser usadas noutras páginas usando uma das seguintes notações:

• {{Name}} — Como descrito acima, este texto (comumente chamado de "chamada de template") será dinamicamente substituído pelo conteúdo da página intitulada Template:Name (um processo chamado "transclusão") toda vez que a página com a chamada de template for carregada (ou seja, visualizada por um leitor da wiki). Como a chamada do template permanece no código-fonte da página, qualquer alteração subsequente em Template:Name será visível na página que contém a chamada do template. Além disso, a página será listada entre aquelas que "linkam para" o template.
• {{subst:Name}} — Quando esse tipo de chamada de template é usado, ela será substituída por uma cópia estática do conteúdo de Template:Name no momento em que a página contendo a chamada do template for salva. Ou seja, uma cópia do conteúdo de Template:Name será substituída pela chamada do template. Nenhum link é mantido entre a página e o template, de modo que cada um pode ser editado separadamente sem afetar o outro. Na prática, há pouca diferença entre substituir o conteúdo dessa forma e simplesmente digitá-lo no código-fonte da página "manualmente". Consulte Help:Substitution para mais informações.

• {{safesubst:Nome}} — esta notação foi introduzida 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}} integra o conteúdo da predefinição na página de destino, na forma não interpretada pelo analisador sintático (tal como se estivesse rodeada pela notação ‎<nowiki>) quando a página que a contém é carregada.

Por exemplo, {{msgnw:Template:Thankyou}} exibe:

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

Na verdade, uma página comum da wiki também pode ser usada como um template, simplesmente especificando o namespace em que ela está localizada, assim:

• {{Template:Pagename}} transclui a página intitulada Template:Pagename (equivalente a {{Pagename}})
• {{Talk:Pagename}} transclui a página intitulada Talk:Pagename.
• {{:Pagename}} transclui a página intitulada Pagename (ou seja, no namespace principal).
  • {{subst::Pagename}} substitui o conteúdo da página intitulada Pagename.

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

• {{Foo:Bar}} transclui Template:Foo:Bar

Independentemente da sintaxe utilizada, o nome do template pode ser relativo à página atual. Por exemplo, se {{/Ruim}} for chamado na página foo, ele transcluirá a página foo/Ruim.

Também pode ser gerado dinamicamente. Por exemplo, {{ {{foo}} }} chama Template:foo e interpreta o resultado como o nome de outro template a ser chamado.

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 usuários, como:

Um pequeno agradecimento... pelo seu esforço. Abraço, Eu

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

Para que a nota pareça similar em qualquer lugar que seja utilizada, pode definir uma predefinição chamada Template:Thankyou , por exemplo. Embora a nota deva ser semelhante sempre que um usuário agradece a outro usuário, seu conteúdo específico (ou seja, o motivo e a assinatura) será diferente. Por esse motivo, você deve passá-los como parâmetros. Se ignorarmos os elementos restantes para formatar a caixa e colocar a imagem, o conteúdo central do modelo será este:

'''Um pequeno agradecimento...'''
{{{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, 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: de forma anônima, numerada e nomeada.

Parâmetros anônimos

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

{{Thankyou/pt-br|pelo seu esforço|Eu}}

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

Um pequeno agradecimento... pelo seu esforço. Abraço, Eu

A ordem em que os parâmetros são passados anonimamente é crucial para o seu comportamento. Invertendo a ordem dos parâmetros, assim:

{{Thankyou/pt-br|Eu|pelo seu esforço}}

produz este resultado:

Um pequeno agradecimento... Eu. Abraço, pelo seu esforço

Identificar parâmetros pela sua ordem (com {{{1}}}, etc.) só funciona com parâmetros anônimos. Quaisquer parâmetros identificados pelo nome, como mostrado abaixo, não estarão acessíveis ao template usando números ordinais.

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 um link externo, ou um elemento HTML com atributos (ver tarefa T16235). 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-br|2=Eu|1=pela sua amizade}}

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

Um pequeno agradecimento... pela sua amizade. Abraço, Eu

Isso também pode ser útil quando qualquer um dos parâmetros numerados contiver um sinal "=".

Exemplos

{{Thankyou|1=adicionar “=”|2=Eu}}

produz:

Um pequeno agradecimento... adding “=”. Abraço, Eu

Atenção:

Isso também requer numeração um do outro parâmetro.

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:

'''Um pequeno agradecimento...'''
{{{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-br|assinatura=Eu|razão=por ser quem você é}}

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

Um pequeno agradecimento... {{{1}}}. Abraço, {{{2}}}

Os parâmetros nomeados diferenciam maiúsculas de minúsculas, portanto:

{{Thankyou/pt-br|assinatura=Eu|Razão=por ser quem você é|razão=por ser sensível a maiúsculas e minúsculas}}

produz:

Um pequeno agradecimento... {{{1}}}. Abraço, {{{2}}}

A vantagem de usar parâmetros nomeados em suas predefinições, além de tornar flexível a ordem que os parâmetros podem ser passados, é que torna o código da predefinição muito mais fácil de entender se há muitos parâmetros.

Espaços e quebras de linha são automaticamente removidos do início e do final dos nomes e valores dos parâmetros nomeados, mas são preservados em parâmetros não nomeados.

Misturando parâmetros nomeados e não nomeados

Se o template suportar, ambos os tipos de parâmetros podem ser usados em uma única chamada.

Por exemplo, {{Thankyou|supporting both parameter types|signature=Me}} exibe:

Um pequeno agradecimento... supporting both parameter types. Abraço, Me

Tenha cuidado ao fazer isso, pois pode resultar em resultados contraintuitivos, já que a contagem dos parâmetros não nomeados é baseada apenas nos parâmetros não nomeados, e não nos parâmetros nomeados. Por exemplo, {{Thankyou|Me|reason=supporting both parameter types}} exibe:

Um pequeno agradecimento... supporting both parameter types. Abraço, {{{2}}}

O template é codificado para preferir o parâmetro nomeado em vez do parâmetro não nomeado, o que resulta na perda de "Me" e na ausência de assinatura. Isso resulta em um valor padrão de {{{2}}} sendo exibido, conforme explicado abaixo.

Valores padrão

See also: Manual:Advanced templates#Use of parameter default

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

{{Thankyou/pt-br}}

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

Um pequeno agradecimento... {{{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:

'''Um pequeno agradecimento...'''
{{{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:

Um pequeno agradecimento... {{{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}} → Um pequeno agradecimento... {{{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 works properly: {{thankyou3|everything|me}} → Um pequeno agradecimento... everything. Abraço, me

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 defined|parameter is undefined}}.

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|SPACE2=
|bar|SPACE3=Random stuff
|baz|SPACE4=
   |mumble|SPACE5=
  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 Extensão: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 Predefinição:Aaaa para a {{Aaaa}} z, ele exibirá "a a z z".

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 padrão, o conteúdo de uma predefinição é apresentado no por completo, tanto quando ela é vista diretamente, como quando é transcluída em outra página. No entanto, pode-se controlar quais partes de uma predefinição serão vistas e incluídas, usando as palavras chave $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.

For example:

• If a parameter has no default value, it shows as the literal text {{{1}}}, indicating the template needs a parameter.
• If a parameter has an empty default value (it is written as {{{1|}}}), it displays nothing, which achieves the intended effect but lacks clarity for self-documentation. Using a non-empty default value like {{{1|$1}}} could clarify a parameter's role, especially for templates involving images.
• If a parameter without a default is passed to the #expr parser function, it results in an error message: "Expression error: unrecognized punctuation character '{'."
• If a template creates a table, it's helpful for the template page to show the table's structure rather than the wikitext used to make it. To do this, the table syntax isn't enclosed in tags, and each table element includes both ‎<noinclude>...‎</noinclude> and ‎<includeonly>...‎</includeonly> parts where needed.

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:

• Links de categorização da própria predefinição
• Inserção de links interlínguas para predefinições semelhantes noutras línguas
• Texto explicativo do uso da predefinição It's a common pattern on some wikis to use a template like {{Documentação }} to transclude the documentation from a subpage of the template. For example, Template:Void is documented at Template:Void/doc.

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|2}}}|2|
== 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 das predefinições

Para que as predefinições sejam úteis, os usuários precisam de encontrá-las e saber como usá-las.

Para encontrá-las, os usuários podem:

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

Para fornecer informação sobre o uso, inclua um exemplo como o seguinte na página da predefinição:

<noinclude>
== Uso ==
Agradecer a alguém:
{{Thankyou/pt-br|razão=a sua razão|assinatura=a sua assinatura}}
</noinclude>

Assim, um usuário pode simplesmente copiar o exemplo e inseri-lo numa página para usar a predefinição.

While editing a page, a list of all templates used is available under the editing form, in a collapsible section titled "Predefinição usada nesta página:" (also named "Predefinição usada nesta previsão:", or "Predefinição utilizada nesta seçã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.

Criar um link para uma predefinição

Pode-se criar uma hiperligação para uma predefinição tal como para qualquer outra página. Por exemplo, a hiperligação Template:Navbar é gerada usando o código wiki [[Template:Navbar]].

Em muitas wikis, pode-se usar Template:Tl para mostrar uma hiperligação para uma predefinição formatada de uma maneira que mostre o código com "chaves 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 se referir a predefinições. O mesmo efeito pode ser conseguido usando {{[[Template:Navbar|Navbar]]}}, mas a abordagem {{Tl }} exige muito menos digitação. Em qualquer wiki específica, a predefinição Tl, se existir, pode ou não renderizar o texto em um elemento "code" ou como um tipo monoespaçado. Se não o fizer (como nesta wiki), outra predefinição de nome semelhante pode fazê-lo. Veja, por exemplo, a seção "Ver também" da documentação de Template:Tl na Wikipédia em inglês.

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 predefinições 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.

As predefinições usam frequentemente código CSS e outras predefinições. Por isso, os utilizadores têm frequentemente dificuldade em copiar uma predefinição de uma wiki para outra, porque estes elementos necessários estão em outras páginas. Os seguintes passos podem ajudar:

The steps below should work for most templates.

Código MediaWiki

Se tem permissões para importar páginas (especificamente, o privilégio importupload) na wiki de destino:

1. Vá à página Special:Export da wiki de origem e exporte um ficheiro .xml com o histórico 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 especial atenção nas letras 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.
   • Marque a caixa "Incluir predefinições".
   • Desmarque a caixa "Incluir apenas a revisão atual, não o histórico inteiro".
   • Clique em Exportar.
2. Vá à página Special:Import da wiki de destino e importe o arquivo .xml.

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

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 um link 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. Observe que apenas os elementos da página analisados na renderização da página são exportados e, consequentemente, as subpáginas da documentação não são exportadas como parte desse processo. Se não funcionar, verifique se existem links vermelhos na secção «Páginas transcluídas na versão atual desta página:», abaixo 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 links vermelhos.

Extensões

Uma extensão que é frequentemente usada nas predefinições é a extensão ParserFunctions. Visite a página Extensão:ParserFunctions 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 nas predefinições, especialmente as da Wikipédia, é Lua. Se tiver {{#invoke: }} no código do modelo é um bom sinal para este. Caso seja usado, você precisa instalar a extensão de Scribunto e o acesso de administrador do sistema também é necessário. Veja essa página para mais instruções sobre como instalar e usar a 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

Página principal: 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

• Manual:Expr parser function syntax
• Help:Substitution
• w:Help:Template
• Manual:Advanced templates – * m:Help:Advanced templates – descreve técnicas ainda mais avançadas, como chamadas de predefinições dinâmicas e nomes de parâmetros variáveis
• Help:Multiple-instance templates - on the use of multiple instances of the same template on a page.
• Manual: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:ParserFunctions – mais funções sofisticadas de controlo como #if e #switch
• Help:Funções sintáticas em predefinições – diretrizes para o uso de funções do analisador sintático nas predefinições
• Ajuda:TemplateData
• Ajuda:Extensão:ParserFunctions
• Extensão:Scribunto

Other relevant information

• Help:ExpandTemplates
• Help:Buscas 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
• Help: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

Links externos

• Repositório de predefinição do Miraheze - Predefinições do MediaWiki destinados ao uso geral.