Predefinição:Documentação/doc: diferenças entre revisões

[edição não verificada][edição não verificada]
Conteúdo apagado Conteúdo adicionado
m Desfeita a edição 132261 de Heldergeovane (Usuário Discussão:Heldergeovane) de onde saiu isso?
atualizando esta documentação com base na original: w:en:Template:Documentation/doc; remoção de info. desatualizada sobre o parser do MediaWiki: w:en:Template talk:Documentation/Archive 2#New parser
Linha 2:
<!-- POR FAVOR ADICIONE CATEGORIAS E INTERWIKIS AO FINAL DESTA PÁGINA -->
__NOTOC__
Esta predefinição mostra automaticamente uma caixa contendo a documentação no estilo da que você está visualizando agora, cujo conteúdo é [[w:en:Wikipedia:Transclusion|incluído]] a partir de outra página. Ela é destinada a páginas que são incluídas em outras (ou seja, [[Ajuda:Como criar predefinições|predefinições]]), mesmo se não estiverem no domínio "[[Especial:Índice_de_prefixo/Predefinição:|espaço nominal Predefinição]]".
 
== Uso ==
 
=== Normal, comPágina "/doc" normal ===
&lt;noinclude&gt;&#123;&#123;Documentação&#125;&#125;&lt;/noinclude&gt;
 
Linha 24:
=== Boa prática ===
 
Este código deve ser adicionado no final do código de uma predefinição, sem qualquer espaços extras antes de "<code>&lt;noinclude></code>" (isso poderia causarcausaria espaçamento extra nas páginas em que a predefinição é usada). O parâmetroprimeiro "1"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 ducumentaçãodocumentação, entre os códigos <code>&lt;includeonly> &lt;/includeonly></code>. Para casos mais complicados, veja ''[[w:en:Wikipedia:Template documentation‎#Categories and interwiki links|Wikipedia:Template documentation‎#Categories and interwiki links]]'' (em inglês).
 
Se a página de documentação contém códigosas marcações ''includeonly'' ou ''noinclude'' como parte da documentação, substitua "<" por "&amp;lt;".
 
=== Personalizando a exibição ===
 
Sobreposição existe para personalizar a saída em casos especiais:
* <code>{&#123;Documentação| '''título''' = ...}}</code> − altera o texto "Documentação da predefinição" doque aparece no cabeçalho. Se isso for ajustado para branco, o cabeçalho inteiro irá desaparecer (incluindo a primeira ligação [edit]).
* <code>{&#123;Documentação| '''estilo-título''' = ...}}</code> − altera o código ''[[w:css|css]]'' usado na formatação do texto "Documentação da predefinição" (ou substituto) no cabeçalho.
 
== Funções ==
 
Se a página de documentação não existe, a ligação "editar" inclui um parâmetro ''[[mw:Manual:Creating pages with preloaded text|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 ==
 
* O uso desta predefinição permite que as predefinições em geral possam ser [[w:en:Wikipedia:Protection policy|protegidas]] onde necessário, sem que isso impeça qualquer usuário de editar a documentação, categorias, e ligações de interwiki.
* O texto na página da predefinição propriamente dita é somado ao total de texto a ser processado quando a predefinição é exibida, sendo essa quantidade limitada por questões de performance: [[w:en:Template limits|tamanho máximo de ''pre-expand include'']] de 2,048,000 ''bytes''. A colocação da documentação em uma subpágina faz que o wikitexto relativo à documentação seja constituído apenas por uma chamada à subpágina da predefinição e aos códigos ''noinclude''. Os desenvolvedores do MediaWiki <span class="plainlinks">[http://en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_(technical)&diff=prev&oldid=69888944 recomendaram]</span> este sistema por essa razão.
 
== Veja também ==