Help:Templates/pt-br

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.

Criação
Predefinições são páginas wiki normais, cujo conteúdo está concebido para ser "transcluído" (isto é, integrado) em outras páginas. Por convenção, as predefinições devem ser colocadas no espaço nominal «   :»; de resto, pode criá-las como cria qualquer outra página.

O uso mais simples de uma predefinição é o seguinte. Se criar a página "Template:Welcome", com este conteúdo:

Olá! Bem-vindo(a) à wiki.

você terá criado a sua primeira predefinição. Se depois colocar o código:

em qualquer outra página, aparecerá nessa página o texto «Olá! Bem-vindo(a) à wiki.» em vez de. Diz-se que o conteúdo da predefinição foi «transcluído» para dentro da outra página, isto é, que foi integrado nela.

Pode depois colocar o código  em qualquer ponto de qualquer página onde deseje dar as boas-vindas a alguém. Imagine que o usa em 100 páginas. Se depois alterar o conteúdo da predefinição para:

Olá! Bem-vindo(a) a esta wiki maravilhosa.

e revisitar qualquer das 100 páginas onde usou a predefinição, verá o novo texto em vez do antigo. Desta forma, alterou o conteúdo das 100 páginas sem as editar, porque a predefinição é transcluída nestas páginas.

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

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


 * &mdash; como descrito acima, esta notação wiki é dinamicamente substituída pelo conteúdo atual da página Template:Nome quando a página com este código for carregada. A notação wiki mantém-se inalterada no código-fonte da página.
 * &mdash; quando esta notação wiki é usada numa página, será substituída uma única vez e definitivamente pelo conteúdo de Template:Nome, quando a página de destino for gravada. Uma cópia do conteúdo da predefinição Template:Nome será inserida em substituição da notação wiki. Este conteúdo torna-se parte integrante do conteúdo da página de destino e pode depois ser editado nesta, separadamente do original na página da predefinição. Nota: alterações posteriores à predefinição, não serão propagadas para a página de destino.
 * &mdash; esta notação foi introduzida para permitir uma forma de substituição que não quebra a transclusão; consulte w:en:Help:Substitution para mais detalhes.
 * 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 ) quando a página que a contém é carregada.

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

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

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

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

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

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:

produz
 * Exemplos:

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

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

produz:

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.

Valores por omissão
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 it 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, 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, ele exibirá "a a Template loop detected:  Template:Aaaa z z".

Forbidden idiom
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  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 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 syntax for wikitables involves pipes in single braces ({ }) and using the pipe trick will not work in transclusion parameters, one will have to create a table as a separate page and transclude it from there.

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


 * 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

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

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

Uso
Agradecer a alguém:

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

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 é gerada usando o código wiki.

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  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, 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", 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 seção "Ver também" da documentação de en:Template:Tl na Wikipédia em inglês.

Copiar predefinições de uma wiki para outra
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:

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:
 * 2) * 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.
 * 3) * Marque a caixa «».
 * 4) * Desmarque a caixa «».
 * 5) * Clique em .
 * 6) 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.

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, portanto, por exemplo, 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 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 nas predefinições, especialmente as da Wikipédia, é Lua. Se tiver   no código do modelo é um bom sinal para este. Caso seja usado, você precisa instalar a extensão de 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  ) 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.

Ver também

 * w:Ajuda:Tabela - as instruções mais fáceis de usar.
 * – um exemplo especial de uso de predefinições
 * – 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
 * m:Help:Template – contém um manual muito mais detalhado sobre o funcionamento exato das predefinições
 * 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
 * m:Help:Embed page – incorporar páginas de outros espaços nominais, além de.
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page

Links externos

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