Módulo:Documentação/doc
Esta é a página de documentação para Módulo:Documentação
 | Este módulo é usado em um número muito grande de páginas. (Ver Wikipedia:Predefinições em alto risco) Para evitar sobrecargas desnecessárias ao servidor e outros transtornos, quaisquer mudanças devem ser previamente testadas, seja na subpágina de testes deste módulo, na subpágina de testes de módulos (ou ainda em sua subpágina de testes). Por favor, sempre considere expor eventuais mudanças em Predefinição Discussão:Documentação, antes de implementá-las. |
 | Este módulo está na categoria sujeitos a proteção de página. Ele é um módulo de alta visibilidade em uso por um grande número de páginas, ou é transcluído muito frequentemente. Por causa do vandalismo ou erros que podem afetar muitas páginas, e mesmo edições triviais podem causar cargas substanciais nos servidores, ele está protegido de editar. |
 | Este módulo depende dos seguintes outros módulos: |
Erro de script: Nenhum módulo desse tipo "Utiliza TemplateStyles".
Descrição
Este módulo mostra uma caixa azul contendo a documentação de predefinições, módulos Lua, ou outras páginas. Normalmente ele é executado pela predefinição {{documentação}}.
Uso normal
Na maioria das vezes, este módulo deverá ser chamado a partir da predefinição {{documentação}}. Por favor consulte a predefinição para instruções de uso e uma lista de parâmetros.
Uso em outros módulos
Para usar este módulo em outro módulo Lua, primeiro carregue-o com require:
local documentation = require('Módulo:Documentação').main
Então você poderá simplesmente chamá-lo por meio de uma tabela de argumentos.
documentation{content = 'Alguma documentação', ['link box'] = 'Minha customização'}
Por favor veja a documentação da predefinição para instruções de uso e uma lista de parâmetros.
Migração para outras wikis
Há um arquivo de configuração do módulo em Módulo:Documentação/config que visa facilitar a tradução e migração para outras wikis. Por favor consulte os comentários no código da página de configuração para instruções. Se tiver alguma dúvida, ou se precisar de um recurso que atualmente não esteja implementado, por favor deixe uma mensagem na en:Template talk:Documentation para chamar a atenção de um desenvolvedor.
