Módulo:Template invocation/Testes/doc

Esta é uma subpágina de documentação para o Módulo:Template invocation/Testes.
Ela contém informações sobre o seu uso, categorias, bem como todo o conteúdo que não faz parte do módulo original.

Este é um metamódulo para produzir invocações de predefinições MediaWiki.

Uso[editar código-fonte]

Primeiro carregue o módulo:

local mTemplateInvocation = require('Módulo:Template invocation/Testes')

Então você pode usar as funções individuais conforme documentado abaixo.

Name[editar código-fonte]

mTemplateInvocation.name(title)

Esta função produz o nome a ser usado na invocação de uma predefinição. Para páginas no espaço nomeado de predefinições ele retorna o nome da página sem o prefixo do espaço nomeado, para páginas no espaço nomeado principal ele retorna o nome completo da página prefixado com ":" e para outras páginas ele retorna o nome completo da página. title pode ser uma sequência/string ou um objeto mw.title.

Invocation[editar código-fonte]

mTemplateInvocation.invocation(name, args, format)

Esta função cria uma invocação de predefinição [en] MediaWiki.

Parâmetros:

name - o nome da predefinição (sequência/string, obrigatório). Deve ser exatamente como aparecerá na invocação, por exemplo: para Predefinição:Exemplo use "Exemplo". Para gerar o nome da predefinição a partir de um nome de página você pode usar a função name.
args - os argumentos a serem usados na invocação (tabela, obrigatório). As chaves e os valores da tabela devem ser sequências/strings ou números.
format - o formato da invocação (sequência/string, opcional). O padrão é uma invocação normal com chaves, barras verticais e sinais de igual sem escape. Se este parâmetro for a sequência/string "nowiki", então as chaves, barras verticais e sinais de igual serão substituídos pelas entidades HTML [en] apropriadas.

Exemplo

O código mTemplateInvocation.invocation('foo', {'bar', 'baz', abc = 'def'}) produziria {{foo|bar|baz|abc=def}}.