Predefinição:Documentação

Documentação de predefinição

Esta predefinição mostra uma caixa de "uso de predefinições" tal como a que está a ver neste momento, cujo conteúdo é importado de outra página.

Utilização

<noinclude>{{Documentação}}</noinclude>

Adicione <noinclude>{{Documentação}}</noinclude> logo abaixo do código da predefinição que você quer documentar e salve a modificação.
Na caixa de uso de predefinição que surge na página da predefinição, clique em criar. Será criada uma página de documentação a partir de um modelo, com nome equivalente a Predefinição:nome da predefinição/doc. Introduza o texto da documentação nesta página.
As categorias e interwikis das predefinições devem ser adicionadas na página da documentação respectiva e não na página da predefinição. As categorias e interwikis devem ser colocadas dentro das tags <includeonly> </includeonly>.

Outras opções de uso

Conteúdo na mesma linha

<noinclude>{{Documentação|conteúdo=Esta é uma predefinição}}</noinclude>

Conteúdo na mesma linha com links [ver] e [editar]

<noinclude>{{Documentação|conteúdo={{Qualquer predefinição/doc|parâmetros}}}}</noinclude>

Boas práticas

Uma destas opções de código deve ser adicionada logo após o texto da predefinição, sem nenhum espaço antes da tag "<noinclude>" (o que causaria um espaço extra nas páginas onde a predefinição é usada). Parâmetros adicionais podem ser usados como mostrado acima para transcluir uma página de documentação arbitrária.
Links de categorias e interwikis da própria predefinição devem ser adicionados na página de documentação, dentro das tags <includeonly> </includeonly>.
Se a página de predefinição inclui tags "<includeonly>" ou "<noinclude>" como parte da documentação, substitua o "<" por "<" ou coloque-as entre <nowiki></nowiki>.

Personalizando

Em casos especiais é possível personalizar a apresentação:

{{predefinição|heading= ...}} − altera o texto do título da predefinição. Se for definida como vazia, o título inteiro, incluindo o link [editar], também desaparecerão.

Funções

A utilização da {{documentação}} nas predefinições possibilita que elas sejam protegidas quando necessário, não impedindo que qualquer um edite a documentação, categorias e interwikis, uma vez que ficam em uma página à parte.

Caso a página de documentação não exista, clicando-se no link [criar] é gerado um modelo pré-carregado com o formato básico para uma página de predefinição, facilitando o processo.

Esta documentação se encontra na subpágina Predefinição:Documentação/doc (editar | histórico)
Por favor inclua as categorias à subpágina /doc. Subpáginas desta predefinição.