Ajuda:Templates/pt
| PD | Nota importante: Ao gravar esta página, concorda em publicar a sua contribuição no domínio público. Caso não queira ou não possa fazê-lo, devido a restrições de licenças, por favor, não a edite. Esta é uma das {{ #ifeq: OdontoPédia | MediaWiki | páginas de ajuda no domínio público | páginas de ajuda no domínio público
}}, que podem ser livremente copiadas para qualquer wiki ou distribuídas com o MediaWiki; consulte Ajuda para ver as restantes e {{ #ifeq: OdontoPédia |
MediaWiki | Copiar | Copiar
}} para saber como copiá-las para a sua wiki. |
PD |
Tabela de conteúdo |
[editar] Predefinições
Se pretende incluir o mesmo texto em várias páginas, use a funcionalidade de predefinições do MediaWiki.
[editar] Criação
Predefinições são páginas wiki normais, cujo conteúdo está concebido para ser transcluído (isto é, integrado) noutras páginas. Por convenção, as predefinições devem ser colocadas no espaço nominal «Predefinição:»; 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 «Predefinição:Boas-vindas», com este conteúdo:
Olá! Bem-vindo(a) à wiki.
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.
Pode colocar este código em todas as páginas 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 voltar a 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 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.
[editar] Uso
Se criar uma predefinição com o nome «Predefinição: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 utilizador. 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 reflectidas 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#safesubst: 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 utilizador, mas de forma não interpretada pelo analisador sintáctico, isto é, tal como se estivesse rodeada pelo elemento<nowiki>.
Na realidade, colocar entre chavetas {{ }} 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 é «Predefinição:». Se especificar o espaço nominal, a página será transcluída mesmo que não esteja em «Predefinição:». Portanto:
{{Nome}}transclui a página[[Predefinição:Nome]]
{{Predefinição:Nome}}também transclui a página[[Predefinição:Nome]]
{{:Nome}}transclui a página[[Nome]]{{subst:Nome}}é substituído pelo conteúdo da página[[Predefinição:Nome]]{{subst::Nome}}é substituído pelo conteúdo da página[[Nome]]
{{Ajuda:Nome}}transclui a página[[Ajuda:Nome]]
{{Categoria Discussão:Nome}}transclui a página[[Categoria Discussão: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[[Predefinição:Xpto:Nome]]
[editar] Parâmetros
Para enriquecer o mecanismo de transclusão, o MediaWiki permite que sejam passados parâmetros a uma predefinição, quando está é 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 utilizadores, 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 objectivo é que o agradecimento possa ser feito por qualquer utilizador a outro, para agradecer qualquer coisa.
Para que o aspecto desta caixa de agradecimento seja igual em todos os agradecimentos, pode usar uma predefinição, chamada Predefinição:Thankyou/pt, 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:
'''Um obrigadinho...'''
{{{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.
[editar] Parâmetros anónimos
Para passar parâmetros de forma anónima, liste os valores dos parâmetros sequencialmente, desta forma:
{{Thankyou/pt|pelo teu esforço|Eu}}
Neste caso, a predefinição {{Thankyou/pt}} recebe os parâmetros {{{1}}}=pelo teu esforço e {{{2}}}=Eu e produz:
Inverter a ordem dos parâmetros:
{{Thankyou/pt|Eu|pelo teu esforço}}
causa que a predefinição {{Thankyou/pt}} 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 é crucial para o comportamento da predefinição.
[editar] Parâmetros numerados
Para passar parâmetros por número, identifique o número de cada parâmetro ao passá-lo:
{{Thankyou/pt|2=Eu|1=pela tua amizade}}
Desta vez, a predefinição {{Thankyou/pt}} recebe os parâmetros {{{1}}}=pela tua amizade e {{{2}}}=Eu,
embora estes tenham sido fornecidos por ordem inversa. Este código resulta no seguinte:
[editar] 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 obrigadinho...'''
{{{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|razão=por seres quem és|assinatura=Eu}}
Neste caso, a predefinição {{Thankyou/pt}} recebe os parâmetros {{{razão}}}=por seres quem és 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.
[editar] Valores por omissão
Se transcluir uma predefinição que espera receber parâmetros, mas não os passar, desta forma:
{{Thankyou/pt}}
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:
'''Um obrigadinho...'''
{{{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:
[editar] 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 é visionada directamente, é 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 visionar a página de origem e só apareça na de destino, quando ela é transcluída.
[editar] Visível na origem, invisível no destino
Na página da própria predefinição, é frequente adicionar-se uma secçã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 secçã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 noutra, usando o elemento <noinclude>. Ao visionar a página directamente, 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 links interlínguas para predefinições semelhantes noutras línguas.
- Documentação do uso da predefinição.
[editar] 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 visionada 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.
- {{#if: 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 ({{ #ifeq: OdontoPédia
| MediaWiki | job queue | job queue
}}).|| MediaWiki | job queue | job queue }}).|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 ({{ #ifeq: OdontoPédia | MediaWiki | job queue | job queue
}}).[editar] Organização das predefinições
Para que as predefinições sejam úteis, os utilizadores precisam de encontrá-las e saber como usá-las. Para encontrar todas as predefinições, um utilizador deve:
- Clicar Páginas especiais e depois Todas as páginas
- No campo Espaço nominal:, escolha Predefinição e clique Prosseguir.
As predefinições devem também ser categorizadas de acordo com a sua função, o que permite que os utilizadores possam encontrá-las navegando as categorias.
Nas predefinições, deve ser fornecida informação acerca do seu uso e incluído um exemplo como o seguinte:
<noinclude>
== Uso ==
Agradecer a alguém:
{{Thankyou/pt|razão=a sua razão|assinatura=a sua assinatura}}
</noinclude>
</div>
Assim, um utilizador pode simplesmente copiar o exemplo e inseri-lo numa página.
[editar] 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 noutras páginas. Os seguintes passos podem ajudar:
[editar] Se tem permissões de importar páginas na wiki de destino
- Vá à página Exportação de páginas da wiki de origem. Introduza o nome da predefinição na caixa de texto, marque a caixa de selecção «Incluir predefinições» e clique o botão «Exportar». Isto exportará a predefinição para um ficheiro .xml.
- Vá à página Importar páginas da wiki de destino e importe o ficheiro .xml.
- Procure classes CSS (como
class="xpto") no texto da predefinição. Se estas classes aparecerem na mensagem de sistema MediaWiki:Common.css/pt ou MediaWiki:Monobook.css/pt da wiki de origem, copie-as para a mensagem de sistema MediaWiki:Common.css/pt da wiki de destino. - Se a predefinição usa a extensão ParserFunctions, tem de instalar esta {{ #ifeq: OdontoPédia
| MediaWiki | extensão | extensão }} na wiki de destino.
[editar] Se não tem permissões de importar páginas na wiki de destino
- Copie o texto da predefinição para a wiki de destino; para atribuir a autoria correctamente, inclua no resumo da sua edição um link para a predefinição original.
- 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 ter de repetir este processo várias vezes, até ter identificado e copiado toda a árvore de dependências da predefinição.
- Procure classes CSS (como
class="xpto") no texto da predefinição. Se estas classes aparecerem na mensagem de sistema MediaWiki:Common.css/pt ou MediaWiki:Monobook.css/pt da wiki de origem, copie-as para a mensagem de sistema MediaWiki:Common.css/pt da wiki de destino. - Se a predefinição usa a extensão ParserFunctions, tem de instalar esta {{ #ifeq: OdontoPédia
| MediaWiki | extensão | extensão }} na wiki de destino.
[editar] 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áctico em predefinições
- {{ #ifeq: OdontoPédia
| MediaWiki | MetaWiki: Help:Template | MetaWiki: Help:Template }}{{#if:| |}} – contém um manual muito mais detalhado sobre o funcionamento exacto das predefinições
- {{ #ifeq: OdontoPédia
| MediaWiki | MetaWiki: Help:Embed page | MetaWiki: Help:Embed page }}{{#if:| |}} – transcluir páginas de outros espaços nominais para além de «Predefinição:».
