Module:Portal-inline
Jump to navigation
Jump to search
Documentation for this module may be created at Module:Portal-inline/doc
local getImageName = require( 'Module:Portal' ).image
local p = {}
local function checkPortalExists(portal)
return not (mw.title.makeTitle(100, portal).id == 0)
end
function p._main(portals, args)
local root = ""
mw.logObject(args)
-- ignore extra portals listed
-- If no portals have been specified, display an error and add the page to a tracking category.
if not portals[1] then
root = '<span style="font-size:100%;" class="error">error: missing portal name.</span></strong>[[Category:Portal templates without a parameter]]'
return tostring(root)
end
if not pcall(checkPortalExists, portals[1]) or not checkPortalExists(portals[1]) then
-- Getting here means a redlinked portal has been found
if not ((args.redlinks == 'yes') or (args.redlinks == 'y') or (args.redlinks == 'true') or (args.redlinks == 'include')) then
-- just return if redlinks is not "yes" or similar
root = '[[Category:Portal templates all redlinked portals]]'
return tostring(root)
end
root = '[[Category:Portal templates all redlinked portals]]<br/>'
end
if args['size'] == "tiny" then
args['size'] = "16x16px"
else
args['size'] = "32x28px"
end
local displayName = ""
if not (args['text'] == "" or args['text'] == nil) then
displayName = args['text']
elseif not (args.short == "" or args.short == nil) then
displayName = portals[1]
else
displayName = portals[1] .. " portal"
end
-- display portal-inline content
root = root .. string.format('[[File:%s|class=noviewer|%s]] [[Portal:%s|%s]]', getImageName{ portals[1] }, args['size'], portals[1], displayName)
return tostring(root)
end
-- copied from [[Module:Portal]]
local function processPortalArgs(args)
-- This function processes a table of arguments and returns two tables: an array of portal names for processing by ipairs, and a table of
-- the named arguments that specify style options, etc. We need to use ipairs because we want to list all the portals in the order
-- they were passed to the template, but we also want to be able to deal with positional arguments passed explicitly, for example
-- {{portal-inline|Politics}}. The behaviour of ipairs is undefined if nil values are present, so we need to make sure they are all removed.
args = type(args) == 'table' and args or {}
local portals = {}
local namedArgs = {}
for k, v in pairs(args) do
if type(k) == 'number' and type(v) == 'string' then -- Make sure we have no non-string portal names.
table.insert(portals, k)
elseif type(k) ~= 'number' then
namedArgs[k] = v
end
end
table.sort(portals)
for i, v in ipairs(portals) do
portals[i] = args[v]
end
return portals, namedArgs
end
local function makeWrapper(funcName)
-- Processes external arguments and sends them to the other functions.
return function (frame)
-- If called via #invoke, use the args passed into the invoking
-- template, or the args passed to #invoke if any exist. Otherwise
-- assume args are being passed directly in from the debug console
-- or from another Lua module.
local origArgs
if type(frame.getParent) == 'function' then
origArgs = frame:getParent().args
for k, v in pairs(frame.args) do
origArgs = frame.args
break
end
else
origArgs = frame
end
-- Trim whitespace and remove blank arguments.
local args = {}
for k, v in pairs(origArgs) do
if type(v) == 'string' then
v = mw.text.trim(v)
end
if v ~= '' then
args[k] = v
end
end
return p[funcName](processPortalArgs(args)) -- passes two tables to func: an array of portal names, and a table of named arguments.
end
end
for _, funcName in ipairs{'main'} do
p[funcName] = makeWrapper('_' .. funcName)
end
return p