3 167
edições
Mudanças
Criação da Documentação do Módulo Arguments.
<section begin=header />
{{#ifeq:{{#invoke:String|find|{{FULLPAGENAME}}|Testes}}|0|<includeonly>{{Module rating|p}}{{alto risco| 1180000}}</includeonly>}}<!-- if pagename does not contain sandbox -->
<section end=header />
Este módulo facilita o processamento de argumentos passados por um comando <code>#invoke</code>. Ele é um meta-módulo, destinado ao uso por outros módulos, e não deve ser chamado diretamente por <code>#invoke</code>. Suas funcionalidades incluem:
* Fácil remoção de espaços em torno dos argumentos e de argumentos em branco.
* Argumentos podem ser passados ao mesmo tempo tanto pelo ''frame'' atual quanto pelo ''frame'' pai. (Mais detalhes abaixo.)
* Argumentos podem ser passados diretamente a partir de outro módulo Lua ou do console de depuração.
* Argumentos são obtidos quando necessários, o que evita (alguns) problemas com elementos {{tag|ref}}.
* A maioria das funcionalidades pode ser personalizada.
=== Uso básico ===
Primeiro, você precisa carregar o módulo. Ele contém uma função, chamada <code>getArgs</code>.
<source lang="lua">
local getArgs = require('Module:Arguments').getArgs
</source>
No cenário mais básico, você pode utilizar <code>getArgs</code> dentro de sua função principal, <code>main</code>. A variável <code>args</code> é uma tabela contendo os argumentos de <code>#invoke</code>. (Ver abaixo para detalhes.)
<source lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
function p.main(frame)
local args = getArgs(frame)
-- O código principal do módulo vai aqui.
end
return p
</source>
No entanto, a prática recomendada é utilizar uma função apenas para o processamento dos argumentos de <code>#invoke</code>. Isso significa que se alguém chamar o seu módulo a partir de outro módulo Lua você não precisa ter o objeto ''frame'' disponível, o que melhora o desempenho.
<source lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
function p.main(frame)
local args = getArgs(frame)
return p._main(args)
end
function p._main(args)
-- O código principal do módulo vai aqui.
end
return p
</source>
Se você quer que várias funções utilizem os argumentos, e você também quer que eles sejam acessíveis a partir de <code>#invoke</code>, você pode utilizar uma função ''wrapper''.
<source lang="lua">
local getArgs = require('Module:Arguments').getArgs
local function makeInvokeFunc(funcName)
return function (frame)
local args = getArgs(frame)
return p[funcName](args)
end
end
local p = {}
p.func1 = makeInvokeFunc('_func1')
function p._func1(args)
-- O código para a primeira função vai aqui.
end
p.func2 = makeInvokeFunc('_func2')
function p._func2(args)
-- O código para a segunda função vai aqui.
end
return p
</source>
=== Opções ===
Estão disponíveis as seguintes opções. Elas são explicadas nas seções abaixo.
<source lang="lua">
local args = getArgs(frame, {
trim = false,
removeBlanks = false,
valueFunc = function (key, value)
-- Código para processar um argumento
end,
frameOnly = true,
parentOnly = true,
parentFirst = true,
wrappers = {
'Predefinição:Um invólucro',
'Predefinição:Outro invólucro'
},
readOnly = true,
noOverwrite = true
})
</source>
=== Remoção de espaços e parâmetros em branco ===
Argumentos em branco geralmente confundem os programadores que tentam converter predefinições do MediaWiki para Lua. Na sintaxe das predefinições, as strings vazias e aquelas que consistem apenas de espaços em branco são consideradas equivalentes a ''falso''. No entanto, em Lua, tais strings são consideradas equivalentes a ''verdadeiro''. Isso significa que se você não prestar atenção ao lidar com estes argumentos durante o desenvolvimento de módulos em Lua, você pode tratar algo como verdadeiro quando na verdade deveria ser falso. Para evitar isso, por padrão este módulo remove todos os argumentos em branco.
Analogamente, espaços em branco podem causar problemas ao lidar com argumentos posicionais. Embora eles sejam removidos de parâmetros com nome vindos de <code>#invoke</code>, eles são preservados nos argumentos posicionais. Na maioria das vezes esses espaços extras não são desejados, então este módulo remove-os por padrão.
No entanto, algumas vezes você quer aceitar argumentos em branco como entrada e algumas vezes você quer manter espaços extras. Isso pode ser necessário para converter algumas predefinições exatamente da forma como foram escritas. Se você quer fazer isso, você pode definir os parâmetros <code>trim</code> e <code>removeBlanks</code> com o valor <code>false</code>.
<source lang="lua">
local args = getArgs(frame, {
trim = false,
removeBlanks = false
})
</source>
=== Formatação personalizada dos argumentos ===
Algumas vezes você quer remover alguns argumentos em branco mas não outros, ou talvez converter os valores de todos os argumentos posicionais para minúsculas. Para fazer coisas deste tipo você pode usar a opção <code>valueFunc</code>. Este parâmetro aceita como entrada uma função que recebe dois parâmetros, <code>key</code> e <code>value</code>, e retorna um único valor. Este valor é o que será obtido ao acessar o campo <code>key</code> da tabela <code>args</code>.
Exemplo 1: esta função preserva os espaços em branco para o primeiro argumento posicional, mas remove-os dos demais e também remove os demais argumentos em branco.
<source lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
if key == 1 then
return value
elseif value then
value = mw.text.trim(value)
if value ~= '' then
return value
end
end
return nil
end
})
</source>
Exemplo 2: esta função remove parâmetros em branco e converte todos os argumentos para minúsculas, mas não remove espaços dos argumentos posicionais.
<source lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
if not value then
return nil
end
value = mw.ustring.lower(value)
if mw.ustring.find(value, '%S') then
return value
end
return nil
end
})
</source>
Nota: a função acima falhará se receber como entrada algo que não seja do tipo <code>string</code> ou <code>nil</code>. Isso pode ocorrer se utilizar a função <code>getArgs</code> na função principal (''main'') do seu módulo, e aquela função for chamada por outro módulo Lua. Neste caso, você precisará conferir o tipo de sua entrada. Esse problema não ocorre se utilizar uma função especifica para lidar com argumentos de #invoke (isto é, se houver uma função <code>p.main</code> e uma <code>p._main</code>, ou algo parecido).
{| class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
|+ Exemplos 1 e 2 com verificação de tipos
|-
|Exemplo 1:
<source lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
if key == 1 then
return value
elseif type(value) == 'string' then
value = mw.text.trim(value)
if value ~= '' then
return value
else
return nil
end
else
return value
end
end
})
</source>
|-
|Exemplo 2:
<source lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
if type(value) == 'string' then
value = mw.ustring.lower(value)
if mw.ustring.find(value, '%S') then
return value
else
return nil
end
else
return value
end
end
})
</source>
|}
Além disso, por favor note que a função <code>valueFunc</code> é chamada praticamente a cada vez que um argumento é requisitado da tabela <code>args</code>, etão se você se preocupa com o desempenho você deve se certificar de não fazer nada ineficiente com o seu código.
=== ''Frames'' e ''frames'' pais ===
Os argumentos da tabela <code>args</code> podem ser passados simultaneamente do ''frame'' atual ou de seu ''frame'' pai. Para entender o que isso significa, é mais fácil dar um exemplo. Digamos que termos um módulo chamado <code>Módulo:ExampleArgs</code>. Este módulo imprime os dois primeiros parâmetros posicionais que ele recebe.
{| class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
|+ Código do Módulo:ExampleArgs
|-
|<source lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
function p.main(frame)
local args = getArgs(frame)
return p._main(args)
end
function p._main(args)
local first = args[1] or ''
local second = args[2] or ''
return first .. ' ' .. second
end
return p
</source>
|}
O <code>Módulo:ExampleArgs</code> é chamado pela <code>Predefinição:ExampleArgs</code>, que contém o código <code><nowiki>{{#invoke:ExampleArgs|main|firstInvokeArg}}</nowiki></code>. Isso produz como resultado "firstInvokeArg".
Agora, se chamarmos a <code>Predefinição:ExampleArgs</code>, acontece o seguinte:
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Código
! style="width: 40%;" | Resultado
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstInvokeArg secondTemplateArg
|}
Há três opções que você pode definir para alterar este comportamento: <code>frameOnly</code>, <code>parentOnly</code> e <code>parentFirst</code>. Se você definir <code>frameOnly</code> então só serão aceitos os argumentos passados do ''frame'' atual; se você definir <code>parentOnly</code> então só serão aceitos os argumentos passados do ''frame'' pai; e se você definir <code>parentFirst</code> os argumentos serão passados de ambos os ''frames'', mas os do ''frame'' pai terão prioridade sobre o ''frame'' atual. Estes são os resultados em termos da <code>Predefinição:ExampleArgs</code>:
'''frameOnly'''
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Código
! style="width: 40%;" | Resultado
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstInvokeArg
|}
'''parentOnly'''
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Código
! style="width: 40%;" | Resultado
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
|
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstTemplateArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstTemplateArg secondTemplateArg
|}
'''parentFirst'''
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Código
! style="width: 40%;" | Resultado
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstTemplateArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstTemplateArg secondTemplateArg
|}
Notas:
# Se você definir tanto a opção <code>frameOnly</code> quanto a opção <code>parentOnly</code>, o módulo não vai obter nenhum argumento de <code>#invoke</code>. Isso provavelmente não é o que você quer.
# Em algumas situações pode não estar disponível um módulo pai, por exemplo, se for passado para getArgs o ''frame'' pai em vez do ''frame'' atual. Neste caso, somente os argumentos do ''frame'' serão utilizados (a não ser que parentOnly esteja definido, mas neste caso nenhum argumento será utilizado) e as opções <code>parentFirst</code> e <code>frameOnly</code> não terão qualquer efeito.
=== Invólucros ===
A opção ''wrappers'' é utilizada para especificar um número limitado de ''predefinições de invólucro'', isto é, predefinições cujo único objetivo é chamar um módulo. Se o módulo detecta que está sendo chamado de uma predefinição de invólucro, ele procurará apenas argumentos do ''frame'' pai; caso contrário ele procurará apenas argumentos no ''frame'' passado para getArgs. Isso permite que os módulos sejam chamados tanto por #invoke quanto através de uma predefinição de invólucro sem a perda de desempenho associada à chacagem tanto do ''frame'' quanto do ''frame'' pai ao verificar cada argumento.
Por exemplo, o conteúdo da [[:en:Template:Side box]] (excluindo o conteúdo das tags {{tag|noinclude}}) é <code><nowiki>{{#invoke:Side box|main}}</nowiki></code>. Não faz sentido procurar argumentos passados diretamente para a declaração #invoke desta predefinição, pois nenhum argumento jamais será especificado lá. Podemos evitar a busca destes argumentos passados para #invoke utilizando a opção ''parentOnly'', mas se fizermos isso então a #invoke também não funcionará a partir de outras páginas. Se esse fosse o caso, o {{Parâmetro|text|Algum texto}} no código <code><nowiki>{{#invoke:Side box|main|text=Algum texto}}</nowiki></code> seria completamente ignorado, não importando em que página ele tivesse sido usado. Utilizando a opção <code>wrappers</code> para especificar 'Template:Side box' como um invólucro, podemos fazer com que <code><nowiki>{{#invoke:Side box|main|text=Algum texto}}</nowiki></code> funcione na maioria das páginas, sem exigir que o módulo tenha que procurar argumentos na própria página da [[:en:Template:Side box]].
Os invólucros podem ser especificados tanto como uma cadeia de caracteres (''string'') quanto como uma ''array'' de cadeias de caracteres.
<source lang="lua">
local args = getArgs(frame, {
wrappers = 'Predefinição:Predefinição de invólucro'
})
</source>
<source lang="lua">
local args = getArgs(frame, {
wrappers = {
'Predefinição:Um invólucro',
'Predefinição:Outro invólucro',
-- Pode-se inserir qualquer número de invólucros aqui.
}
})
</source>
Notas:
# O módulo detectará automaticamente se ele está sendo chamado da subpágina /Testes da predefinição, então não há necessidade de especificar as páginas de testes explicitamente.
# A opção ''wrappers'' sobrescreve as opções ''frameOnly'', ''parentOnly'' e ''parentFirst''. Se a opção ''wrappers'' estiver definida, nenhuma delas terá efeito.
# Se a opção ''wrappers'' estiver definida e não houver um ''frame'' pai disponível, o módulo sempre obterá os argumentos do ''frame'' passado para <code>getArgs</code>.
=== Escrevendo na tabela de argumentos ===
Algumas vezes pode ser útil escrever novos valores na tabela de argumentos. Isso é possível com a configuração padrão do módulo. (No entanto, tenha em mente que geralmente um estilo de programação melhor seria criar uma nova tabela com os seus novos argumentos e copiar os argumentos da tabela <code>args</code> conforme fossem necessários.)
<source lang="lua">
args.foo = 'algum valor'
</source>
É possível alterar este comportamento com as opções <code>readOnly</code> e <code>noOverwrite</code>. Se for definido <code>readOnly</code> então não será possível escrever quaisquer valores na tabela <code>args</code>. Se for definido <code>noOverwrite</code>, então será possível incluir novos valores na tabela, exceto se eles fossem sobrescrever argumentos que foram passados por <code>#invoke</code>.
=== Elementos "ref" ===
Este módulo utiliza [[mw:Extension:Scribunto/Lua reference manual#Metatables|metatables]] para obter argumentos de <code>#invoke</code>. Isso permite acesso tanto aos argumentos do ''frame'' atual quanto do ''frame'' pai sem ter que utilizar a função <code>pairs()</code>. Isso ajuda se o seu módulo pode receber elementos {{tag|ref}} como entrada.
Assim que os elementos {{tag|ref}} são acessados em Lua, eles são processados pelo software do MediaWiki e a referência aparecerá na lista de referências do artigo. Se o seu módulo omite o elemento de referência de sua saída, você obterá uma referência fantasma - uma referência que aparece na lista de referências, mas sem números ligando-se a ela. Esse problema ocorreu com módulos que usam <code>pairs()</code> para detectar se devem ser utilizados argumentos do ''frame'' atual ou de seu pai, porque tais módulos processam automaticamente todos os argumentos disponíveis.
Este módulo resolve esse problema permitindo o acesso tanto aos argumentos do ''frame'' atual quanto aos do ''frame'' pai, ao mesmo tempo em que só requisita esses argumentos quando são necessários. No entanto, o problema ainda ocorrerá se você utilizar <code>pairs(args)</code> em outros lugares do seu módulo.
=== Limitações conhecidas ===
O uso de ''metatables'' também tem aspectos negativos. A maioria das ferramentas normais para tabelas em Lua não funcionarão adequadamente na tabela <code>args</code>, incluindo o operador <code>#</code>, a função <code>next()</code>, e as funções da biblioteca table. Se o uso disso é importante para o seu módulo, você deve utilizar a sua própria função de processamento de argumentos em vez deste módulo.
== Ver também ==
* [[Wikipédia:Projetos/Scribunto]]
<includeonly>
<!-- Categorias aqui e links para outros idiomas no Wikidata -->
{{#ifeq:{{SUBPAGENAME}}|Testes||
[[Categoria:!Módulos]]
[[Categoria:!Metamódulos Lua]]
}}</includeonly>
{{#ifeq:{{#invoke:String|find|{{FULLPAGENAME}}|Testes}}|0|<includeonly>{{Module rating|p}}{{alto risco| 1180000}}</includeonly>}}<!-- if pagename does not contain sandbox -->
<section end=header />
Este módulo facilita o processamento de argumentos passados por um comando <code>#invoke</code>. Ele é um meta-módulo, destinado ao uso por outros módulos, e não deve ser chamado diretamente por <code>#invoke</code>. Suas funcionalidades incluem:
* Fácil remoção de espaços em torno dos argumentos e de argumentos em branco.
* Argumentos podem ser passados ao mesmo tempo tanto pelo ''frame'' atual quanto pelo ''frame'' pai. (Mais detalhes abaixo.)
* Argumentos podem ser passados diretamente a partir de outro módulo Lua ou do console de depuração.
* Argumentos são obtidos quando necessários, o que evita (alguns) problemas com elementos {{tag|ref}}.
* A maioria das funcionalidades pode ser personalizada.
=== Uso básico ===
Primeiro, você precisa carregar o módulo. Ele contém uma função, chamada <code>getArgs</code>.
<source lang="lua">
local getArgs = require('Module:Arguments').getArgs
</source>
No cenário mais básico, você pode utilizar <code>getArgs</code> dentro de sua função principal, <code>main</code>. A variável <code>args</code> é uma tabela contendo os argumentos de <code>#invoke</code>. (Ver abaixo para detalhes.)
<source lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
function p.main(frame)
local args = getArgs(frame)
-- O código principal do módulo vai aqui.
end
return p
</source>
No entanto, a prática recomendada é utilizar uma função apenas para o processamento dos argumentos de <code>#invoke</code>. Isso significa que se alguém chamar o seu módulo a partir de outro módulo Lua você não precisa ter o objeto ''frame'' disponível, o que melhora o desempenho.
<source lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
function p.main(frame)
local args = getArgs(frame)
return p._main(args)
end
function p._main(args)
-- O código principal do módulo vai aqui.
end
return p
</source>
Se você quer que várias funções utilizem os argumentos, e você também quer que eles sejam acessíveis a partir de <code>#invoke</code>, você pode utilizar uma função ''wrapper''.
<source lang="lua">
local getArgs = require('Module:Arguments').getArgs
local function makeInvokeFunc(funcName)
return function (frame)
local args = getArgs(frame)
return p[funcName](args)
end
end
local p = {}
p.func1 = makeInvokeFunc('_func1')
function p._func1(args)
-- O código para a primeira função vai aqui.
end
p.func2 = makeInvokeFunc('_func2')
function p._func2(args)
-- O código para a segunda função vai aqui.
end
return p
</source>
=== Opções ===
Estão disponíveis as seguintes opções. Elas são explicadas nas seções abaixo.
<source lang="lua">
local args = getArgs(frame, {
trim = false,
removeBlanks = false,
valueFunc = function (key, value)
-- Código para processar um argumento
end,
frameOnly = true,
parentOnly = true,
parentFirst = true,
wrappers = {
'Predefinição:Um invólucro',
'Predefinição:Outro invólucro'
},
readOnly = true,
noOverwrite = true
})
</source>
=== Remoção de espaços e parâmetros em branco ===
Argumentos em branco geralmente confundem os programadores que tentam converter predefinições do MediaWiki para Lua. Na sintaxe das predefinições, as strings vazias e aquelas que consistem apenas de espaços em branco são consideradas equivalentes a ''falso''. No entanto, em Lua, tais strings são consideradas equivalentes a ''verdadeiro''. Isso significa que se você não prestar atenção ao lidar com estes argumentos durante o desenvolvimento de módulos em Lua, você pode tratar algo como verdadeiro quando na verdade deveria ser falso. Para evitar isso, por padrão este módulo remove todos os argumentos em branco.
Analogamente, espaços em branco podem causar problemas ao lidar com argumentos posicionais. Embora eles sejam removidos de parâmetros com nome vindos de <code>#invoke</code>, eles são preservados nos argumentos posicionais. Na maioria das vezes esses espaços extras não são desejados, então este módulo remove-os por padrão.
No entanto, algumas vezes você quer aceitar argumentos em branco como entrada e algumas vezes você quer manter espaços extras. Isso pode ser necessário para converter algumas predefinições exatamente da forma como foram escritas. Se você quer fazer isso, você pode definir os parâmetros <code>trim</code> e <code>removeBlanks</code> com o valor <code>false</code>.
<source lang="lua">
local args = getArgs(frame, {
trim = false,
removeBlanks = false
})
</source>
=== Formatação personalizada dos argumentos ===
Algumas vezes você quer remover alguns argumentos em branco mas não outros, ou talvez converter os valores de todos os argumentos posicionais para minúsculas. Para fazer coisas deste tipo você pode usar a opção <code>valueFunc</code>. Este parâmetro aceita como entrada uma função que recebe dois parâmetros, <code>key</code> e <code>value</code>, e retorna um único valor. Este valor é o que será obtido ao acessar o campo <code>key</code> da tabela <code>args</code>.
Exemplo 1: esta função preserva os espaços em branco para o primeiro argumento posicional, mas remove-os dos demais e também remove os demais argumentos em branco.
<source lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
if key == 1 then
return value
elseif value then
value = mw.text.trim(value)
if value ~= '' then
return value
end
end
return nil
end
})
</source>
Exemplo 2: esta função remove parâmetros em branco e converte todos os argumentos para minúsculas, mas não remove espaços dos argumentos posicionais.
<source lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
if not value then
return nil
end
value = mw.ustring.lower(value)
if mw.ustring.find(value, '%S') then
return value
end
return nil
end
})
</source>
Nota: a função acima falhará se receber como entrada algo que não seja do tipo <code>string</code> ou <code>nil</code>. Isso pode ocorrer se utilizar a função <code>getArgs</code> na função principal (''main'') do seu módulo, e aquela função for chamada por outro módulo Lua. Neste caso, você precisará conferir o tipo de sua entrada. Esse problema não ocorre se utilizar uma função especifica para lidar com argumentos de #invoke (isto é, se houver uma função <code>p.main</code> e uma <code>p._main</code>, ou algo parecido).
{| class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
|+ Exemplos 1 e 2 com verificação de tipos
|-
|Exemplo 1:
<source lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
if key == 1 then
return value
elseif type(value) == 'string' then
value = mw.text.trim(value)
if value ~= '' then
return value
else
return nil
end
else
return value
end
end
})
</source>
|-
|Exemplo 2:
<source lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
if type(value) == 'string' then
value = mw.ustring.lower(value)
if mw.ustring.find(value, '%S') then
return value
else
return nil
end
else
return value
end
end
})
</source>
|}
Além disso, por favor note que a função <code>valueFunc</code> é chamada praticamente a cada vez que um argumento é requisitado da tabela <code>args</code>, etão se você se preocupa com o desempenho você deve se certificar de não fazer nada ineficiente com o seu código.
=== ''Frames'' e ''frames'' pais ===
Os argumentos da tabela <code>args</code> podem ser passados simultaneamente do ''frame'' atual ou de seu ''frame'' pai. Para entender o que isso significa, é mais fácil dar um exemplo. Digamos que termos um módulo chamado <code>Módulo:ExampleArgs</code>. Este módulo imprime os dois primeiros parâmetros posicionais que ele recebe.
{| class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
|+ Código do Módulo:ExampleArgs
|-
|<source lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
function p.main(frame)
local args = getArgs(frame)
return p._main(args)
end
function p._main(args)
local first = args[1] or ''
local second = args[2] or ''
return first .. ' ' .. second
end
return p
</source>
|}
O <code>Módulo:ExampleArgs</code> é chamado pela <code>Predefinição:ExampleArgs</code>, que contém o código <code><nowiki>{{#invoke:ExampleArgs|main|firstInvokeArg}}</nowiki></code>. Isso produz como resultado "firstInvokeArg".
Agora, se chamarmos a <code>Predefinição:ExampleArgs</code>, acontece o seguinte:
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Código
! style="width: 40%;" | Resultado
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstInvokeArg secondTemplateArg
|}
Há três opções que você pode definir para alterar este comportamento: <code>frameOnly</code>, <code>parentOnly</code> e <code>parentFirst</code>. Se você definir <code>frameOnly</code> então só serão aceitos os argumentos passados do ''frame'' atual; se você definir <code>parentOnly</code> então só serão aceitos os argumentos passados do ''frame'' pai; e se você definir <code>parentFirst</code> os argumentos serão passados de ambos os ''frames'', mas os do ''frame'' pai terão prioridade sobre o ''frame'' atual. Estes são os resultados em termos da <code>Predefinição:ExampleArgs</code>:
'''frameOnly'''
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Código
! style="width: 40%;" | Resultado
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstInvokeArg
|}
'''parentOnly'''
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Código
! style="width: 40%;" | Resultado
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
|
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstTemplateArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstTemplateArg secondTemplateArg
|}
'''parentFirst'''
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Código
! style="width: 40%;" | Resultado
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstTemplateArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstTemplateArg secondTemplateArg
|}
Notas:
# Se você definir tanto a opção <code>frameOnly</code> quanto a opção <code>parentOnly</code>, o módulo não vai obter nenhum argumento de <code>#invoke</code>. Isso provavelmente não é o que você quer.
# Em algumas situações pode não estar disponível um módulo pai, por exemplo, se for passado para getArgs o ''frame'' pai em vez do ''frame'' atual. Neste caso, somente os argumentos do ''frame'' serão utilizados (a não ser que parentOnly esteja definido, mas neste caso nenhum argumento será utilizado) e as opções <code>parentFirst</code> e <code>frameOnly</code> não terão qualquer efeito.
=== Invólucros ===
A opção ''wrappers'' é utilizada para especificar um número limitado de ''predefinições de invólucro'', isto é, predefinições cujo único objetivo é chamar um módulo. Se o módulo detecta que está sendo chamado de uma predefinição de invólucro, ele procurará apenas argumentos do ''frame'' pai; caso contrário ele procurará apenas argumentos no ''frame'' passado para getArgs. Isso permite que os módulos sejam chamados tanto por #invoke quanto através de uma predefinição de invólucro sem a perda de desempenho associada à chacagem tanto do ''frame'' quanto do ''frame'' pai ao verificar cada argumento.
Por exemplo, o conteúdo da [[:en:Template:Side box]] (excluindo o conteúdo das tags {{tag|noinclude}}) é <code><nowiki>{{#invoke:Side box|main}}</nowiki></code>. Não faz sentido procurar argumentos passados diretamente para a declaração #invoke desta predefinição, pois nenhum argumento jamais será especificado lá. Podemos evitar a busca destes argumentos passados para #invoke utilizando a opção ''parentOnly'', mas se fizermos isso então a #invoke também não funcionará a partir de outras páginas. Se esse fosse o caso, o {{Parâmetro|text|Algum texto}} no código <code><nowiki>{{#invoke:Side box|main|text=Algum texto}}</nowiki></code> seria completamente ignorado, não importando em que página ele tivesse sido usado. Utilizando a opção <code>wrappers</code> para especificar 'Template:Side box' como um invólucro, podemos fazer com que <code><nowiki>{{#invoke:Side box|main|text=Algum texto}}</nowiki></code> funcione na maioria das páginas, sem exigir que o módulo tenha que procurar argumentos na própria página da [[:en:Template:Side box]].
Os invólucros podem ser especificados tanto como uma cadeia de caracteres (''string'') quanto como uma ''array'' de cadeias de caracteres.
<source lang="lua">
local args = getArgs(frame, {
wrappers = 'Predefinição:Predefinição de invólucro'
})
</source>
<source lang="lua">
local args = getArgs(frame, {
wrappers = {
'Predefinição:Um invólucro',
'Predefinição:Outro invólucro',
-- Pode-se inserir qualquer número de invólucros aqui.
}
})
</source>
Notas:
# O módulo detectará automaticamente se ele está sendo chamado da subpágina /Testes da predefinição, então não há necessidade de especificar as páginas de testes explicitamente.
# A opção ''wrappers'' sobrescreve as opções ''frameOnly'', ''parentOnly'' e ''parentFirst''. Se a opção ''wrappers'' estiver definida, nenhuma delas terá efeito.
# Se a opção ''wrappers'' estiver definida e não houver um ''frame'' pai disponível, o módulo sempre obterá os argumentos do ''frame'' passado para <code>getArgs</code>.
=== Escrevendo na tabela de argumentos ===
Algumas vezes pode ser útil escrever novos valores na tabela de argumentos. Isso é possível com a configuração padrão do módulo. (No entanto, tenha em mente que geralmente um estilo de programação melhor seria criar uma nova tabela com os seus novos argumentos e copiar os argumentos da tabela <code>args</code> conforme fossem necessários.)
<source lang="lua">
args.foo = 'algum valor'
</source>
É possível alterar este comportamento com as opções <code>readOnly</code> e <code>noOverwrite</code>. Se for definido <code>readOnly</code> então não será possível escrever quaisquer valores na tabela <code>args</code>. Se for definido <code>noOverwrite</code>, então será possível incluir novos valores na tabela, exceto se eles fossem sobrescrever argumentos que foram passados por <code>#invoke</code>.
=== Elementos "ref" ===
Este módulo utiliza [[mw:Extension:Scribunto/Lua reference manual#Metatables|metatables]] para obter argumentos de <code>#invoke</code>. Isso permite acesso tanto aos argumentos do ''frame'' atual quanto do ''frame'' pai sem ter que utilizar a função <code>pairs()</code>. Isso ajuda se o seu módulo pode receber elementos {{tag|ref}} como entrada.
Assim que os elementos {{tag|ref}} são acessados em Lua, eles são processados pelo software do MediaWiki e a referência aparecerá na lista de referências do artigo. Se o seu módulo omite o elemento de referência de sua saída, você obterá uma referência fantasma - uma referência que aparece na lista de referências, mas sem números ligando-se a ela. Esse problema ocorreu com módulos que usam <code>pairs()</code> para detectar se devem ser utilizados argumentos do ''frame'' atual ou de seu pai, porque tais módulos processam automaticamente todos os argumentos disponíveis.
Este módulo resolve esse problema permitindo o acesso tanto aos argumentos do ''frame'' atual quanto aos do ''frame'' pai, ao mesmo tempo em que só requisita esses argumentos quando são necessários. No entanto, o problema ainda ocorrerá se você utilizar <code>pairs(args)</code> em outros lugares do seu módulo.
=== Limitações conhecidas ===
O uso de ''metatables'' também tem aspectos negativos. A maioria das ferramentas normais para tabelas em Lua não funcionarão adequadamente na tabela <code>args</code>, incluindo o operador <code>#</code>, a função <code>next()</code>, e as funções da biblioteca table. Se o uso disso é importante para o seu módulo, você deve utilizar a sua própria função de processamento de argumentos em vez deste módulo.
== Ver também ==
* [[Wikipédia:Projetos/Scribunto]]
<includeonly>
<!-- Categorias aqui e links para outros idiomas no Wikidata -->
{{#ifeq:{{SUBPAGENAME}}|Testes||
[[Categoria:!Módulos]]
[[Categoria:!Metamódulos Lua]]
}}</includeonly>