Módulo:Testes/Gkiyoshinishimoto/Message box/doc

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

Uso

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

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

Para criar uma caixa de mensagem, use a função main. São necessários dois parâmetros: o primeiro é o tipo de caixa (como uma string) 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	{{Teste/Gkiyoshinishimoto/Mbox}}	Para que caixas de mensagens sejam usadas em vários espaços nomeados
ambox	{{Teste/Gkiyoshinishimoto/Ambox}}	Para caixas de mensagens de artigos
cmbox	{{Teste/Gkiyoshinishimoto/Cmbox}}	Para caixas de mensagens de categorias
fmbox	{{Teste/Gkiyoshinishimoto/Fmbox}}	Para caixas de mensagens da interface
imbox	{{Teste/Gkiyoshinishimoto/Imbox}}	Para caixas de mensagens dos espaços nomeados de arquivos
tmbox	{{Teste/Gkiyoshinishimoto/Tmbox}}	Para caixas de mensagens de páginas de discussão
ombox	{{Teste/Gkiyoshinishimoto/Ombox}}	Para caixas de mensagens em outros espaços nomeados

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

Uso a partir de "#invoke"

Assim como a função main, este módulo possui funções separadas para cada tipo de caixa. Elas são acessadas ​​usando o código {{#invoke:Testes/Gkiyoshinishimoto/Message box|mbox|...}}, {{#invoke:Testes/Gkiyoshinishimoto/Message box|ambox|...}}, etc. Elas funcionarão quando chamadas de a partir de outros módulos, mas acessam o código usado para processar argumentos passados a partir 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:Testes/Gkiyoshinishimoto/Message box/configuration. Aqui estão as várias opções de configuração e o que elas significam:

• types – uma tabela contendo 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 aquele tipo.
• default – o tipo a ser usado se nenhum valor for passado para o parâmetro de tipo ou se um valor inválido for especificado.
• showInvalidTypeError – se deve mostrar um erro se o valor passado para o parâmetro de tipo for inválido.
• allowBlankParams – normalmente os valores em branco são retirados dos parâmetros passados para o módulo. No entanto, os espaços em branco são preservados 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 da pequena. Por exemplo, se definido como "left", você poderá produzir uma pequena caixa de mensagem usando "small=left".
• smallClass – a classe a ser usada para caixas de mensagens pequenas.
• substCheck – se deve realizar uma verificação secundária ou não.
• classes – um arranjo de classes para usar com a caixa de mensagem.
• imageEmptyCell – se deve usar uma célula <td>...</td> vazia se não houver nenhum conjunto de imagens. Isso é usado para preservar o espaçamento de caixas de mensagens com largura inferior a 100% da tela.
• imageEmptyCellStyle – se as células vazias de imagem devem ser estilizadas.
• imageCheckBlank – se "image=blank" resulta na exibição de nenhuma imagem.
• imageSmallSize – normalmente, as imagens usadas em caixas de mensagens pequenas são definidas para 30x30px. Isso define um tamanho personalizado.
• imageCellDiv – se deve incluir a imagem em um "div" impondo um tamanho máximo de imagem.
• useCollapsibleTextFields – se deve usar campos de texto que podem ser recolhidos, ou seja, "problema", "correção", "conversa", etc. Atualmente usado apenas em "ambox".
• imageRightNone – se "imageright=none" resulta na exibição de nenhuma imagem no lado direito da caixa de mensagem.
• sectionDefault – o nome padrão para o parâmetro "section". Depende de useCollapsibleTextFields.
• allowMainspaceCategories – permite categorização no espaço nomeado principal.
• templateCategory – o nome de uma categoria a ser colocada na página da predefinição.
• templateCategoryRequireName – se o parâmetro name é necessário para mostrar a categoria da predefinição.
• templateErrorCategory – o nome da categoria de erro a ser usada na página da predefinição.
• templateErrorParamsToCheck – um arranjo de nomes de parâmetros a serem verificados. Se algum estiver ausente, templateErrorCategory será aplicado à página da predefinição.