Documentação/doc

Edição atual tal como às 16h49min de 21 de julho de 2017

Esta é a página de documentação, ela deverá ser transcluída na página principal da predefinição. Veja Predefinição:Documentação para mais informações.

Para predefinições, insira <noinclude>{{subst:doc}}</noinclude> no final do modelo, em seguida, salve a página, isso vai colocar {{documentação}} e um comentário aconselhando de editores onde colocar categorias e ligações interwikis. Para outros tipos de páginas, o modelo de documentação já deve estar lá.

Clique em "criar" no topo da página e a página de documentação será aberta com algumas pré-formatações. Esta formatação também pode ser criada usando {{subst:doc}} na página de documentação.

Páginas de documentação serão automaticamente adicionadas à Categoria:Páginas de documentação. Usar {{doc}} sem subst: irá adicionar a página a Categoria:Páginas com predefinições que requerem substituição.

Parâmetros opcionais

Estes parâmetros podem ser adicionados para a predefinição {{subst:doc}} durante a criação da página, ou adicionado à predefinição {{documentação}} depois.

type

Define o "type" de documentação esta é, por exemplo, predefinição, módulo, mensagem, etc. Isto irá ser utilizado como parte de algumas mensagens, a predefinição pode ser exibida, bem como categorização.

O tipo é automático baseado no namespace, por isso não deve ser necessário em geral a ser definido.

page

A página onde a documentação deve estar. O padrão é uma sub-página da página atual chamada "doc".

content

Permite que o conteúdo da documentação seja especificado diretamente, em vez de em uma subpágina separada. Útil para pequenas predefinições de sub-página específicos de página, por exemplo Explosão/tabela.

nodoc

Se um modelo não tem documentação e você não sabe como usá-lo, adicione nodoc=1 para o predefinição de documentação na página de documentação. Base da documentação ficará vermelha para torná-lo mais visível, e a página será adicionada à Categoria:Predefinição sem documentação, se é uma predefinição.

Isso é definido automaticamente se a página de documentação não existe, de modo que este geralmente não é necessário definir.

baddoc

Semelhante ao nodoc, este é usado para marcar predefinições que tem documentação, mas não é muito boa. Isto pode significar que não tem exemplos suficientes, não explica todas as funções corretamente, ou não explica a ponto de a predefinição corretamente. Base da documentação ficará amarela para torná-lo mais visível, e a página será adicionada à Categoria:Predefinição com má documentação, se é uma predefinição.

@@ Linha 1: / Linha 1: @@
+{{cabeçalho da documentação}}
-{{documentation header}}
 <!-- Documentation here -->
-Para predefinições, insira <code><nowiki><noinclude>{{subst:doc}}</noinclude></nowiki></code> no final do modelo, em seguida, salve a página, isso vai colocar <code>{<nowiki/>{documentation}}</code> e um comentário aconselhando de editores onde colocar categorias e LigaçõesEntreWikis. Para outros tipos de páginas, o modelo de documentação já deve estar lá.
+Para predefinições, insira <code><nowiki><noinclude>{{subst:doc}}</noinclude></nowiki></code> no final do modelo, em seguida, salve a página, isso vai colocar <code>{<nowiki/>{documentação}}</code> e um comentário aconselhando de editores onde colocar categorias e ligações interwikis. Para outros tipos de páginas, o modelo de documentação já deve estar lá.
-Clique em "criar" no topo da página e na página de documentação será aberta com algumas pré-formatações.
+Clique em "criar" no topo da página e a página de documentação será aberta com algumas [[Predefinição:Documentação/preload|pré-formatações]]. Esta formatação também pode ser criada usando <code><nowiki>{{subst:doc}}</nowiki></code> na página de documentação.
-Páginas de documentação serão automaticamente adicionadas à [[:Categoria:Páginas de Documentação]].
+Páginas de documentação serão automaticamente adicionadas à [[:Categoria:Páginas de documentação]]. Usar {{t|doc}} sem <code>subst:</code> irá adicionar a página a [[:Categoria:Páginas com predefinições que requerem substituição]].
 == Parâmetros opcionais ==
-Estes parâmetros podem ser adicionados para a predefinição <code>{<nowiki/>{subst:doc}}</code> durante a criação da página, ou adicionado à predefinição <code>{<nowiki/>{documentation}}</code> depois.
+Estes parâmetros podem ser adicionados para a predefinição <code>{<nowiki/>{subst:doc}}</code> durante a criação da página, ou adicionado à predefinição <code>{<nowiki/>{documentação}}</code> depois.
 === type ===
 Define o "type" de documentação esta é, por exemplo, predefinição, módulo, mensagem, etc. Isto irá ser utilizado como parte de algumas mensagens, a predefinição pode ser exibida, bem como categorização.
@@ Linha 17: / Linha 18: @@
 === page ===
 A página onde a documentação deve estar. O padrão é uma sub-página da página atual chamada "doc".
+=== content ===
+Permite que o conteúdo da documentação seja especificado diretamente, em vez de em uma subpágina separada. Útil para pequenas predefinições de sub-página específicos de página, por exemplo [[Explosão/tabela]].
 === nodoc ===
-Se um modelo não tem documentação e você não sabe como usá-lo, adicione nodoc=1 para o predefinição de documentação na página de documentação. Base da documentação ficará vermelha para torná-lo mais visível, e a página será adicionada à [[:Categoria:Predefição de documentação]], se é uma predefinição.
+Se um modelo não tem documentação e você não sabe como usá-lo, adicione nodoc=1 para o predefinição de documentação na página de documentação. Base da documentação ficará vermelha para torná-lo mais visível, e a página será adicionada à [[:Categoria:Predefinição sem documentação]], se é uma predefinição.
 Isso é definido automaticamente se a página de documentação não existe, de modo que este geralmente não é necessário definir.
 === baddoc ===
-Semelhante aO nodoc, este é usado para marcar predefinições que '''tem''' documentação, mas não é muito boa. Isto pode significar que não tem exemplos suficientes, não explica todas as funções corretamente, ou não explica a ponto de a predefinição corretamente. Base da documentação ficará amarela para torná-lo mais visível, e a página será adicionada à [[:Categoria:Predefinição com má documentação]], se é uma predefinição.
+Semelhante ao nodoc, este é usado para marcar predefinições que '''tem''' documentação, mas não é muito boa. Isto pode significar que não tem exemplos suficientes, não explica todas as funções corretamente, ou não explica a ponto de a predefinição corretamente. Base da documentação ficará amarela para torná-lo mais visível, e a página será adicionada à [[:Categoria:Predefinição com má documentação]], se é uma predefinição.
 <includeonly>
 <!-- Template categories/interwiki here -->
+[[Categoria:Predefinições de documentação|*]]
+[[en:Template:Documentation]]
+[[ru:Шаблон:Документация]]
 </includeonly>
 <noinclude>