Wikilivros:Exemplos para testes

As predefinições são uma ferramenta muito poderosa do MediaWiki, mas é possível cometer erros muito facilmente, mesmo entre os usuários mais experientes. Por este motivo, as predefinições mais complexas devem ser acompanhadas de uma página para testes e alguns exemplos para testes para evitar bugs e outros problemas.

Em que tipo de predefinições isto deve ser usado?

É recomendado usar os exemplos para testes nas predefinições que utilizam ParserFunctions e que geram resultados bastante diferentes uns dos outros conforme os parâmetros que são passados, ou por haver diversos 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.

Qualquer predefinição que seja incluída em muitas páginas deve ser testada antes de se fazer uma edição.

Pŕe-requisitos

A predefinição deve estar devidamente documentada, seguindo as orientações disponíveis na página Template documentation (em inglês).

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 {{Documentação}} da predefinição.

Como criar as subpáginas /Testes e /Exemplos para testes

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/Testes com predefinições}}
</noinclude>

Em outras palavras, o resultado deve ser:

[-- Código da predefinição --]<noinclude>
{{Aviso/Testes com predefinições}}
</noinclude>

Note! O código da predefinição deve começar imediatamente antes e literalmente 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 inclusão (ou seja, coisas do tipo {{X | .... }}) das páginas para a sua Predefinição:X/Exemplos para testes. Na página com os exemplos para testes, duplique cada exemplo e para 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/Exemplos para testes com predefinições}}

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

{{Aviso/Exemplos para testes com predefinições}}
{{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 realmente intencional.

Como usar as páginas posteriormente

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

Ver também

w:Predefinição:Teste
w:en:Wikipedia:High-risk templates
Predefinição:Aviso/Testes com predefinições – A ser inserida no final das páginas de teste das predefinições.
Predefinição:Aviso/Exemplos para testes com predefinições – A ser inserida no topo das páginas com exemplos para testes.