模組:沙盒/Artoria2e5/Infobox artist/doc
这是Module:沙盒/Artoria2e5/Infobox artist的文档页面
本模块用于执行{{藝人}}和{{Infobox artist}}模板,请到模板页阅读具体用法。
贡献指南
目前这个模板最重要的事情就是要抄参数填参数。常用的语法和翻译结果如下所列:
-- 帮手函数
local function _(str)
if str ~= nil and str ~= '' then
return str
else
return nil
end
end
-- 这里演示给定参数调用模板 func 的方法,也是给下面 {{func}} 铺垫
local function func(args)
return frame:expandTemplate{title = 'func', args = args}
end
--[[
Lua -- MediaWiki
]]--
_(a) or _(b) or _(c) or '' -- {{{a|{{{b|{{{c|}}}}}}}}}
_(foo) or '{{{foo}}}' -- {{{foo}}}
_(foo) and 'a' or 'b' -- {{#if:{{{foo|}}}|a|b}}
_(foo):lower() -- {{lc:{{{foo|}}}}}
func({ -- {{func
["1"] = 'anon_1', -- | anon_1
["k"] = 'v', -- | k = v
["2"] = 'anon_2' -- | anon_2 <!-- | 2 = anon_2 -->
}) -- }}
当然,由于我们处理的是实际传来的参数,其实还是要用args['a']
获取参数,而不是处理现有的变量a
。像ifeq
这样的解析器函数其实也不难,看手册就好了。至于Lua语言的语法,这个官方自有教程,也不难。
arg_aliases
如果表格key部分的参数查找args
找不到,那么会按照接下来key指向的备选列表一个个寻找候选内容。也就是说:
["foo"] = {"某", "baaar", "baz"}, -- 对应于 {{{foo|{{{某|{{{baaar|{{{baz|}}}}}}}}}}}}
多换几处,是不是整洁多了?
只可在模板中的所有对某变量的引用都以同种顺序出现时在arg_aliases
加入内容。按照前面对此功能的描述,你很容易就会想通一件事——以后取这套变量,只能用头上作为key的那个字串的名字取,否则就得不到后备查找的加成。
实现上,这个模块用Lua metatable(元表)在args
上面多玩了一层,实现了按照arg_aliases
一个个顺序找候选参数。Lua允许给表格添加一个元表属性,决定特定函数的行为。例如,__index(table, key)
这个函数,会在查找不到table[key]
的时候蹦出来继续尝试查找。
现在我们一步步把注释为“magic”的地方拆开看:
local oldArgsMeta = getmetatable(args) or {} -- 保留旧 metatable。MediaWiki 传入的参数列表据说是用了 metatable。
local newArgsMeta = {} -- 准备一个新的。
for k, v in ipairs(oldArgsMeta) do -- 把旧的都复制过去。之所以不用旧的是因为担心可能只读。
newArgsMeta[k] = v
end
newArgsMeta.__index = function (t, k) -- 开始定义新的 __index 函数。
if oldArgsMeta.__index ~= nil then -- 如果旧的里面有 __index(这里旧的能在这个函数里面用到是因为 Lua 的闭包(closure))
local val = oldArgsMeta.__index(t, k) -- 我们试着用一下
if val ~= nil then -- 如果取到了
return val -- 那就是它了,返回(return)就好
end
end
for _, v in ipairs(arg_aliases[k] or {}) do -- 对于每个在 arg_aliases 里面查到的 k 的后备 v
if t[v] ~= nil and t[v] ~= '' then -- 如果取到了 t[v] 且非空字符串(后者是 MediaWiki 模板参数的要求)
return t[v] -- 就是它了
end
end
return nil -- 没找着
end
setmetatable(args, newArgsMeta) -- 把新的 metatable 套上去,完事儿
这个实现有趣的地方在于t[v]
这里本身还有可能再回到__index
函数,也就是说之前的arg_aliases
可以有递归查找的结构。