Predefinição:Documentação

De HipHopPedia
Revisão de 03h10min de 18 de janeiro de 2021 por Rafael Bantu (discussão | contribs) (Criou página com '{{#if: {{{content|{{{conteúdo|}}}}}} |{{#ifeq: {{NAMESPACE}} | {{ns:10}} |{{#switch: {{PROTECTIONLEVEL:edit}} |editautoreviewprotected |sysop= Categoria:!Pre...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)
Ir para navegação Ir para pesquisar

{{#if:

 |{{#ifeq: Predefinição | Predefinição
    |{{#switch:  |editautoreviewprotected |sysop=
     }}
  }}
 |{{#ifexist: {{#switch: Documentação
 |sandbox|testcases|teste|Testes={{ #rel2abs: ../doc }}
 |#default=Predefinição:Documentação/doc

}}

    |{{#ifexpr: 0 < 450
       |{{#ifeq:  | não
          |
          |{{#ifeq: documentação | doc
 | 

{{

   #ifeq: show | show
   | Predefinição:Mbox
   }}{{
   #if: 
   | 
   |
 }}

| }} {{#invoke:Lua banner|main}}

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>
  1. Adicione <noinclude>{{Documentação}}</noinclude> logo abaixo do código da predefinição que você quer documentar e salve a modificação.
  2. 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.
  3. 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.
  • Se a página de documentação inclui tags "<includeonly>" ou "<noinclude>" 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:

  • {{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

  1. redirect Predefinição:Ligação para predefinição 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.

Predefinição:Documentação/Ver também

        }}
     }}
    |{{#ifeq:  | não
       |
       |{{#ifeq: documentação | doc
 | 

{{

   #ifeq: show | show
   | Predefinição:Mbox
   }}{{
   #if: 
   | 
   |
 }}

| }} {{#invoke:Lua banner|main}}

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>
  1. Adicione <noinclude>{{Documentação}}</noinclude> logo abaixo do código da predefinição que você quer documentar e salve a modificação.
  2. 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.
  3. 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.
  • Se a página de documentação inclui tags "<includeonly>" ou "<noinclude>" 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:

  • {{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

  1. redirect Predefinição:Ligação para predefinição 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.

Predefinição:Documentação/Ver também

     }}
 }}

}}{{#invoke:documentação|main|_content={{ {{#invoke:documentação|contentTitle}}}}|content=}}