Wikilivros:Exemplos para testes: diferenças entre revisões

[edição não verificada]

Conteúdo apagado Conteúdo adicionado

Em linha

Revisão das 17h56min de 11 de outubro de 2009

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 de ({{X | .... }}</nowiki>) 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 compara 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.

@@ Linha 1: / Linha 1: @@
-As [[Ajuda:Como criar predefinições|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 '''[[w:Especial:Busca/Caso de teste|casos de teste]]''' para evitar ''bugs'' e outros problemas.
+As [[Ajuda:Como criar predefinições|predefinições]] são uma ferramenta muito poderosa do [[w:MediaWiki|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 '''[[w:Especial:Busca/Caso de teste|exemplos para testes]]''' para evitar ''bugs'' e outros problemas.
 == Em que tipo de predefinições isto deve ser usado? ==
@@ Linha 15: / Linha 15: @@
 Além disso, a predefinição não deve ter blocos <code><nowiki><includeonly></nowiki></code> e <code><nowiki><noinclude></nowiki></code> demais. Idealmente haveria apenas um bloco <code><nowiki><includeonly></nowiki></code>, colocado ao final da página da predefinição, contendo a {{tl|Documentação}} da predefinição.
-== Como criar as subpáginas /testes e /casos de teste ==
+== Como criar as subpáginas /Testes e /Exemplos para testes ==
 : Suponha que a sua predefinição se chama <code>Predefinição:X</code>. Crie uma subpágina chamada <code>Predefinição:X/Testes</code> e outra com o nome <code>Predefinição:X/Exemplos para testes</code>. Quando estas páginas estão presentes, a documentação inserida com a {{tl|Documentação}} fornece ligações para tais páginas automaticamente. Note que apenas a primeira letra de "'''T'''estes" e "'''E'''xemplos para testes" está em maiúscula.
 : Copie apenas o código (tudo que não estiver entre as marcações <code><nowiki><noinclude></nowiki></code>) da sua <code>Predefinição:X</code> para <code>Predefinição:X/Testes</code> e adicione o seguinte no final da última linha (na mesma linha):
-:<code style="display:table; line-height:1.2em;">&lt;noinclude><br><br><nowiki>{{template sandbox notice}}</nowiki><br>&lt;/noinclude></code>
+:<code style="display:table; line-height:1.2em;">&lt;noinclude><br><br><nowiki>{{Aviso/Testes com predefinições}}</nowiki><br>&lt;/noinclude></code>
 Em outras palavras, o resultado deve ser:
-:<code style="display:table; line-height:1.2em;"><span style="background-color: #FFFF66">[-- Código da predefinição --]</span>&lt;noinclude><br><br><nowiki>{{template sandbox notice}}</nowiki><br>&lt;/noinclude></code>
+:<code style="display:table; line-height:1.2em;"><span style="background-color: #FFFF66">[-- Código da predefinição --]</span>&lt;noinclude><br><br><nowiki>{{Aviso/Testes com predefinições}}</nowiki><br>&lt;/noinclude></code>
 '''Note!''' O código da predefinição deve começar imediatamente antes e literalmente encostar na marcação <code>&lt;noinclude></code>. Qualquer espaço em branco ou quebra de linha entre o código da predefinição e a marca <code>&lt;noinclude></code> pode fazer com que a predefinição renderize espaços ou quebras de linha indesejáveis quando for utilizada.
-: Copie alguns exemplos de inclusão de (<nowiki>{{</nowiki>'''X''' | .... }}</nowiki>) das páginas para a sua <code>Predefinição:X/Exemplos para testes</code>. Na página com os exemplos para teste, duplique cada exemplo e para uma cópia de cada exemplo substitua <code>X</code> por <code>X/Testes</code>. 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:
+: Copie alguns exemplos de inclusão de (<nowiki>{{</nowiki>'''X''' | .... }}</nowiki>) das páginas para a sua <code>Predefinição:X/Exemplos para testes</code>. Na página com os exemplos para testes, duplique cada exemplo e para uma cópia de cada exemplo substitua <code>X</code> por <code>X/Testes</code>. 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:
-:<code style="display:table; line-height:1.2em;"><nowiki>{{template test cases notice}}</nowiki></code>
+:<code style="display:table; line-height:1.2em;"><nowiki>{{Aviso/Exemplos para testes com predefinições}}</nowiki></code>
 : Agora o código wiki a <code>Predefinição:X/Exemplos para testes</code> irá se parecer com isto:
 <pre>
+ {{Aviso/Exemplos para testes com predefinições}}
- {{template test cases notice}}
- {{X | foo}}
+ {{X       |Algo}}
- {{X/sandbox | foo}}
+ {{X/Testes|Algo}}
- {{X | bar}}
+ {{X       |Algo mais}}
- {{X/sandbox | bar}}
+ {{X/Testes|Algo mais}}
 </pre>
-b: 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 teste]]. 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.
+b: 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 ==
@@ Linha 59: / Linha 59: @@
 * [[w:Predefinição:Teste]]
 * [[w:en:Wikipedia:High-risk templates]]
-* [[w:en:Template:template sandbox notice]] – A ser inserida no final das páginas de teste das predefinições.
+* [[Predefinição:Aviso/Testes com predefinições]] – A ser inserida no final das páginas de teste das predefinições.
-* [[w:en:Template:template test cases notice]] – A ser inserida no topo das páginas com exemplos para testes.
+* [[Predefinição:Aviso/Exemplos para testes com predefinições]] – A ser inserida no topo das páginas com exemplos para testes.
 [[Categoria:Predefinições|{{PAGENAME}}]]