Help:Templates/pt

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.

Criação
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 « », que os coloca nesse espaço nominal; além disto, pode criá-los como qualquer outra página wiki.

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:

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

Depois pode inserir o código  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.

Utilização
Os modelos podem ser utilizados noutras páginas nas seguintes formas:

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. 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 for more information.
 * &mdash; 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.
 * &mdash; 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.
 * &mdash; este texto wiki foi introduzido para permitir uma forma de substituição que não quebra a transclusão; consulte w:en:Help:Substitution para mais detalhes.
 * 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 ) quando a página que o contém é carregada.

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:


 * transclui a página
 * transclui a página
 * transclui a página
 * substitui-se a si próprio pelo conteúdo da página

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


 * transclui a página

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:

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, 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:

Repare no uso de  e. 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:

Neste caso, a predefinição  recebe os parâmetros   e   e produz:

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

produz este resultado:



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

Desta vez, a predefinição  recebe os parâmetros   e , embora estes tenham sido fornecidos por ordem inversa. Este código resulta no seguinte:


 * Exemplos:

produz



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... . Abraço,

Assim, dentro da predefinição usa-se  e   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:

Neste caso, a predefinição  recebe os parâmetros   e   e produz:

Named parameters are case-sensitive, so:

produz:

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.



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

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

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:

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

Often default values are used to specify alternate names of parameters. For example, if you have, 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.

Evaluation
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. First of all, if you have a  containing , and a   containing  , and put   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.

The second consequence of this is dead-code elimination. If you make a template call like, and Template:Foo does not contain  , 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  magic word that varies by user language.

Template calls starting with the magic word  or   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,  calls are ignored, and   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" é « », será mostrado como "a a Template loop detected: Template:Aaaa z z" e exibido Detetada repetição do modelo: Template:Aaaa.

Forbidden idiom
This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments. In this forbidden example  can either be called   or. 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  is modified to recurse into   and   is an identical manual copy of   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   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
 Table code: 

 Escaped table code: 

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 and. On such a wiki, the code can be simplified a bit to this form:



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, e.

Tudo o que estiver entre e  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 e  é 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 . 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 e  é 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 é 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.

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.



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 ' > '
 * 2) Na lista ', escolha Template e clique '.

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

Utilização
Agradecer aos utilizadores:

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 "" (also named "", or "" 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.

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  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, 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, but the   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.



Copiar de uma wiki para outra
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:
 * 2) * 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 «».
 * 1) * Desmarque a caixa «».
 * 1) * Clique em "".
 * 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.

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 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. 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   no código do modelo é um bom sinal para este. precisa de instalar a extensão 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  ) 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.



General template usage

 * w:Help:Template – a little more detail than here
 * m:Help:Template – contém um manual muito mais detalhado sobre o funcionamento exato das predefinições
 * 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.

Special constructs used in templates

 * – elementos sofisticados que poderá encontrar em algumas predefinições
 * – mais funções sofisticadas de controlo como #if e #switch
 * – diretrizes para o uso de funções do analisador sintático nas predefinições

Other relevant information

 * – um exemplo especial de uso de predefinições
 * – Using templates as the starting text of a page
 * – * m:Help:Embed page – incorporar páginas de outros espaços nominais, além de.
 * – Using templates as the starting text of a page
 * – * m:Help:Embed page – incorporar páginas de outros espaços nominais, além de.
 * – * m:Help:Embed page – incorporar páginas de outros espaços nominais, além de.



Hiperligações externas

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