Module:Unsubst: Difference between revisions

Jump to navigation Jump to search

Module:Unsubst (view source)

Revision as of 18:22, 8 October 2021

2,159 bytes added ,  8 October 2021
sync from sandbox; see talk;
(Created page with "local export = {} local function serialise_frame(title, args) local result = { "{{", title } local use_equals = false for i, value in ipairs(args) do if use_equals or...")
 
(sync from sandbox; see talk;)
Line 1: Line 1:
local export = {}
local checkType = require('libraryUtil').checkType


local function serialise_frame(title, args)
local p = {}
local result = { "{{", title }
 
local BODY_PARAM = '$B'
local use_equals = false
 
for i, value in ipairs(args) do
local specialParams = {
if use_equals or value:find("=") then
['$params'] = 'parameter list',
value = i .. "=" .. value
['$aliases'] = 'parameter aliases',
use_equals = true
['$flags'] = 'flags',
['$B'] = 'template content',
['$template-name'] = 'template invocation name override',
}
 
function p.main(frame, body)
-- If we are substing, this function returns a template invocation, and if
-- not, it returns the template body. The template body can be specified in
-- the body parameter, or in the template parameter defined in the
-- BODY_PARAM variable. This function can be called from Lua or from
-- #invoke.
 
-- Return the template body if we aren't substing.
if not mw.isSubsting() then
if body ~= nil then
return body
elseif frame.args[BODY_PARAM] ~= nil then
return frame.args[BODY_PARAM]
else
error(string.format(
"no template content specified (use parameter '%s' from #invoke)",
BODY_PARAM
), 2)
end
end
table.insert(result, "|" .. value)
end
end
 
for key, value in pairs(args) do
-- Sanity check for the frame object.
if type(key) == "string" then
if type(frame) ~= 'table'
table.insert(result, "|" .. key .. "=" .. value)
or type(frame.getParent) ~= 'function'
end
or not frame:getParent()
then
error(
"argument #1 to 'main' must be a frame object with a parent " ..
"frame available",
2
)
end
end
table.insert(result, "}}")
return table.concat(result)
end


function export.unsubst_module(entry_point)
-- Find the invocation name.
local frame = mw.getCurrentFrame()
local mTemplateInvocation = require('Module:Template invocation')
return serialise_frame(
local name
((parent:getTitle() == mw.title.getCurrentTitle().fullText) and 'safesubst:' or '') ..
'#invoke:' .. frame:getTitle():gsub('^Module:', '') .. '|' .. entry_point, frame.args
)
end


function export.unsubst_template(entry_point)
if frame.args['$template-name'] and '' ~= frame.args['$template-name'] then
local frame = mw.getCurrentFrame()
name = frame.args['$template-name'] -- override whatever the template name is with this name
local parent = frame:getParent()
else
if parent:getTitle() == mw.title.getCurrentTitle().fullText then
name = mTemplateInvocation.name(frame:getParent():getTitle())
return serialise_frame('safesubst:#invoke:' .. frame:getTitle():gsub('^Module:', '') .. '|' .. entry_point, frame.args)
end
 
-- Combine passed args with passed defaults
local args = {}
if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*override%s*,' ) then
for k, v in pairs( frame:getParent().args ) do
args[k] = v
end
for k, v in pairs( frame.args ) do
if not specialParams[k] then
if v == '__DATE__' then
v = mw.getContentLanguage():formatDate( 'F Y' )
end
args[k] = v
end
end
else
for k, v in pairs( frame.args ) do
if not specialParams[k] then
if v == '__DATE__' then
v = mw.getContentLanguage():formatDate( 'F Y' )
end
args[k] = v
end
end
for k, v in pairs( frame:getParent().args ) do
args[k] = v
end
end
end
return serialise_frame(parent:getTitle():gsub('^Template:', ''), parent.args)
end


-- invokables
-- Trim parameters, if not specified otherwise
if not string.find( ','..(frame.args['$flags'] or '')..',', ',%s*keep%-whitespace%s*,' ) then
for k, v in pairs( args ) do args[k] = mw.ustring.match(v, '^%s*(.*)%s*$') or '' end
end


function export.me(frame)
-- Pull information from parameter aliases
local parent = frame:getParent()
local aliases = {}
if frame.args['$aliases'] then
local list = mw.text.split( frame.args['$aliases'], '%s*,%s*' )
for k, v in ipairs( list ) do
local tmp = mw.text.split( v, '%s*>%s*' )
aliases[tonumber(mw.ustring.match(tmp[1], '^[1-9][0-9]*$')) or tmp[1]] = ((tonumber(mw.ustring.match(tmp[2], '^[1-9][0-9]*$'))) or tmp[2])
end
end
for k, v in pairs( aliases ) do
if args[k] and ( not args[v] or args[v] == '' ) then
args[v] = args[k]
end
args[k] = nil
end


if mw.isSubsting() then
-- Remove empty parameters, if specified
return export.unsubst_template('me')
if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*remove%-empty%s*,' ) then
local tmp = 0
for k, v in ipairs( args ) do
if v ~= '' or ( args[k+1] and args[k+1] ~= '' ) or ( args[k+2] and args[k+2] ~= '' ) then
tmp = k
else
break
end
end
for k, v in pairs( args ) do
if v == '' then
if not (type(k) == 'number' and k < tmp) then args[k] = nil end
end
end
end
end


-- "manual substitution"?
-- Order parameters
if not frame.args.nocheck then
if frame.args['$params'] then
if (frame ~= parent) and not parent:getTitle():find("^Template:") then
local params, tmp = mw.text.split( frame.args['$params'], '%s*,%s*' ), {}
return '<strong class="error">It appears that you have copied template code from a template page. ' ..
for k, v in ipairs(params) do
'You should transclude the template instead, by putting its name in curly brackets, like so: ' ..
v = tonumber(mw.ustring.match(v, '^[1-9][0-9]*$')) or v
'<code>{{template-name}}</code>.</strong>' -- XXX: maintenance category?
if args[v] then tmp[v], args[v] = args[v], nil end
end
end
for k, v in pairs(args) do tmp[k], args[k] = args[k], nil end
args = tmp
end
end


return frame.args['']
return mTemplateInvocation.invocation(name, args)
end
end


return export
p[''] = p.main -- For backwards compatibility
 
return p
Anonymous user
Retrieved from "https://linguifex.com/wiki/Special:MobileDiff/477379"

Navigation menu