Help:Templates/pt-br

Predefinições

Se você pretende incluir o mesmo texto em várias páginas, use a funcionalidade de predefinições do MediaWiki.

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 «Template:»; 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:Boas-vindas», com este conteúdo:

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

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

{{Boas-vindas}}

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

Você pode inserir este código em todas as páginas onde queira 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 voltar a qualquer das 100 páginas onde usou a predefinição, verá o novo texto em vez do antigo. Desta forma, você alterou o conteúdo das 100 páginas sem as editar, porque elas transcluem o conteúdo da sua predefinição.

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

Uso

Se você criar uma predefinição com o nome «Template:Nome», pode transcluir o conteúdo da predefinição para dentro de outras páginas colocando, na posição onde deseja incorporar o conteúdo da predefinição, uma destas formas:

• {{Nome}}, integra o conteúdo da predefinição na página de destino sempre, quando a página de destino é apresentada ao usuário. Se entretanto a predefinição for alterada, o conteúdo na página de destino também será alterado automaticamente.

• {{subst:Nome}}, é substituído pelo conteúdo da predefinição uma única vez, quando a página de destino é gravada. O conteúdo da predefinição 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. Alterações posteriores à predefinição, não serão refletidas na página de destino.

• {{safesubst:Nome}} permite uma forma de substituição que não quebra a transclusão; consulte w:en:Help:Substitution#The safesubst: modifier para mais detalhes (introduzido na rev:61710).

• {{msgnw:Nome}}, integra o conteúdo da predefinição na página de destino sempre que a página de destino é apresentada ao usuário, mas de forma não interpretada pelo analisador sintático, isto é, tal como se estivesse rodeada pelo elemento <nowiki>.

Na realidade, colocar entre chaves {{ }} o nome de qualquer página da wiki, faz com que essa página seja transcluída independentemente do seu espaço nominal. Se não especificar o espaço nominal da página a transcluir, o MediaWiki assume que o espaço nominal é «Template:». Se especificar o espaço nominal, a página será transcluída mesmo que não esteja em «Template:». Portanto:

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

• {{Template:Nome}} também transclui a página [[Template:Nome]]

• {{:Nome}} transclui a página [[Nome]]
  • {{subst:Nome}} é substituído pelo conteúdo da página [[Template:Nome]]
  • {{subst::Nome}} é substituído pelo conteúdo da página [[Nome]]

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

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

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

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

Parâmetros

Para enriquecer o mecanismo de transclusão, o MediaWiki permite que sejam passados parâmetros a uma predefinição, quando estiver sendo 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 a outros usuários, na página de discussão de cada um deles, como a que aparece aqui à direita. 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 usuário a outro, para agradecer qualquer coisa.

Para que o aspecto desta caixa de agradecimento seja igual em todos os agradecimentos, você pode usar uma predefinição, chamada Template:Thankyou/pt-br, por exemplo. Embora o aspecto se mantenha de cada vez que alguém agradece a alguém, o conteúdo específico (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 linha que forma a caixa e a imagem, o conteúdo central da predefinição será este:

'''Muito obrigado...'''
{{{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: {{{ }}}.

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.

Parâmetros anônimos

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

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

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

Inverter a ordem dos parâmetros:

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

faz com que a predefinição {{Thankyou/pt-br}} receba os parâmetros {{{1}}}=Eu e {{{2}}}=pelo teu esforço e inverte o resultado:

Portanto, a ordem de passagem de parâmetros anônimos é fundamental para o comportamento da predefiniçã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 tua 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:

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:

'''Muito obrigado...'''
{{{razão}}}.
Abraço, {{{assinatura}}}

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

{{Thankyou/pt-br|razão=por ser quem você é|assinatura=Eu}}

Neste caso, a predefinição {{Thankyou/pt-br}} recebe os parâmetros {{{razão}}}=por ser quem você é e {{{assinatura}}}=Eu. Este código resulta no seguinte:

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 os passar, desta forma:

{{Thankyou/pt-br}}

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

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

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

então {{{razão|por tudo}}} define que se não for passado 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 parâmetros resulta no seguinte:

Controlar a inclusão das predefinições

Por omissão, quando uma página é transcluída, é transcluído todo o seu conteúdo, e quando é visualizada diretamente, é apresentado todo o seu conteúdo. No entanto, frequentemente existem razões para querer que uma parte específica do conteúdo seja visível só na página de origem e não na de destino. Ou, inversamente, para que uma parte do conteúdo da página não apareça ao visualizar a página de origem e só apareça na de destino, quando ela é transcluída.

Visível na origem, invisível no destino

Na página da própria predefinição, é frequente adicionar-se uma seção de documentação, com instruções sobre o que ela faz, como usá-la, que parâmetros aceita e alguns exemplos do seu uso. Esta seção de documentação não deve aparecer quando se transclui a página para dentro de outra. Também frequentemente, é necessário categorizar as predefinições de forma a organizá-las. Se esta categorização da predefinição for transcluída para a página de destino, também a página de destino receberá a categorização, o que normalmente é indesejável.

É possível impedir que parte do conteúdo de uma página seja incluído em outra, usando o elemento <noinclude>. Ao visualizar a página diretamente, o conteúdo entre <noinclude> e </noinclude> será visível mas, se a página for transcluída, ele não será transcluído para a página de destino. Portanto, esta parte do conteúdo só aparecerá na página de origem e nunca na de destino. As aplicações mais frequentes são:

• Categorização da própria predefinição, sem categorizar as páginas de destino.
• Inserção de interwikis para predefinições semelhantes em outros idiomas.
• Documentação do uso da predefinição.

Invisível na origem, visível no destino

A operação inversa é feita com o elemento <includeonly>. O texto que estiver entre <includeonly> e </includeonly> não é visível na página de origem e só aparece quando a página é transcluída. Portanto, esta parte do conteúdo não aparece na página de origem e só aparece na página de destino. As aplicações mais frequentes são:

• O código da predefinição em si, porque frequentemente esta não apresenta o resultado desejado se for visualizada na página de origem (porque não lhe estão a ser passados os parâmetros que espera).
• Categorização das páginas de destino, sem categorizar a própria predefinição.

Nota: Quando se categoriza através de uma predefinição, como aqui descrito, e se altera as categorias, a alteração pode não ser imediatamente reflectida nas páginas de destino: é colocada na fila de tarefas (job queue).

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 encontrar todas as predefinições, um usuário deve:

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

As predefinições devem também ser categorizadas de acordo com a sua função, o que permite que os usuários possam encontrá-las navegando pelas categorias.

Nas predefinições, devem ser fornecidas informações sobre seu uso e incluído um exemplo como o seguinte:

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

Assim, um utilizador pode simplesmente copiar o exemplo e inseri-lo numa página.

Copiar predefinições de uma wiki para outra

As predefinições usam frequentemente código CSS e outras predefinições. Por isso, os usuários 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:

Com permissão para importar páginas na wiki de destino

1. Vá à página Exportar páginas da wiki de origem. Introduza o nome da predefinição na caixa de texto, marque a caixa de seleção «Incluir predefinições» e clique o botão «Exportar». Isto exportará a predefinição para um ficheiro .xml.
2. Vá à página Importar páginas da wiki de destino e importe o arquivo .xml.
3. Procure classes CSS (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.
4. Se a predefinição utilizar a extensão ParserFunctions, você deverá instalar esta extensão na wiki de destino.

Sem permissão para importar páginas na wiki de destino

1. Copie o texto da predefinição para a wiki de destino; para atribuir a autoria corretamente, inclua no resumo da sua edição um link para a predefinição original.
2. Edite a predefinição na wiki de destino e veja a lista de predefinições no fundo da página. As que aparecem a vermelho também precisam de ser copiadas da wiki de origem para a de destino. Pode ser necessário repetir este processo várias vezes, até ser identificada e copiada toda a árvore de dependências da predefinição.
3. Procure classes CSS (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.
4. Se a predefinição utilizar a extensão ParserFunctions, você deverá instalar esta extensão na wiki de destino.

Ver também

• Pesquisas externas – um exemplo especial de uso de predefinições
• Palavras mágicas – elementos que encontrará frequentemente nas predefinições
• Funções do analisador sintático nas predefinições
• MetaWiki:Help:Template – contém um manual muito mais detalhado sobre o funcionamento das predefinições
• MetaWiki:Help:Embed page – transcluir páginas de outros espaços nominais para além de «Template:».