Predefinição:Documentação

Origem: Wikilivros, livros abertos por um mundo aberto.
Ir para: navegação, pesquisa
[editar] [purgar] Template-info.svg Documentação da predefinição

Esta predefinição mostra automaticamente uma caixa contendo a documentação no estilo da que você está visualizando agora, cujo conteúdo é incluído a partir de outra página. Ela é destinada a páginas que são incluídas em outras (ou seja, predefinições), mesmo se não estiverem no "espaço nominal Predefinição".

Uso[editar | editar código-fonte]

Página "/doc" normal[editar | editar código-fonte]

[-- Aqui vai o código
da predefinição --]<noinclude>
{{Documentação}}
</noinclude>

Qualquer página /doc[editar | editar código-fonte]

[-- Aqui vai o código
da predefinição --]<noinclude>
{{Documentação|Predefinição:Qualquer página/doc}}
</noinclude>

Conteúdo em linha (In-line)[editar | editar código-fonte]

[-- Aqui vai o código
da predefinição --]<noinclude>
{{Documentação|conteúdo = Esta é a documentação.}}
</noinclude>

Conteúdo em linha (In-line) com ligações [ver] e [editar][editar | editar código-fonte]

[-- Aqui vai o código
da predefinição --]<noinclude>
{{Documentação|1 = Qualquer página/doc
|conteúdo = {{Predefinição:Qualquer página/doc|parâmetros}}
}}
</noinclude>

Boa prática[editar | editar código-fonte]

Este código deve ser adicionado no final do código de uma predefinição, sem qualquer espaços extras antes de "<noinclude>" (isso causaria espaçamento extra nas páginas em que a predefinição é usada). O primeiro parâmetro pode ser usado como mostrado acima para incluir qualquer página de documentação.

Categorias e interwikis que se aplicam à predefinição propriamente dita devem ser inseridos na página de documentação, entre os códigos <includeonly> </includeonly>. Para casos mais complicados, veja Wikipedia:Template documentation‎#Categories and interwiki links (em inglês).

Se a página de documentação contém as marcações includeonly ou noinclude como parte da documentação, substitua "<" por "&lt;".

Personalizando a exibição[editar | editar código-fonte]

Sobreposição existe para personalizar a saída em casos especiais:

  • {{Documentação| título = ...}} − altera o texto "Documentação da predefinição" que aparece no cabeçalho. Se isso for ajustado para branco, o cabeçalho inteiro irá desaparecer (incluindo a primeira ligação [edit]).
  • {{Documentação| estilo-título = ...}} − altera o código css usado na formatação do texto "Documentação da predefinição" (ou substituto) no cabeçalho.

Funções[editar | editar código-fonte]

Se a página de documentação não existe, a ligação "editar" inclui um parâmetro preload de modo que, ao clicar na ligação, a caixa de edição será aberta com um texto pré-carregado com o formato básico de uma página de documentação.

Fundamentação[editar | editar código-fonte]

  • O uso desta predefinição permite que as predefinições em geral possam ser protegidas onde necessário, sem que isso impeça qualquer usuário de editar a documentação, categorias, e ligações de interwiki.

Veja também[editar | editar código-fonte]