Lompat ke isi

Modul:Template wrapper: Perbedaan antara revisi

Mediawiki>Glorious Engine
←Membuat halaman berisi 'require('Module:No globals'); local error_msg = '<span style=\"font-size:100%\" class=\"error\"><code style=\"color:inherit; border:inherit; padding:inherit;\">|...'
 
Mediawiki>GKFX
Add uncopyable line break opportunities to documentation mode
Baris 31: Baris 31:
args[k] = v; -- copy parameters to args table
args[k] = v; -- copy parameters to args table
end
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
end


Baris 49: Baris 87:
if '_template' == k then
if '_template' == k then
template = v; -- save the name of template that we are wrapping
template = v; -- save the name of template that we are wrapping
elseif '_exclude' ~= k and '_include-positional' ~= k then -- these already handled so ignore here;  
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
add_parameter (k, v, args, list); -- add all other parameters to args in the style dictated by list
end
end
Baris 59: Baris 97:




--[[--------------------------< P F R A M E _ A R G S _ G E T >------------------------------------------------
--[=[--------------------------< 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
Fetches the wrapper template's 'live' parameters; adds live parameters that aren't members of the exclude table to
Baris 66: Baris 104:
no return value
no return value


]]
]=]


local function pframe_args_get (pframe_args, args, exclude, _include_positional, list)
local function pframe_args_get (pframe_args, args, exclude, _include_positional, list)
Baris 75: Baris 113:
v = ''; -- unset the value in the args table
v = ''; -- unset the value in the args table
end
end
add_parameter (k, v, args, list) -- add all other parameters to args in the style dictated by list
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
end
Baris 102: Baris 140:
local template;
local template;
local exclude = {}; -- table of parameter names for parameters that are not passed to the working 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;
local _include_positional;
if frame.args._exclude and ('' ~= frame.args._exclude) then -- if there is |_exclude= and it's not empty
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
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
end


Baris 116: Baris 164:
-- ... the working template; positional parameters are not excludable
-- ... the working template; positional parameters are not excludable
local pframe = frame:getParent(); -- here we get the wrapper template's 'live' parameters from pframe.args
local _pframe_args = frame:getParent().args; -- here we get the wrapper template's 'live' parameters from pframe.args
pframe_args_get (pframe.args, args, exclude, _include_positional, list); -- add parameters and values to args that are not listed in the exclude table
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
return template; -- args now has all default and live parameters, return working template name
Baris 137: Baris 233:
return error_msg; -- emit error message and abandon if template name not present
return error_msg; -- emit error message and abandon if template name not present
end
end
 
return frame:expandTemplate {title=template, args=args}; -- render the working template
return frame:expandTemplate {title=template, args=args}; -- render the working template
end
end
Baris 153: Baris 249:
]]
]]


local function list(frame, do_link)
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


local function list (frame)
template = _main (frame, args, true); -- get default and live parameters and the name of the listed template
local args = {}; -- table of default and live parameters and their values to be passed to the listed template
if not template then -- template name is required
local template; -- the name of the listed template
return error_msg; -- emit error message and abandon if template name not present
 
end
template = _main (frame, args, true); -- get default and live parameters and the name of the listed template
if do_link then
if not template then -- template name is required
template = ('[[%s|%s]]'):format(frame:expandTemplate{ title='Transclude', args = {template} }, template)
return error_msg; -- emit error message and abandon if template name not present
end
table.sort(args)
for i = 1, #args do
local stripped = args[i]:match('^' .. i .. '=([^=]*)$')
if stripped then args[i] = stripped else break end
end
end
return frame:preprocess(table.concat({
'<code style="color:inherit; background:inherit; border:none;">&#123;&#123;',
template,
('<wbr><nowiki>|%s</nowiki>'):rep(#args):format(unpack(args)), '&#125;&#125;</code>'})); -- render the template
end


return frame:preprocess (table.concat ({'<code style="color:inherit; background:inherit; border:none;"><nowiki>{{', template, ' |', table.concat( args, ' |' ), '}}</nowiki></code>'})); -- render the template
local function link (frame)
return list(frame, true)
end
end


--[[--------------------------< E X P O R T E D  F U N C T I O N S >------------------------------------------
--[[--------------------------< E X P O R T E D  F U N C T I O N S >------------------------------------------
Baris 171: Baris 279:


return {
return {
link = link,
list = list,
list = list,
wrap = wrap,
wrap = wrap,
};
};