Predefinição:Documentação/Exemplos para testes

Esta é a página de exemplos para testes de predefinições para a página de testes de Predefinição:Documentação. Purgue esta página para atualizar os exemplos.
Se houver muitos exemplos de uma predefinição complicada, os últimos poderão deixar de funcionar devido aos limites do MediaWiki, veja o comentário HTML "NewPP limit report" na página renderizada.
Também pode utilizar Especial:Expandir predefinições para examinar o resultado dos usos da predefinição.
Pode testar como esta página aparece em diferentes skins com estes links:

Documentation

----
{{documentation}}
----
{{documentation|Template:Documentation/testcases/test1}}
----
{{documentation|Template:Documentation/testcases/test2}}
----
{{documentation|content=This is in line documentation.}}
----
{{documentation|Template:Documentation/testcases/nodoc|content=Documentation.}}
----
{{documentation|Template:Documentation/testcases/test1|content=Documentation.}}
----

Default Documentation

Esta predefinição não apresenta nenhuma documentação.
Por favor, documente-a caso a saiba usar ou tenha conhecimentos para tal.

Documentação da predefinição[ver] [editar] [histórico] [purgar]

Esta predefinição usa Lua:

Módulo:Documentação

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.

Links de categorias e interwikis da própria predefinição devem ser adicionados na página de documentação, dentro das tags <includeonly> </includeonly>. Para casos mais complexos, veja Wikipédia:Documentação da predefinição#Categorias e interwikis.

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.

Aviso de documentação deficiente

É colocado o aviso {{falta doc}} automaticamente pela predefinição se a documentação não tiver sido criada ou se o tamanho de seu código for inferior a 450 B. Caso seja equivocado, pode ser removido adicionando-se o parâmetro |deficiente=não (por exemplo, {{documentação|deficiente=nã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

{{Falta doc}}

Informações sobre documentação de predefinições

Wikipedia:Documentação da predefinição

Família de predefinições de documentação

Documentação ancestral do Meta Wiki

m:Template:Documentation (backlinks, edit)

A documentação acima é transcluída de Predefinição:Documentação/doc. (editar | histórico)
Editores podem experimentar nas páginas de teste (editar | dif) e de exemplos para testes (editar) desta predefinição.
Por favor adicione categorias à subpágina /doc. Subpáginas desta predefinição.

Esta predefinição não apresenta nenhuma documentação.
Por favor, documente-a caso a saiba usar ou tenha conhecimentos para tal.

Documentação da predefinição[criar]

Editores podem experimentar nas páginas de teste (editar | dif) e de exemplos para testes (editar) desta predefinição.
Subpáginas desta predefinição.

Esta predefinição não apresenta nenhuma documentação.
Por favor, documente-a caso a saiba usar ou tenha conhecimentos para tal.

Documentação da predefinição[criar]

Editores podem experimentar nas páginas de teste (editar | dif) e de exemplos para testes (editar) desta predefinição.
Subpáginas desta predefinição.

Documentação da predefinição

This is in line documentation.

A documentação acima é transcluída de Predefinição:Documentação/doc. (editar | histórico)
Editores podem experimentar nas páginas de teste (editar | dif) e de exemplos para testes (editar) desta predefinição.
Subpáginas desta predefinição.

Documentação da predefinição

Documentation.

Editores podem experimentar nas páginas de teste (editar | dif) e de exemplos para testes (editar) desta predefinição.
Subpáginas desta predefinição.

Documentação da predefinição

Documentation.

Editores podem experimentar nas páginas de teste (editar | dif) e de exemplos para testes (editar) desta predefinição.
Subpáginas desta predefinição.

Documentação/Testes

----
{{documentação/Testes}}
----
{{documentação/Testes|Template:Documentation/testcases/test1}}
----
{{documentação/Testes|Template:Documentation/testcases/test2}}
----
{{documentação/Testes|conteúdo=This is in line documentation.}}
----
{{documentação/Testes|Template:Documentation/testcases/nodoc|conteúdo=Documentation.}}
----
{{documentação/Testes|Template:Documentation/testcases/test1|conteúdo=Documentation.}}
----

Default Documentation

Esta predefinição não apresenta nenhuma documentação.
Por favor, documente-a caso a saiba usar ou tenha conhecimentos para tal.

Notest

For {{File mover granted}}:

Live documentation

{{documentation|page=Template:File mover granted|notest=y}}

Esta predefinição não apresenta nenhuma documentação.
Por favor, documente-a caso a saiba usar ou tenha conhecimentos para tal.

Documentação da predefinição[criar]

Editores podem experimentar nas páginas de teste (criar | espelhar) e de exemplos para testes (criar) desta predefinição.
Por favor adicione categorias à subpágina /doc. Subpáginas desta predefinição.

Sandbox documentation

{{documentação/Testes|page=Template:File mover granted|notest=y}}

Esta predefinição não apresenta nenhuma documentação.
Por favor, documente-a caso a saiba usar ou tenha conhecimentos para tal.