3 167
edições
Mudanças
Criação da Documentação da Predefinição Documentação.
{{Subpágina de documentação}}
<!-- Categorias no final desta página e links para outros idiomas no Wikidata -->
{{lua|Módulo:Documentação}}
__NOTOC__
Esta predefinição mostra uma caixa de "[[Wikipédia:Documentação da predefinição|documentação da predefinição]]" tal como a que está a ver neste momento, cujo conteúdo é importado de outra página.
== Utilização ==
<pre><noinclude>{{Documentação}}</noinclude></pre>
# Adicione '''<code><nowiki><noinclude>{{Documentação}}</noinclude></nowiki></code>''' 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 <code>Predefinição:''nome da predefinição''/doc</code>. 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 '''<code><nowiki><includeonly> </includeonly></nowiki></code>'''.
=== Outras opções de uso ===
==== Qualquer página /doc ====
<pre><noinclude>{{Documentação|Predefinição:Qualquer página/doc}}</noinclude></pre>
==== Contéudo na mesma linha ====
<pre><noinclude>{{Documentação|conteúdo=Esta é uma documentação}}</noinclude></pre>
==== Contéudo na mesma linha com links [ver] e [editar] ====
<pre><noinclude>{{Documentação
|1= Predefinição:Qualquer página/doc
|conteúdo= {{Predefinição:Qualquer página/doc|parâmetros}}
}}</noinclude></pre>
=== 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'' "<code><nowiki><noinclude></nowiki></code>" (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 [[Wikipédia:Transclusão|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'' <code><nowiki><includeonly> </includeonly></nowiki></code>. Para casos mais complexos, veja [[Wikipédia:Documentação da predefinição#Categorias e interwikis]].
* Se a página de documentação inclui ''tags'' "<code><nowiki><includeonly></nowiki></code>" ou "<code><nowiki><noinclude></nowiki></code>" como parte da documentação, substitua o "<" por "&lt;" ou coloque-as entre <nowiki></nowiki>.
=== Personalizando ===
Em casos especiais é possível personalizar a apresentação:
* <code><nowiki>{{documentação|</nowiki>'''heading'''<nowiki>= ...}}</nowiki></code> − 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 {{LP|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 <code><nowiki>|deficiente=não</nowiki></code> (por exemplo, <code><nowiki>{{documentação|deficiente=não}}</nowiki></code>).
== Funções ==
A utilização da <code><nowiki>{{Documentação}}</nowiki></code>''' nas predefinições possibilita que elas sejam [[Wikipédia:Página protegida|protegidas]] quando necessário, não impedindo que qualquer um edite a documentação, categorias e [[interwiki]]s, 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 [[mw:Manual:Creating pages with preloaded text|pré-carregado]] com o formato básico para uma página de documentação, facilitando o processo.
{{Documentação/Ver também}}
<includeonly>
[[Categoria:!Predefinições para o domínio "Predefinição"]]
[[Categoria:!Instruções de predefinições| {{PAGENAME}}]]
</includeonly>
<!-- Categorias no final desta página e links para outros idiomas no Wikidata -->
{{lua|Módulo:Documentação}}
__NOTOC__
Esta predefinição mostra uma caixa de "[[Wikipédia:Documentação da predefinição|documentação da predefinição]]" tal como a que está a ver neste momento, cujo conteúdo é importado de outra página.
== Utilização ==
<pre><noinclude>{{Documentação}}</noinclude></pre>
# Adicione '''<code><nowiki><noinclude>{{Documentação}}</noinclude></nowiki></code>''' 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 <code>Predefinição:''nome da predefinição''/doc</code>. 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 '''<code><nowiki><includeonly> </includeonly></nowiki></code>'''.
=== Outras opções de uso ===
==== Qualquer página /doc ====
<pre><noinclude>{{Documentação|Predefinição:Qualquer página/doc}}</noinclude></pre>
==== Contéudo na mesma linha ====
<pre><noinclude>{{Documentação|conteúdo=Esta é uma documentação}}</noinclude></pre>
==== Contéudo na mesma linha com links [ver] e [editar] ====
<pre><noinclude>{{Documentação
|1= Predefinição:Qualquer página/doc
|conteúdo= {{Predefinição:Qualquer página/doc|parâmetros}}
}}</noinclude></pre>
=== 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'' "<code><nowiki><noinclude></nowiki></code>" (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 [[Wikipédia:Transclusão|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'' <code><nowiki><includeonly> </includeonly></nowiki></code>. Para casos mais complexos, veja [[Wikipédia:Documentação da predefinição#Categorias e interwikis]].
* Se a página de documentação inclui ''tags'' "<code><nowiki><includeonly></nowiki></code>" ou "<code><nowiki><noinclude></nowiki></code>" como parte da documentação, substitua o "<" por "&lt;" ou coloque-as entre <nowiki></nowiki>.
=== Personalizando ===
Em casos especiais é possível personalizar a apresentação:
* <code><nowiki>{{documentação|</nowiki>'''heading'''<nowiki>= ...}}</nowiki></code> − 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 {{LP|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 <code><nowiki>|deficiente=não</nowiki></code> (por exemplo, <code><nowiki>{{documentação|deficiente=não}}</nowiki></code>).
== Funções ==
A utilização da <code><nowiki>{{Documentação}}</nowiki></code>''' nas predefinições possibilita que elas sejam [[Wikipédia:Página protegida|protegidas]] quando necessário, não impedindo que qualquer um edite a documentação, categorias e [[interwiki]]s, 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 [[mw:Manual:Creating pages with preloaded text|pré-carregado]] com o formato básico para uma página de documentação, facilitando o processo.
{{Documentação/Ver também}}
<includeonly>
[[Categoria:!Predefinições para o domínio "Predefinição"]]
[[Categoria:!Instruções de predefinições| {{PAGENAME}}]]
</includeonly>