Predefinição:Doc
Para utilizar, crie uma sub-página no template chamada doc, insira {{doc/start}}
no início de sua documentação, e {{doc/end}}
no fim dela.
Volte para a página inicial do seu template 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 seu template 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.
Também é aconselhável não usar <includeonly>, pois irá inserir um espaço entre o template e a caixa de documentação.
nodoc=1
Se um template não tem documentação e você não sabe como usar, insira {{doc/start|nodoc=1}}
(ou se o template precisa ser bem claro, {{doc/start|clear|nodoc=1}}
) ao invés 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 templates em que o do tem documentação, mas não está bem estruturado. Isso significa que ele não está bem explicado ou não mostra todas as funções 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.