Módulo:Message box/Testes/doc

Este é um meta-módulo que implementa as predefinições de caixa de mensagem {{Mbox/Testes}}, , {{Cmbox/Testes}}, {{Fmbox/Testes}}, {{Imbox/Testes}}, {{Ombox/Testes}}, e {{Tmbox/Testes}}. Ele destina-se a ser usado a partir de módulos Lua e não deve ser usado diretamente a partir de páginas wiki. Se você quiser usar a funcionalidade deste módulo a partir de uma página wiki, use as predefinições de caixa de mensagem individuais.

Uso

Para utilizar este módulo a partir de outro módulo Lua, primeiro você precisa carregá-lo.

local messageBox = require('Módulo:Message box/Testes')

Para criar uma caixa de mensagem, use a função main. Ela leva dois parâmetros: o primeiro é o tipo de caixa (como uma sequência ) e o segundo é uma tabela contendo os parâmetros da caixa de mensagem.

local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- Mais parâmetros ...
})

Existem sete tipos de caixas disponíveis:

Tipo de caixa	Predefinição	Propósito
mbox	{{Mbox/Testes}}	Para caixas de mensagens a serem usadas em vários espaços nomeados
ambox		Para caixas de mensagens de artigos
cmbox	{{Cmbox/Testes}}	Para caixas de mensagens de categorias
fmbox	{{Fmbox/Testes}}	Para caixas de mensagens de interface
imbox	{{Imbox/Testes}}	Para caixas de mensagens do espaço nomeado de arquivos
tmbox	{{Tmbox/Testes}}	Para caixas de mensagens de páginas de discussão
ombox	{{Ombox/Testes}}	Para caixas de mensagens em outros espaços nomeados

Consulte a página de predefinição de cada tipo de caixa para os parâmetros disponíveis.

Uso a partir de #invoke

Além da função main, este módulo possui funções separadas para cada tipo de caixa. Elas são acessadas usando o código {{#invoke:Message box/Testes|mbox|...}}, {{#invoke:Message box/Testes|ambox|...}}, etc. Elas funcionarão quando forem chamadas a partir de outros módulos, mas elas acessam o código usado para processar argumentos passados de #invoke e, portanto, chamá-las será menos eficiente do que chamar main.

Detalhes técnicos

O módulo usa o mesmo código básico para cada uma das predefinições listadas acima; as diferenças entre cada uma delas são configuradas usando os dados em Módulo:Message box/Testes/configuration. Aqui estão as várias opções de configuração e o que elas significam:

• types – uma tabela contendo os dados usados pelo parâmetro de tipo da caixa de mensagem. As chaves da tabela são os valores que podem ser passados para o parâmetro de tipo e os valores da tabela são tabelas contendo a classe e a imagem usada por esse tipo.
• default – o tipo a ser usado se nenhum valor for passado para o parâmetro de tipo ou se um valor inválido foi especificado.
• showInvalidTypeError – se deve mostrar um erro se o valor passado para o parâmetro de tipo for inválido.
• allowBlankParams – geralmente os valores em branco são removidos dos parâmetros passados para o módulo. No entanto, o espaço em branco é preservado para os parâmetros incluídos na tabela "allowBlankParams".
• allowSmall – se uma versão pequena da caixa de mensagem pode ser produzida com "small=yes".
• smallParam – um nome personalizado para o parâmetro "small". Por exemplo, se definido como "left", você pode produzir uma pequena caixa de mensagem usando "small=left".
• smallClass – a classe a ser usada para caixas de mensagens pequenas.
• substCheck – se deve executar uma verificação de "subst" ou não.
• classes – um arranjo de classes a serem usadas com a caixa de mensagem.
• imageEmptyCell – se deve usar uma célula <td>...</td> vazia se não houver um conjunto de imagens. Isso é usado para preservar o espaçamento das caixas de mensagem com largura inferior a 100% da tela.
• imageEmptyCellStyle – se as células de imagem vazias devem ser estilizadas.
• imageCheckBlank – se "image=blank" resulta em nenhuma imagem sendo mostrada.
• imageSmallSize – geralmente, as imagens usadas em pequenas caixas de mensagem são definidas em "30x30px". Isso define um tamanho personalizado.
• imageCellDiv – se deseja incluir a imagem em uma "div" aplicando um tamanho máximo de imagem.
• useCollapsibleTextFields – se deve usar campos de texto que podem ser recolhidos, ou seja, "problema", "corrigir", "conversar" etc. Atualmente usado apenas em "ambox".
• imageRightNone – se "imageright=none" resulta em nenhuma imagem sendo mostrada no lado direito da caixa de mensagem.
• sectionDefault – o nome padrão para o parâmetro "section". Depende de useCollapsibleTextFields.
• allowMainspaceCategories – permite a categorização no espaço nomeado principal.
• templateCategory – o nome de uma categoria a ser colocada na página de predefinição.
• templateCategoryRequireName – se o parâmetro name é necessário para mostrar a categoria de predefinição.
• templateErrorCategory – o nome da categoria de erro a ser usada na página de predefinição.
• templateErrorParamsToCheck – um arranjo de nomes de parâmetros para verificar. Se algum estiver ausente, o templateErrorCategory será aplicado à página de predefinição.