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 o aspeto desta caixa de agradecimento seja igual em todos os agradecimentos, pode usar uma predefinição, chamada Template:Thankyou/pt, por exemplo. Embora o aspeto se mantenha inalterado de cada vez que alguém agradece a alguém, o conteúdo específico (isto é, a razão e a assinatura) será diferente. Por isso, deve-se passá-los como parâmetros. Ignorando os restantes elementos de formatação, tais como a imagem e a linha que forma a caixa, o conteúdo central da predefinição 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:

Nota: Identificar parâmetros pela sua ordem (com, 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.

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

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

Parâmetros com nome
A terceira forma de identificar os parâmetros é por um nome (nota: os nomes são sensíveis a maiúsculas e minúsculas), 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:

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

Ordem de avaliação
Os parâmetros das predefinições são completamente avaliados antes de serem passados à predefinição. Portanto, se um dos parâmetros for uma chamada para outra predefinição, o que é realmente passado no parâmetro é a expansão dessa predefinição.

é tornado em antes de ser passado:

Nalgumas circunstâncias, esta ordem de avaliação faz diferença em relação à alternativa (sendo a alternativa, verificar o resultado só após a chamada à predefinição, para ver se existem nele predefinições a serem expandidas).

Em primeiro lugar, o nome da predefinição pode ser expandido ao mesmo tempo e da mesma forma que os parâmetros.

Portanto, pode ser expandido para de forma a que a predefinição que é chamada  possa apresentar o agradecimento na língua preferida (seja como for que essa foi determinada).

Em segundo lugar, a predefinição que é chamada não pode construir uma predefinição a partir de pedaços que só seriam expandidos mais tarde. Uma chamada com a forma não funcionaria se fosse e fosse.

Em terceiro lugar, o parâmetro que é passado é expandido uma única vez, em vez de o ser de cada vez que o parâmetro é mencionado na predefinição. Isto resulta em ganhos de eficiência no servidor do mediawiki.

Finalmente, a predefinição que está a ser chamada não pode impedir que o parâmetro seja expandido. Mesmo que uma predefinição use um parâmetro em algumas circunstâncias, ele terá sempre sido expandido antes de ser feita a chamada à predefinição.

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» for « », será mostrado como «Template:Aaaa».

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:


 * 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
Para criar um link para uma predefinição em vez de a incluir, use a predefinição tl. O nome da predefinição que pretende como destino do link deve ser colocado após a barra vertical. Por exemplo: links to the navbar template.

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) * Uncheck the box "".
 * 5) * Clique em "".
 * 6) Go to Special:Import on the new wiki and upload the .xml file.

If you don't have import rights on the new wiki:


 * 1) Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
 * 2) 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.
 * 3) 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.

This will copy the entire code necessary, and will suffice for some templates. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well.

After successfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

Extensões
An extension often used in templates is ParserFunctions. Visit page and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the. To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having  in template code is a good sign for it. In case it's used, you need to install the and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS and JavaScript code
Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.


 * 1) Look for the use of CSS classes (text like  ) in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
 * 2) If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.

Ver também

 * – a template special use case example
 * – fancy stuff you may find in some templates
 * - additional fancy control functions such as #if and #switch
 * - guidance on using parser functions in templates
 * m:Help:Template – contains a much more thorough manual on how exactly templates function
 * m:Help:Advanced templates – describes even more advanced techniques such as dynamic template calls and variable variables
 * m:Help:Embed page – embedding pages from namespaces other than.
 * Extension:PageTemplates
 * Extension:PageTemplates
 * Extension:PageTemplates
 * Extension:PageTemplates