Categoria:!Predefinições para predefinições

Da Thinkfn
Revisão das 22h05min de 16 de novembro de 2008 por Bmwmb (discussão | contribs)

Categoria para predefinições
A categoria !Predefinições para predefinições só deve ser atribuída a predefinições. Não a atribua a artigos.
Pode navegar todas as categorias para predefinições a partir da Categoria:!Predefinições.

Esta categoria reúne predefinições que são usadas somente dentro de outras predefinições. Elas foram criadas para articular todo o mecanismo de protecção, de documentação, de desenvolvimento e de testes das predefinições já existentes, sem as afectar.

Em geral, o mecanismo permite ter na página de cada predefinição somente o código da predefinição em si. Todos os restantes elementos são colocados noutras páginas adicionais, que têm certos sufixos chave. Os nomes das diferentes páginas são:

  • Predefinição:<nome>
Página do código - esta é a página da predefinição, com o código da mesma.
  • Predefinição:<nome>/doc
Página da documentação - esta é a página de documentação da predefinição. Ela é incluída (transcluded) na página do código usando {{documentation}}.
  • Predefinição:<nome>/doc/parameterlist
Página dos parâmetros - esta página deve listar os parâmetros que a predefinição aceita, e as suas combinações mais comuns. Ela deve ser incluída (transcluded) na página de documentação e apresentada ao utilizador quando os parâmetros são incorrectamente usados.
  • Predefinição:<nome>/dev
Página de desenvolvimento - esta página normalmente contém o mesmo código que a página do código, mas que pode ser alterado para fazer experiências e melhoramentos, sem alterar o código da predefinição. Os resultados podem ser verificados na página de testes antes de migrar o novo código para a predefinição.
  • Predefinição:<nome>/tst
Página de testes - esta página deve conter casos de teste para verificar o comportamento da predefinição em diferentes cenários de utilização, incluindo os casos limite nos quais as predefinições devem, mesmo assim, ter um comportamento elegante. Cada caso de teste deve ser chamado duas vezes: uma usando a página do código e uma segunda usando a página de desenvolvimento. Isto permite verificar facilmente o efeito de qualquer alteração.

Para além de articular o mecanismo de desenvolvimento, a separação dos diferentes elementos permite que somente a página do código esteja protegida contra edições. Os utilizadores podem continuar a alterar as restantes páginas, por exemplo introduzindo melhorias na documentação ou experimentando alterações na página de desenvolvimento. Para que uma alteração feita na página de desenvolvimento seja adoptada, deve ser pedido a um administrador que a migre para a página do código, que está protegida.

Um efeito final da separação dos elementos para fora da página do código, é que reduz o montante de processamento da wiki. Sempre que cada predefinição é usada, a wiki só precisa tratar a página do código, não tendo de processar todo o restante conteúdo, como teria se todos os elementos estivessem numa só página.