Predefinições são um atributo de MediaWiki muito poderoso, mas podem ser confusos para novos usuários e até mesmo os mais antigos podem enfrentar dificuldades em compreender as predefinições mais complexas. Então as predefinições devem ter uma documentação para melhorar a sua utilidade.
Essa documentação deve explicar o que a predefinição faz e como usá-la. Ela deve ser simples para que alguém seu conhecimento prévio sobre como usar as predefinições possa fazer uso dela corretamente.
O que ela deve incluir?[]
A documentação para algumas predefinições deve conter:
- O propósito da predefinição; o que ela faz/porque ela faz isso.
- O parâmetros da predefinição.
- Exemplos de como usar a predefinição
- mw:Help:TemplateData
- Predefinições relacionadas
- Categorias e interwikis; predefinições com uma subpágina /doc separada lidam com isso de forma diferente.
Como adicionar a documentação[]
Adicionando a predefinição[]
Adicionar a documentação para as predefinições é bem fácil. Você precisa aprender wikitexto para fazer isso.
- Vá para uma predefinição, ex. Predefinição:Stub.
- Edite a página
- No final da página, adicione esse código:
- Save a página.
Se a documentação já existir, você deverá ver texto no rodapé, após a palavra Documentação. O display deverá se assemelhar com isso:
| Predefinição Documentação |
|---|
| Observe: porções da predefinição de exemplo podem ficar invisíveis caso não tenham nenhum valor atribuído |
| Veja ou edite essa documentação. |
| Editores podem experimentar essa páginas de predefinição sandbox e testcases. |
Observe: O display pode variar dependendo das modificações que você fizer em sua wiki.
Criando a documentação[]
Se você tiver uma versão mais avançada da predefinição de documentação, você poderá ver esse popup quando adicionar a predefinição de {{Documentação}} sem a subpágina /doc : Erro de comando: Não existe nenhum módulo "delink". Você pode clicar no link [criar] na predefinição, e ela irá pre-carregar os conteúdos da Template:Documentation/preload. Você pode modificar o texto a vontade.
Do contrário, isso será mostrado: Template:<template>/doc.
Clique no link e escreva o conteúdo sugerido abaixo:
O que adicionar na documentação[]
Existem muitos formatod para escrever a predefinição de documentação. Tenha certeza de ler as regras de sua wiki para ver se existe um padrão para tal.
Caso não haja, fique a vontade para copiar os formatos abaixo. Você pode customizá-los/adotá-los em sua wiki.
Formato básico[]
== Descrição ==
Essa predefinição é usada para fazer algo...
== Syntaxe ==
{{t|Predefinição}}
== Saída de amostra ==
<code>{{Predefinição}}</code> gives:
{{Predefinição}}
Esse é o formato mais básico para uma predefinição. Ele pode ser expandido dependendo do que você queira.
Uma alternatíva para escrever isso seria pelo uso de uma descrição em lista:
;Descrição
: Essa predefinição é usada para fazer algo...
;Syntaxe
: {{t|Predefinição}}
;Saída de amostra
:<code>{{Predefinição}}</code> gives:
:{{Predefinição}}
Predefinições com parâmetros[]
Para predefinições com parâmetros, dependerá do que você quer:
Se a predefinição é usada em artigos, adicionar TemplateData pode ser útil, abaixo está a lista de parâmetros.
Adicione o seguinte código abaixo de == Syntaxe ==:
=== Parâmetros ===
;<code>param=</code>
: Esse parâmetro faz abc.
=== TemplateData ===
<templatedata>{}</templatedata>
Categorias e interwikis[]
Se você estiver usando uma subpágina /doc, aqui estão os passos:
Para a predefinição[]
Para categorias, adicione:
Substitua <Categoria> com o nome da categoria, tal como Stubs.
Para interwikis, adicione:
Para a subpágina /doc[]
Para categorias, adicione:
Substitua <Categoria> com o nome da categoria, tal como Stubs.
Para interwikis, adicione:
Veja também[]
- Wikipedia:Template documentation
- Ajuda:Predefinições
- Ajuda:Wikitexto
- Template:Documentation (copy) na Templates Wiki
- Template:Documentation na Dev Wiki, uma versão Lua da página acima.
Mais ajuda e feedback[]
- Navegue e pesquise outras páginas de ajuda em Ajuda:Conteúdos.
- Confira a Central da Comunidade Fandom para fontes de ajuda e suporte adicional.
- Confira o Contatando o Fandom para saber como relatar quaisquer erros ou medidas pouco claras neste artigo.