Sem resumo de edição |
(Correções na tradução) |
||
| (Há 2 revisões intermédias de outro utilizador que não estão a ser apresentadas) | |||
| Linha 1: | Linha 1: | ||
<noinclude>{{doc/start}} |
<noinclude>{{doc/start}} |
||
| − | Para utilizar, crie uma sub-página |
+ | Para utilizar, crie uma sub-página na predefinição chamada '''doc''', insira {{tlx|doc/start}} no início de sua documentação, e {{tlx|doc/end}} no fim dela. |
| − | Volte para a página inicial |
+ | Volte para a página inicial da sua predefinição e insira <noinclude>{{tlx|doc}}</noinclude> em uma nova linha no final da sua página principal. |
Este código fará com que as páginas com /doc sejam automaticamente adicionadas à [[:Categoria:Predefinições de documentação]]. |
Este código fará com que as páginas com /doc sejam automaticamente adicionadas à [[:Categoria:Predefinições de documentação]]. |
||
== Parâmetros Opcionais == |
== Parâmetros Opcionais == |
||
=== clear === |
=== clear === |
||
| − | Se |
+ | Se sua predefinição tem elementos em floating e você gostaria que eles parassem de sobrepor a documentação, insira {{tlx|doc/start|clear}} ao invés de {{tlx|doc/start}} na sua página de documentação.<br> |
| − | + | Isso também é útil para predefinições que não usam <includeonly>, já que ele colocará um pouco de espaço entre a predefinição e a caixa de documentação. |
|
=== nodoc=1 === |
=== nodoc=1 === |
||
| − | Se |
+ | Se uma predefinição não tem documentação e você não sabe como usar, insira {{tlx|doc/start|nodoc{{=}}1}} (ou se a predefinição também precisar de um clear, {{tlx|doc/start|clear|nodoc{{=}}1}}) em vez de {{tlx|doc/start}} na sua página de documentação.<br> |
O fundo da documentação ficará vermelho para tornar-se mais visualizável, e a página será adicionada a [[:Categoria:Predefinições sem documentação]]. |
O fundo da documentação ficará vermelho para tornar-se mais visualizável, e a página será adicionada a [[:Categoria:Predefinições sem documentação]]. |
||
=== baddoc=1 === |
=== baddoc=1 === |
||
| − | Similar ao nodoc, é usado para marcar |
+ | Similar ao nodoc, é usado para marcar predefinições em que '''tem''' documentação, mas que não estão boas. Isso pode significar que ela não tem exemplos o suficiente, não explica todas as funções corretamente, ou não explica o uso da predefinição corretamente.<br> |
O fundo da página de documentação ficará amarelo, e a página será adicionada a [[:Categoria:Predefinições com má documentação]]. |
O fundo da página de documentação ficará amarelo, e a página será adicionada a [[:Categoria:Predefinições com má documentação]]. |
||
| Linha 22: | Linha 22: | ||
[[Categoria:Predefinições de documentação| ]] |
[[Categoria:Predefinições de documentação| ]] |
||
| + | |||
| + | [[en:Template:Doc]] |
||
| + | [[ru:Шаблон:Док]] |
||
| + | [[tr:Şablon:Belge]] |
||
</noinclude><includeonly>{{/doc}}</includeonly> |
</noinclude><includeonly>{{/doc}}</includeonly> |
||
Edição atual desde as 20h41min de 24 de fevereiro de 2021
Para utilizar, crie uma sub-página na predefinição chamada doc, insira {{doc/start}} no início de sua documentação, e {{doc/end}} no fim dela.
Volte para a página inicial da sua predefinição e insira <noinclude>{{doc}}</noinclude> em uma nova linha no final da sua página principal.
Este código fará com que as páginas com /doc sejam automaticamente adicionadas à Categoria:Predefinições de documentação.
Parâmetros Opcionais
clear
Se sua predefinição tem elementos em floating e você gostaria que eles parassem de sobrepor a documentação, insira {{doc/start|clear}} ao invés de {{doc/start}} na sua página de documentação.
Isso também é útil para predefinições que não usam <includeonly>, já que ele colocará um pouco de espaço entre a predefinição e a caixa de documentação.
nodoc=1
Se uma predefinição não tem documentação e você não sabe como usar, insira {{doc/start|nodoc=1}} (ou se a predefinição também precisar de um clear, {{doc/start|clear|nodoc=1}}) em vez de {{doc/start}} na sua página de documentação.
O fundo da documentação ficará vermelho para tornar-se mais visualizável, e a página será adicionada a Categoria:Predefinições sem documentação.
baddoc=1
Similar ao nodoc, é usado para marcar predefinições em que tem documentação, mas que não estão boas. Isso pode significar que ela não tem exemplos o suficiente, não explica todas as funções corretamente, ou não explica o uso da predefinição corretamente.
O fundo da página de documentação ficará amarelo, e a página será adicionada a Categoria:Predefinições com má documentação.
Se ambos nodoc e baddoc forem especificados, baddoc será ignorado.