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

Origem: Wikilivros, livros abertos por um mundo aberto.
[edição não verificada][edição não verificada]
Conteúdo apagado Conteúdo adicionado
m Predefinição:Instruções da predefinição/Modelo movido para Predefinição:Documentação: Testar e implementar predefinição da wikipédia inglesa em um grupo diferente de predefinições, para evitar problemas.
cópia/tradução parcial de w:en:Template:Documentation
Linha 1: Linha 1:
<div class="template-documentation"><!--
{{Subpágina de documentação}}
<!-- POR FAVOR ADICIONE CATEGORIAS E INTERWIKIS AO FINAL DESTA PÁGINA -->


Esta é a definição literal da classe (a inserir) no common.css:
=== Uso ===
/* Para a documentação das predefinições */
.template-documentation {
clear: both;
margin: 1em 0 0 0;
border: 1px solid #aaa;
background-color: #ecfcf4;
padding: 5px;
}


=== Veja também ===


-->{{#ifeq:{{{heading|μ}}}|<!--**DEFINIDO MAS VAZIO**-->
<include<includeonly></includeonly>only>
|<!--**NADA**-->
<!-- CATEGORIAS E INTERWIKIS -->
|<div style="padding-bottom:3px; border-bottom: 1px solid #aaa; margin-bottom:1ex">{{#ifeq:{{{content|μ}}}|μ
|<span class="editsection plainlinks" id="doc_editlinks">{{#ifexist: {{{1|{{Documentação/NomeDoc}}}}}
|<!--** /doc EXISTE** -->[[{{fullurl:{{{1|{{Documentação/NomeDoc}}}}}|action=edit}} editar]]
|<!--** /doc NÃO EXISTE** -->[[{{fullurl:{{{1|{{Documentação/NomeDoc }}}}}|action=edit&preload=Predefinição:Documentação/Modelo}} criar]]
}}</span>
}} <span style="{{#if:{{{heading-style|}}}|{{{heading-style}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|font-weight: bold; font-size: 125%|font-size: 150%}}}}">{{#if:{{{heading|}}}|{{{heading}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|[[Imagem:Template-info.svg|50px]] Documentação da predefinição|Documentação}}}}</span></div>
}}<!--


--><div id="template_doc_page_transcluded" class="dablink plainlinks"><!--
</include<includeonly></includeonly>only>
-->{{#ifexist: {{{1|{{Documentação/NomeDoc}}}}}
|<!--**/doc EXISTE**-->Esta [[w:en:Wikipedia:Template documentation|documentação]] é incluida (''[[[[Wikipedia:Transclusion|transcluded]]'') a partir de [[{{{1|{{Documentação/NomeDoc}}}}}]]. <small style="font-style: normal">([{{fullurl:{{{1|{{Documentação/NomeDoc}}}}}|action=edit}} editar] &#124; [{{fullurl:{{{1|{{Documentação/NomeDoc}}}}}|action=history}} histórico])</small><br />
}}<!--

-->{{#switch: {{#titleparts:{{PAGENAME}}|1|-1|}}<!-- trocar por {{SUBPAGENAME}} quando subpáginas estiverem ativadas -->
|sandbox|testcases=<!--**NÃO MOSTRAR ESSAS LIGAÇÕES NAS PÁGINAS DE TESTES E DE TESTCASES**-->
|#default=
{{#switch: {{SUBJECTSPACE}}
|{{ns:template}}
|{{ns:user}}=
{{#ifexist: {{FULLPAGENAME}}/Testes
|Esta predefinição possui uma [[{{FULLPAGENAME}}/Testes|página para testes]] <small style="font-style: normal">([{{fullurl:{{FULLPAGENAME}}/Testes|action=edit}} editar])</small> <!--
-->{{#ifexist: {{FULLPAGENAME}}/testcases
|and [[{{FULLPAGENAME}}/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} editar])</small>}} para que os editores possam experimentar.
|{{#ifexist: {{FULLPAGENAME}}/testcases
|Essa predefinição possui [[{{FULLPAGENAME}}/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{FULLPAGENAME}}/testcases|action=edit}} editar])</small> para que os editores possam experimentar.}}
}}}}}}
</div>
{{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentação/NomeDoc}}}}} | {{ {{{1|{{Documentação/NomeDoc}}}}} }} }}}}
</div>

Revisão das 21h43min de 25 de julho de 2008

[editar] 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

Página "/doc" normal

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

Qualquer página /doc

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

Conteúdo em linha (In-line)

[-- 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]

[-- 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

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

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

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

  • 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