Módulo:Template invocation/doc
Isto é 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')
Depois pode usar as funções individuais conforme a documentação abaixo.
Name
[editar código-fonte]mTemplateInvocation.name(title)
Esta função produz o nome que vai ser usado na invocação de predefinição. Para páginas no domínio predefinição devolve o nome da página com o prefixo do domínio, para páginas no domínio principal devolve o nome da página com prefixo ":", e para outras páginas devolve o nome completo da página. título pode ser um texto ou mw.title object. Se o título é um texto, o mw.title object é criado para ele, que é caro.
Invocação
[editar código-fonte]mTemplateInvocation.invocation(name, args, format)
Esta função cria a invocação de predefinição MediaWiki.
Parâmetros:
- name - o nome da predefinição (string, obrigatório). Este deve ser exatamente como vai aparecer na invocação, e.g. para Predefinição:Exemplo use "Exemplo". Para gerar o nome da predefinição do nome da página pode usar a função name.
- args - os argumentos que vai usar na invocação (table, obrigatório). As chaves da tabela devem ser alfanuméricos ou numéricos.
- format - o formato da invocação (string, opcional). Por defeitos
é uma invocação normal sem caracteres {}, |, e = . Se o parâmetro é o texto "nowiki", os caracteres {}, |, e = são substituídos pelos códigos HTML apropriados.
Exemplo
O código <nowiki>mTemplateInvocation.invocation('foo', {'bar', 'baz', abc = 'def'})</nowiki> deve produzir {{foo|bar|baz|abc=def}}.