sandbox

50px Documentação da predefinição

Esta predefinição exibe automaticamente uma caixa de documentação que você está vendo agora, de qual o conteúdo é transcluído de outra página. Destina-se a páginas que são transcluídas em outras páginas, ou seja, predefinições, seja no namespace template: ou não.

Usos

Normal

<noinclude>{{documentation/pt-br}}<noinclude>
ou <noinclude>{{documentation/pt-br|template:qualquer página/doc}}<noinclude>

Este código deve ser adicionado na parte inferior do código da predefinição, sem espaço extra antes de <noinclude> (o que causaria espaço extra em páginas onde a predefinição é usada). O parâmetro pode ser usado, como mostrado acima, para transcluir uma página de documentação arbitrária.

Adicione categorias e ligações interwiki à página de documentação dentro de tags <includeonly>.

Se a página de documentação contém tags <includeonly> ou <noinclude> como parte da documentação, substitua o "<" com "&lt;".

Personalizando a exibição

Existem substituições para personalizar a saída em casos especiais:

• {{documentation|heading=}}: altera o texto do título documentação. Se isso for definido como em branco, a linha inteira do cabeçalho (incluindo o primeiro link [edit]) também desaparecerá.

Funções

Se a página de documentação não existe, o link "edit" inclui um parâmetro preload de modo que, ao clicar ele irá pré-preencher o formulário de edição com o formato básico da página de documentação.

Fundamentação

Esta predefinição permite que qualquer página possa usar qualquer página de documentação, e torna possível proteger predefinições, permitindo que qualquer pessoa edite a documentação da predefinição, categorias, e ligações interwiki. Também reduz os recursos do servidor, contornando uma limitação técnica de predefinições (veja uma explicação do desenvolvedor).

Veja também

• Predefinição:Subpágina de documentação
• Documentação no Meta (em inglês)
• Wikipédia:Documentação da predefinição