Módulo:Documentação/doc

{{#invoke:Message box|ombox}} {{#invoke:Erro| error | tag= |Erro: A predefinição {{Module rating}} deve ser colocada no domínio Módulo.}} {{#invoke:Lua banner|main}} {{#invoke:Utiliza TemplateStyles|main}}

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:

<syntaxhighlight lang="lua"> local documentation = require('Módulo:Documentação').main </syntaxhighlight>

Então você poderá simplesmente chamá-lo por meio de uma tabela de argumentos. <syntaxhighlight lang="lua"> documentation{content = 'Alguma documentação', ['link box'] = 'Minha customização'} </syntaxhighlight>

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.