Predefinição:Documentation

Predefinição código | documentação | categoria | parâmetros | desenvolvimento | testes Esta é a página do código desta predefinição. O texto abaixo vem da página da documentação. A categoria vem da página de categoria (não categorize esta página). Todos os parâmetros que a predefinição aceita estão listados na página de parâmetros e o seu uso é explicado na documentação. Se quiser alterar o código, faça-o na página de desenvolvimento. Verifique as suas alterações na página de testes. Quando terminar a alteração, peça a um administrador que migre o código de desenvolvimento para cá. Nota: Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. Siga-o, por favor. Não categorize esta página. Coloque a categoria da predefinição na página da categoria.

Documentação

Esta predefinição é o elemento central de articulação do mecanismo das predefinições. Deve ser incluída em todas as páginas do espaço nominal Predefinição:. Ela:

• cria a caixa de navegação da predefinição que vê acima, com links para navegar facilmente por todas as páginas padrão da predefinição,
• auxilia a criação inicial dessas páginas, apresentado um modelo padronizado do conteúdo de cada uma, que deve ser seguido,
• mostra a página da documentação quando se consulta o código da predefinição, para que se veja também a sua documentação (esse processo está a ocorrer neste momento: o texto que está a ler, não está na página Predefinição:Documentation, que é a página do código de {{documentation}}, mas sim na página Predefinição:Documentation/doc), e
• categoriza automaticamente todas as páginas da predefinição nas quais tenha sido incluída.

Esta predefinição existe para permitir que o código das predefinições seja protegido enquanto todos os restantes componentes, que estão noutras páginas, possam continuar a ser editados pelos utilizadores.

Uso

Para usar {{documentation}} coloque o seguinte código no topo de todas as páginas da predefinição:

<noinclude>{{documentation}}<noinclude>

Se criar as páginas seguindo os links na caixa de navegação da predefinição, as páginas serão automaticamente preenchidas com um modelo que deve seguir. Os modelos estão listados abaixo.

Parâmetros

Não aceita parâmetros.

Ver também

Páginas extra desta predefinição (adicionais às páginas padrão)

• Predefinição:Documentation/docname
• Predefinição:Documentation/preload/cod - Modelo padronizado para pré-preenchimento da página de código
• Predefinição:Documentation/preload/doc - Modelo padronizado para pré-preenchimento da página de documentação
• Predefinição:Documentation/preload/cat - Modelo padronizado para pré-preenchimento da página de categoria
• Predefinição:Documentation/preload/par - Modelo padronizado para pré-preenchimento da página de parâmetros
• Predefinição:Documentation/preload/dev - Modelo padronizado para pré-preenchimento da página de desenvolvimento
• Predefinição:Documentation/preload/tst - Modelo padronizado para pré-preenchimento da página de testes

Outras

• Ajuda:Predefinições