Wikipédia:Documentação da predefinição

Origem: Wikipédia, a enciclopédia livre.
Ir para: navegação, pesquisa
O que se segue é um artigo informativo sobre a Wikipédia, que foi entendido como consensual em Wikipédia:Esplanada/propostas/Oficializar artigos informativos (30mai2012).
Prefira utilizar a página de discussão ou até mesmo a esplanada antes de fazer uma modificação que altere o contexto.

Predefinições são uma característica muito poderosa do MediaWiki, mas podem ser confusas para novos usuários e até mesmo usuários experientes podem ter dificuldade em entender as mais complexas. Predefinições devem ser acompanhadas de documentação para melhor usabilidade.

A documentação da predefinição deve explicar o que ela faz e como utilizá-la. Deveria ser simples o suficiente para que usuários sem conhecimento completo das intrincadas sintaxes de predefinições - incluindo muitos editores experientes que possam estar focados em outras atividades - possam usá-las corretamente. Isto é especialmente verdade no caso de predefinições amplamente utilizadas.

Categorias e interwikis[editar | editar código-fonte]

Para colocar a predefinição em uma categoria

Adicione a tag [[Categoria:nomedacategoria]] dentro de uma seção <includeonly>...</includeonly> na subpágina doc. No caso do uso da documentação por meio do parâmetro conteúdo {{Documentação|conteúdo=}}, a tag <includeonly> impede a categorização e não deve ser utilizada.

Para criar um interwiki para a predefinição

Adicione a tag [[Códigodelinguagem:nomecompletodapredefinição]] dentro de uma seção <includeonly>...</includeonly> na subpágina doc. No caso do uso da documentação por meio do parâmetro conteúdo {{Documentação|conteúdo=}}, a tag <includeonly> não deve ser utilizada.

Para colocar a subpágina doc em uma categoria

Adicione a tag: [[Categoria:nomedacategoria]] dentro de uma seção <noinclude>...</noinclude> na subpágina doc.

Para fazer com que a predefinição coloque um artigo em uma categoria (quando o artigo usa a predefinição)

Adicione a tag [[Categoria:nomedacategoria]] dentro de uma seção <includeonly>...</includeonly> na página da predefinição.

Ver também[editar | editar código-fonte]