Wikipédia:Testes e exemplos para teste de predefinições

Origem: Wikipédia, a enciclopédia livre.
Ir para: navegação, pesquisa


As predefinições são uma ferramenta muito poderosa do MediaWiki, mas é muito fácil cometer erros, mesmo sendo um usuário mais experiente. Por este motivo, as predefinições mais complexas devem vir acompanhadas de uma página para testes e alguns exemplos para testes para prevenir bugs.

Em que tipo de predefinições isto deve ser usado?[editar | editar código-fonte]

É recomendado usar o padrão de exemplos para testes nas predefinições que utilizam ParserFunctions e que geram resultados bastante diferentes dependendo dos parâmetros que são passados, ou que têm muitos casos em um operador #switch.

Para as caixas de navegação cujo resultado é quase sempre o mesmo em cada página que as utiliza, o benefício pode não valer o esforço e o tempo adicional de se criarem os exemplos para testes.

É claro que toda predefinição que seja incluída em milhares de páginas deve ser testada antes de se fazer uma edição.

Pré-requisitos[editar | editar código-fonte]

A predefinição deve estar devidamente documentada, seguindo as orientações da página Wikipédia:Documentação da predefinição.

Além disso, a predefinição não deve ter blocos <includeonly> e <noinclude> demais. Idealmente haveria apenas um bloco <includeonly>, colocado ao final da página da predefinição, contendo a predefinição {{Documentação}}.

Como criar as subpáginas /Testes e /Exemplos para testes[editar | editar código-fonte]

1: Suponha que a sua predefinição se chama Predefinição:X. Crie uma subpágina chamada Predefinição:X/Testes e outra com o nome Predefinição:X/Exemplos para testes. Quando estas páginas estão presentes, a documentação inserida com a {{Documentação}} fornece ligações para tais páginas automaticamente. Note que apenas a primeira letra de "Testes" e "Exemplos para testes" está em maiúscula.

2: Copie apenas o código (tudo que não estiver entre as marcações <noinclude>) da sua Predefinição:X para Predefinição:X/Testes e adicione o seguinte no final da última linha (na mesma linha):

<noinclude>
{{Aviso para a página de testes de uma predefinição}}
</noinclude>

Em outras palavras, o resultado deve ser:

[-- Código da predefinição --]<noinclude>
{{Aviso para a página de testes de uma predefinição}}
</noinclude>

Note! O código da predefinição deve começar imediatamente antes e encostar na marcação <noinclude>. Qualquer espaço em branco ou quebra de linha entre o código da predefinição e a marca <noinclude> pode fazer com que a predefinição renderize espaços ou quebras de linha indesejáveis quando for utilizada.

3: Copie alguns exemplos de transclusão (ou seja, coisas como {{X | ... }}) dos artigos para a sua Predefinição:X/Exemplos para testes. Nesta subpágina, duplique cada exemplo e em uma cópia de cada exemplo substitua X por X/Testes. Isto é feito para que você possa comparar o resultado antigo com o novo resultado da predefinição próximos um do outro no futuro. Finalmente, adicione a seguinte linha ao início da página com os exemplos. Não faz diferença quantas linhas em branco você irá colocar em torno dela:

{{Aviso para a página de exemplos de uma predefinição}}

4: Agora o código wiki a Predefinição:X/Exemplos para testes irá se parecer com isto:

{{Aviso para a página de exemplos de uma predefinição}}
{{X       |Algo}}
{{X/Testes|Algo}}

{{X       |Algo mais}}
{{X/Testes|Algo mais}}

4b: Para que fique fácil de identificar as diferenças entre as duas versões da predefinição, você pode usar a Predefinição:Exemplos para testes. Então os exemplos que realmente foram alterados ao se editar a página de testes serão realçados de modo que você possa ter certeza de que cada mudança foi intencional.

Como usar as páginas posteriormente[editar | editar código-fonte]

  • Sincronize a página de testes da predefinição a partir do código original da predefinição (ou seja, execute o passo 2 explicado anteriormente);
  • Divirta-se editando a página de testes
  • Verifique os exemplos para testes
  • Se parecer que tudo está como deveria, copie o código da página de testes para a predefinição verdadeira.

Se você prefere não comparar o resultado novo com o antigo como foi descrito anteriormente, é recomendado que você use um navegador que possua abas e abrir a subpágina com os exemplos antes de alterar a página de testes da predefinição, e outra depois de alterar a página de testes. Isto o ajudará a se certificar de que as mudanças estão sendo comparadas adequadamente.

Exemplos[editar | editar código-fonte]

Teste com outros usuários - {{test-mode}}[editar | editar código-fonte]

Se você estiver satisfeito com as alterações que fez na versão de testes, e com o que os exemplos para testes mostram, você pode considerar {{test-mode}}. Isso permitirá que vários usuários naveguem pelas páginas da Wikipédia com a versão de testes de sua predefinição, e ainda assim não afetar ninguém mais que esteja exibindo tais páginas.

Ver também[editar | editar código-fonte]