モジュール:Template wrapper
このモジュールはラッパーテンプレートを実装するためのモジュールです。
用語の定義
- ラッパーテンプレート（wrapper template） - 基礎となるテンプレート（以降は「基礎テンプレート」と呼ぶ）に追加の引数を与え、一部の引数に既定値を与えるためのテンプレート。たとえば、{{Cite DNB}}は{{Cite encyclopedia2}}のラッパーテンプレート。
- 基礎テンプレート（working template） - ラッパーテンプレートの基礎となるテンプレート。上記の例では{{Cite encyclopedia2}}が基礎テンプレートとなる。
- 基礎引数（canonical parameter） - 基礎テンプレートで使える引数。
- ラッパー引数（wrapper parameter） - ラッパーテンプレートで使える引数。基礎引数を導出するために必要な引数と、ラッパーテンプレートの挙動を変える引数がある。
- エイリアス引数（alias parameter） - ラッパーテンプレートの引数のうち、基礎テンプレートの引数の別名として扱うべき引数。
- 再利用される引数（reused parameter） - 基礎テンプレートとラッパーテンプレートの両方で使われる引数であるが、ラッパーテンプレートはその引数の値に変更を加えてから基礎テンプレートに渡す。
- 既定値つき引数（default parameter） - ラッパーテンプレートでの既定値がある基礎引数。
概要
基本的には、基礎テンプレートに渡す引数の既定値を指定することで、ラッパーテンプレートを作成できます。編集者はラッパーテンプレートをそのまま使うか、ラッパーテンプレートのラッパーを作成することができます。基礎テンプレートで使える基礎引数はラッパーテンプレートが既定値を与えるか、ラッパーテンプレートを利用する編集者が値を指定でき、編集者が指定した値は既定値より優先されます。基礎テンプレートで既定値が指定されているが、ラッパーテンプレートで既定値を消したい場合はunsetを使うことができます。なお、このモジュールは値が指定されていないか空白の名前付き引数を捨てて、基礎テンプレートに渡しません。
名無し引数は既定では基礎テンプレートに渡されませんが、|_include-positional=yesで渡すよう設定できます。名無し引数は「除外引数」（後述）に指定できないものの、unsetすることはできます。
ラッパーテンプレート自体にしか使われない引数は名無し引数（{{{n}}}）か|_exclude=で（コンマ区切りの引数リストの形で）指定しなければなりません。このモジュールは_excludedで指定された引数を基礎テンプレートに渡しません。
使用法
{{#invoke:Template wrapper|wrap|_template=基礎テンプレート|_exclude=引数名1, 引数名2, ...|_reuse=再利用される引数1, 再利用される引数2, ...|_alias-map=エイリアス引数:標準引数名|_include-positional=yes|<既定値つき引数1>|<既定値つき引数2>|...}}
- コントロール引数
|_template=- （必須）基礎テンプレート名を名前空間なしで指定します。_templateの節を参照。|_exclude=- ラッパーテンプレートで使われるが、基礎テンプレートに渡さない引数をコンマ区切りで指定します。_excludeの節を参照。|_reuse=- ラッパーテンプレートと基礎テンプレートの両方で使われる引数をコンマ区切りで指定します。_reuseの節を参照。|_alias-map=- ラッパーテンプレートの引数のうち、基礎テンプレートの引数のエイリアスとして扱うべき引数をコンマ区切りで指定します。_alias-mapの節を参照。|_include-positional=- yesを指定すると、名無し引数をラッパーテンプレートに渡します。positionalの節を参照。
| ラッパー テンプレート |
モジュール:Template wrapper | 基礎 テンプレート | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|基礎引数= |
→ | –––––––→ | → | –––––––→ | → | –––––––→ | → | –––––––→ | → | –––––––→ | → | _excludeされた 引数を フィルター |
基礎 テンプレート | |
|ラッパー引数= |
→ | –––––––→ | → | –––––––→ | → | –––––––→ | → | –––––––→ | → | –––––––→ | → | |||
|_exclude= |
→ | –––––––→ | → | –––––––→ | → | –––––––→ | → | –––––––→ | → | → | ||||
|_include-positional= |
→ | –––––––→ | → | –––––––→ | → | –––––––→ | → | –––––––→ | → | |||||
|_alias-map= |
→ | エイリアス引数を 標準引数に 変換 |
→ | |標準引数= |
→ | –––––––→ | → | –––––––→ | → | → | ||||
| → | → | 再利用された 標準引数を 変更 | ||||||||||||
|エイリアス引数= |
→ | –––––––→ | → | → | |再利用された引数= |
→ | –––→ | → | ||||||
|_reuse= |
→ | –––––––→ | → | –––––––→ | → | |||||||||
|標準引数= |
→ | –––––––→ | → | –––––––→ | → | –––––––→ | → | |||||||
|既定引数= |
→ | –––––––→ | → | –––––––→ | → | –––––––→ | → | –––––––→ | → | –––→ | → | |||
引数の詳しい説明
_template
このモジュールを使用するのに必ず指定しなければならない引数であり、基礎テンプレートの名前を名前空間なしで指定します。この引数が指定されていない場合、下記のエラーメッセージが表示されます。
|_template=が未指定か、空白です
_alias-map
|_alias-map=引数では基礎テンプレートの基礎引数の別名として扱われるラッパーテンプレートのエイリアス引数をコンマ区切りで指定します。具体的には下記の書式で指定します：
<ラッパーテンプレートの引数名>:<基礎テンプレートの引数名>
例えば、ラッパーテンプレートで|assessor=という引数を使いたいが、基礎テンプレートにassessorという引数はなく、|author=という同じ意味の引数があるとします。その場合、ラッパーテンプレートでこのモジュールを{{#invoke:}}で呼び出すとき、下記のように書きます：
|_alias-map=assessor:author
ラッパーテンプレートの名無し引数も指定できます。
|_alias-map=1:author, 2:title, 3:language
末尾に番号がある引数の場合、#を利用して指定できます。例えば、下記の例ではラッパーテンプレートの|assessor1=が基礎テンプレートの|author1=になり、ラッパーテンプレートの|assessor2=が基礎テンプレートの|author2=になります（以下同じ）。
|_alias-map=assessor#:author#
ラッパーテンプレートの引数を2つ以上基礎テンプレートの同じ引数にマッピングすることもできます：
|_alias-map=1:author, assessor:author
なお、|_alias-map=assessor:authorのように指定した場合、ラッパーテンプレートのassessor引数は基礎テンプレートにauthor引数として渡されます。基礎テンプレートではassessor引数が指定されていないことになります。
|_include-positional=yesも同時に指定した場合、_alias-mapにない名無し引数は基礎テンプレートに直接渡されます。例えば、|_alias-map=1:authorと|_include-positional=yesを指定した場合、ラッパーテンプレートの引数1は基礎テンプレートの引数authorになり、ラッパーテンプレートの引数2は基礎テンプレートの引数2になり、基礎テンプレートの引数1は指定されません。
_reuse
|_reuse=引数では基礎テンプレートとラッパーテンプレートの両方で使われる引数をコンマ区切りで指定します。
例として、ラッパーテンプレートで|year=1999を指定することで基礎テンプレートに|year=1999年に渡したいとします。この場合ではラッパーテンプレートと基礎テンプレートの両方で同じ引数名を使用していますが、ラッパーテンプレートは渡されたyear引数の値を変更してから（例では末尾に「年」をつけてから）基礎テンプレートに渡します。この例では下記のように指定します。
{{#invoke:Template wapper|wrap|_template=...|_reuse=year|year={{{year}}}年|...}}
_exclude
|_exclude=引数ではラッパーテンプレートで使われるが、基礎テンプレートに渡されない引数をコンマ区切りで指定します。
例えば、ラッパーテンプレートで|url=https://example.com/{{{id}}}が指定されているとします。これはラッパーテンプレートでid引数が使われることと、url引数が基礎テンプレートに渡されることを意味しますが、既定ではid引数も基礎テンプレートに渡されます。id引数をラッパーテンプレートで使うが基礎テンプレートに渡さない場合は下記のように指定します。
{{#invoke:Template wapper|wrap|_template=...|_exclude=id|url=https://example.com/{{{id}}}|...}}
_reuseで指定された引数は_excludeで同時に指定できません。
_include-positional
|_include-positional=はブーリアン型の引数で、未指定の場合はnoになります。yesを指定した場合、このモジュールは全ての名無し引数を基礎テンプレートに渡します。
_alias-mapの節もご参照ください。
基礎引数の既定値の変更
基礎テンプレートの引数に既定値がある場合、それを変更するにはラッパーテンプレートでその引数を指定することでできますが、このモジュールは既定では空を指定した引数を基礎テンプレートに渡さないため、その引数を空にしたい場合はunsetを指定する必要があります。
_reuseで指定された引数はunsetを使用できません。
デバッグモード
このモジュールで呼び出せる関数にはlistとwrapがあり、通常はwrapを使用します。テンプレートのデバッグを行うとき、listを使用することで基礎テンプレートを呼び出さず、基礎テンプレートを呼び出すマークアップを表示します。例えば、ラッパーテンプレートは下記のように書くことができます：
{{#invoke:Template wrapper|{{#if:{{{_debug|}}}|list|wrap}}|_template=<基礎テンプレート>|_exclude=_debug, ...|...}}
この例では|_debug=引数が指定された場合、listが使用されます。
例えば、{{Cite DNB}}は上記の形式で書かれています。
{{Cite DNB|_debug=yes|wstitle=Hervey, John (1696-1743)|volume=26|pages=284-288|last=Barker|first=George Fisher Russell}}と指定した場合、下記のように表示されます。{{cite encyclopedia |editor2-first=Sidney |editor-link=レズリー・スティーヴン |editor2-link=シドニー・リー |editor-first=Leslie |location=London |editor-last=Stephen |publisher=[[スミス・エルダー・アンド・カンパニー|Smith, Elder & Co]] |title=[[s:en:Dictionary of National Biography, 1885-1900/Hervey, John (1696-1743)|Hervey, John (1696-1743)]] |editor2-last=Lee |encyclopedia=[[英国人名事典|Dictionary of National Biography]] |year=1891 |language=en |last=Barker |first=George Fisher Russell |pages=284-288 |volume=26}}
上記ではデバッグ引数の名前を|_debug=にしていますが、それ以外の名前も使えます。
require('strict');
local error_msg = '<span style=\"font-size:100%\" class=\"error\"><code style=\"color:inherit; border:inherit; padding:inherit;\">|_template=</code>が未指定か、空白です</span>';
--[[--------------------------< I S _ I N _ T A B L E >--------------------------------------------------------
scan through tbl looking for value; return true if found, false else
]]
local function is_in_table (tbl, value)
for k, v in pairs (tbl) do
if v == value then return true end
end
return false;
end
--[[--------------------------< A D D _ P A R A M E T E R >----------------------------------------------------
adds parameter name and its value to args table according to the state of boolean list argument; kv pair for
template execution; k=v string for template listing.
]]
local function add_parameter (k, v, args, list)
if list then
table.insert( args, table.concat ({k, '=', v})); -- write parameter names and values to args table as string
else
args[k] = v; -- copy parameters to args table
end
end
--[[--------------------------< A L I A S _ M A P _ G E T >----------------------------------------------------
returns a table of local template (parent frame) parameter names and the target template names that match where
in [key]=<value> pairs where:
[key] is local template parameter name (an alias)
<value> is target template parameter name (the canonical parameter name used in the working template)
The parameter |_alias-map= has the form:
|_alias-map=<list>
where <list> is a comma-separated list of alias / canonical parameter name pairs in the form
<from> : <to>
where:
<from> is the local template's parameter name (alias)
<to> is the target template's parameter name (canonical)
for enumerated parameters place an octothorp (#) where the enumerator digits are placed in the parameter names:
<from#> : <to#>
]]
local function alias_map_get (_alias_map)
local T = mw.text.split (_alias_map, '%s*,%s*'); -- convert the comma-separated list into a table of alias pairs
local mapped_aliases = {}; -- mapped aliases will go here
local l_name, t_name; -- parameter names
for _, alias_pair in ipairs (T) do -- loop through the table of alias pairs
l_name, t_name = alias_pair:match ('(.-)%s*:%s*(.+)'); -- from each pair, get local and target parameter names
if l_name and t_name then -- if both are set
if tonumber (l_name) then
l_name = tonumber (l_name); -- convert number-as-text to a number
end
mapped_aliases[l_name] = t_name; -- add them to the map table
end
end
return mapped_aliases;
end
--[[--------------------------< F R A M E _ A R G S _ G E T >--------------------------------------------------
Fetch the wrapper template's 'default' and control parameters; adds default parameters to args
returns content of |_template= parameter (name of the working template); nil else
]]
local function frame_args_get (frame_args, args, list)
local template;
for k, v in pairs (frame_args) do -- here we get the wrapper template's 'default' parameters
if 'string' == type (k) and (v and ('' ~= v)) then -- do not pass along positional or empty parameters
if '_template' == k then
template = v; -- save the name of template that we are wrapping
elseif '_exclude' ~= k and '_reuse' ~= k and '_include-positional' ~= k and '_alias-map' ~= k then -- these already handled so ignore here;
add_parameter (k, v, args, list); -- add all other parameters to args in the style dictated by list
end
end
end
return template; -- return contents of |_template= parameter
end
--[=[--------------------------< P F R A M E _ A R G S _ G E T >------------------------------------------------
Fetches the wrapper template's 'live' parameters; adds live parameters that aren't members of the exclude table to
args table; positional parameters may not be excluded
no return value
]=]
local function pframe_args_get (pframe_args, args, exclude, _include_positional, list)
for k, v in pairs (pframe_args) do
if 'string' == type (k) and not is_in_table (exclude, k) then -- do not pass along excluded parameters
if v and ('' ~= v) then -- pass along only those parameters that have assigned values
if 'unset' == v:lower() then -- special keyword to unset 'default' parameters set in the wrapper template
v = ''; -- unset the value in the args table
end
add_parameter (k, v, args, list) -- add all other parameters to args in the style dictated by list; alias map only supported for local-template parameters
end
end
end
if _include_positional then
for i, v in ipairs (pframe_args) do -- pass along positional parameters
if 'unset' == v:lower() then -- special keyword to unset 'default' parameters set in the wrapper template
v = ''; -- unset the value in the args table
end
add_parameter (i, v, args, list);
end
end
end
--[[--------------------------< _ M A I N >--------------------------------------------------------------------
Collect the various default and live parameters into args styled according to boolean list.
returns name of the working or listed template or nil for an error message
]]
local function _main (frame, args, list)
local template;
local exclude = {}; -- table of parameter names for parameters that are not passed to the working template
local reuse_list = {}; -- table of pframe parameter names whose values are modified before they are passed to the working template as the same name
local alias_map = {}; -- table that maps parameter aliases to working template canonical parameter names
local _include_positional;
if frame.args._exclude and ('' ~= frame.args._exclude) then -- if there is |_exclude= and it's not empty
exclude = mw.text.split (frame.args._exclude, "%s*,%s*"); -- make a table from its contents
end
-- TODO: |_reuse= needs a better name (|_reuse=)
if frame.args._reuse and ('' ~= frame.args._reuse) then -- if there is |_reuse= and it's not empty
reuse_list = mw.text.split (frame.args._reuse, "%s*,%s*"); -- make a table from its contents
end
if frame.args['_alias-map'] and ('' ~= frame.args['_alias-map']) then -- if there is |_alias-map= and it's not empty
alias_map = alias_map_get (frame.args['_alias-map']); -- make a table from its contents
end
template = frame_args_get (frame.args, args, list); -- get parameters provided in the {{#invoke:template wrapper|...|...}}
if nil == template or '' == template then -- this is the one parameter that is required by this module
return nil; -- not present, tell calling function to emit an error message
end
_include_positional = 'yes' == frame.args['_include-positional']; -- when true pass all positional parameters along with non-excluded named parameters to ...
-- ... the working template; positional parameters are not excludable
local _pframe_args = frame:getParent().args; -- here we get the wrapper template's 'live' parameters from pframe.args
local pframe_args = {}; -- a local table that we can modify
for k, v in pairs (_pframe_args) do -- make a copy that we can modify
pframe_args[k] = v;
end
-- here we look for pframe parameters that are aliases of canonical parameter names; when found
-- we replace the alias with the canonical. We do this here because the reuse_list works on
-- canonical parameter names so first we convert alias parameter names to canonical names and then
-- we remove those canonical names from the pframe table that are reused (provided to the working
-- template through the frame args table)
for k, v in pairs (alias_map) do -- k is alias name, v is canonical name
if pframe_args[k] then -- if pframe_args has parameter with alias name
pframe_args[v] = _pframe_args[k]; -- create new canonical name with alias' value
pframe_args[k] = nil; -- unset the alias
end
end
for k, v in pairs (pframe_args) do -- do enumerated parameter alias -> canonical translation
if 'string' == type (k) then -- only named parameters can be enumerated
if alias_map[k..'#'] then -- non-enumerated alias matches enumerated parameter pattern? enumerator at end only
pframe_args[alias_map[k..'#']:gsub('#', '')] = v; -- remove '#' and copy parameter to pframe_args table
pframe_args[k] = nil; -- unset the alias
elseif k:match ('%d+') then -- if this parameter name contains digits
local temp = k:gsub ('%d+', '#'); -- make a copy; digits replaced with single '#'
local enum = k:match ('%d+'); -- get the enumerator
if alias_map[temp] then -- if this parameter is a recognized enumerated alias
pframe_args[alias_map[temp]:gsub('#', enum)] = v; -- use canonical name and replace '#' with enumerator and add to pframe_args
pframe_args[k] = nil; -- unset the alias
end
end
end
end
-- pframe parameters that are _reused are 'reused' have the form something like this:
-- |chapter=[[wikisource:{{{chapter}}}|{{{chapter}}}]]
-- where a parameter in the wrapping template is modified and then passed to the working template
-- using the same parameter name (in this example |chapter=)
-- remove parameters that will be reused
for k, v in ipairs (reuse_list) do -- k is numerical index, v is canonical parameter name to ignore
if pframe_args[v] then -- if pframe_args has parameter that should be ignored
pframe_args[v] = nil; -- unset the ignored parameter
end
end
pframe_args_get (pframe_args, args, exclude, _include_positional, list); -- add parameters and values to args that are not listed in the exclude table
return template; -- args now has all default and live parameters, return working template name
end
--[[--------------------------< W R A P >----------------------------------------------------------------------
Template entry point. Call this function to 'execute' the working template
]]
local function wrap (frame)
local args = {}; -- table of default and live parameters and their values to be passed to the wrapped template
local template; -- the name of the working template
template = _main (frame, args, false); -- get default and live parameters and the name of the working template
if not template then -- template name is required
return error_msg; -- emit error message and abandon if template name not present
end
return frame:expandTemplate {title=template, args=args}; -- render the working template
end
--[[--------------------------< L I S T >----------------------------------------------------------------------
Template entry point. Call this function to 'display' the source for the working template. This function added
as a result of a TfD here: Wikipedia:Templates_for_discussion/Log/2018_April_28#Module:PassArguments
This function replaces a similarly named function which was used in {{cite compare}} and {{cite compare2}}
Values in the args table are numerically indexed strings in the form 'name=value'
]]
local function list (frame)
local args = {}; -- table of default and live parameters and their values to be passed to the listed template
local template; -- the name of the listed template
template = _main (frame, args, true); -- get default and live parameters and the name of the listed template
if not template then -- template name is required
return error_msg; -- emit error message and abandon if template name not present
end
return frame:preprocess (table.concat ({'<code style="color:inherit; background:inherit; border:none;"><nowiki>{{', template, ' |', table.concat( args, ' |' ), '}}</nowiki></code>'})); -- render the template
end
--[[--------------------------< E X P O R T E D F U N C T I O N S >------------------------------------------
]]
return {
list = list,
wrap = wrap,
};