Esta é uma subpágina de documentação para a Predefinição:Documentação (veja a página para a predefinição em si). Ela contém informações sobre o seu uso, categorias, bem como todo o conteúdo que não faz parte da predefinição original.
Esta predefinição mostra uma caixa de "Documentação da predefinição" 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 documentaçã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
Qualquer página /doc
<noinclude>{{Documentação|Predefinição:Qualquer página/doc}}</noinclude>
Contéudo na mesma linha
<noinclude>{{Documentação|conteúdo=Esta é uma documentação}}</noinclude>
Contéudo na mesma linha com links [ver] e [editar]
<noinclude>{{Documentação
|1= Predefinição:Qualquer página/doc
|conteúdo= {{Predefinição:Qualquer página/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.
- Se a página de documentaçã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:
{{documentação|heading= ...}} − altera o texto do título da documentaçã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 um 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 documentação, facilitando o processo.
Ver também
- Informações sobre documentação de predefinições
- Família de predefinições de documentação
- Predefinição:Documentação/doc (afluentes, editar)
- Predefinição:Documentação/Ver também (afluentes, editar)
- Predefinição:Documentação/nomedoc (afluentes, editar)
- Predefinição:Documentação/preload (afluentes, editar)
- Documentação ancestral do Meta Wiki
|