Module:Portal: Difference between revisions

Content deleted Content added
rename tracking cat
Reapply fixed version
 
(25 intermediate revisions by 5 users not shown)
Line 42:
local p = {}
 
-- determine whether we're being called from a sandbox
-- IMPORTANT: isSandbox should be different between Module:Portal and Module:Portal/sandbox
local isSandbox = mw.getCurrentFrame():getTitle():find('sandbox', 1, true)
-- That should be the only difference between the main and sandbox version
local sandbox = isSandbox and '/sandbox' or ''
local isSandbox = false
 
local function sandboxVersion(s)
local templatestyles = 'Module:Portal/'..(isSandbox and 'sandbox/' or '')..'styles.css'
return isSandbox and s..'-sand' or s
end
 
local templatestyles = 'Module:Portal'..sandbox..'/styles.css'
 
local getArgs = require('Module:Arguments').getArgs
local yesno = require('Module:Yesno')
 
-- List of non-talk namespaces which should not be tracked (Talk pages are never tracked)
local badNamespaces = {'user','template','draft','wikipedia'}
 
-- Check whether to do tracking in this namespace
-- Returns true unless the page is one of the banned namespaces
local function checkTrackingNamespace(title)
local thisPage = title or mw.title.getCurrentTitle()
return not( (thisPage.namespace == 1) -- Talk
or (thisPage.namespace == 2) -- User
or (thisPage.namespace == 3) -- User talk
or (thisPage.namespace == 5) -- Wikipedia talk
or (thisPage.namespace == 7) -- File talk
or (thisPage.namespace == 11) -- Template talk
or (thisPage.namespace == 15) -- Category talk
or (thisPage.namespace == 101) -- Portal talk
or (thisPage.namespace == 109) -- Book talk
or (thisPage.namespace == 118) -- Draft
or (thisPage.namespace == 119) -- Draft talk
or (thisPage.namespace == 829)) -- Module talk
end
 
-- Check whether to do tracking on this pagename
-- Returns false if the page title matches one of the banned strings
-- Otherwise returns true
local function checkTrackingPagename(title)
local thisPage = title or mw.title.getCurrentTitle()
local thisPageLC = mw.ustring.lower(thisPage.text)
return not( mw.ustring.match(thisPageLC, "/archive")
or mw.ustring.match(thisPageLC, "/doc")
or mw.ustring.match(thisPageLC, "/sandbox")
or mw.ustring.match(thisPageLC, "/test"))
end
 
--Check if page should be category tracked
--Arguments:
-- title (optional): mw.title.Title object to evaluate. Defaults to current page
--Returns:
-- bool whether page should be tracked
local function checkTracking(title)
titlelocal thisPage = title or mw.title.getCurrentTitle()
if thisPage.isTalkPage then
return checkTrackingNamespace(title) and checkTrackingPagename(title)
return false
end
local ns = thisPage.nsText:lower()
for _, v in ipairs(badNamespaces) do
if ns == v then
return false
end
end
return true
end
 
Line 98 ⟶ 81:
local imagePage
if mw.ustring.find(firstLetter, '^[a-z]') then
imagePage = 'Module:Portal/images/' .. firstLetter .. (isSandbox and '/sandbox' or '')
else
imagePage = 'Module:Portal/images/other' .. (isSandbox and '/sandbox' or '')
end
return mw.loadData(imagePage)[s]
Line 107 ⟶ 90:
local function getAlias(s)
-- Gets an alias from the image alias data page.
local aliasData = mw.loadData('Module:Portal/images/aliases'..(isSandbox and '/sandbox' or ''))
for portal, aliases in pairs(aliasData) do
for _, alias in ipairs(aliases) do
Line 116 ⟶ 99:
end
end
 
local defaultImage = 'Portal-puzzle.svg|link=|alt='
 
local function getImageName(s)
-- Gets the image name for a given string.
local default = 'Portal-puzzle.svg|link=|alt='
if type(s) ~= 'string' or #s < 1 then
return defaultdefaultImage
end
s = mw.ustring.lower(s)
returnlocal image = matchImagePage(s) or matchImagePage(getAlias(s)) or defaultdefaultImage
image = mw.ustring.gsub(image,'^File:','') --- strip mistaken leading File: or Image:
image = mw.ustring.gsub(image,'^Image:','')
return image
end
 
local function exists(title)
local success, exists = pcall(function() return title.exists end)
-- If success = false, then we're out of expensive parser function calls and can't check whether it exists
-- in that case, don't throw a Lua error
return not success or exists
end
 
Line 170 ⟶ 164:
local portalTitle = mw.title.new(portal,"Portal")
-- if portal exists, put it into list
if portalTitle and portalTitle.exists(portalTitle) then
table.insert(existingPortals,portal)
-- otherwise set tracking cat
Line 180 ⟶ 174:
portals = args.redlinks and portals or existingPortals
-- if nothing left after purge, set tracking cat
if #portals == 0 and trackingEnabled then
trackingCat = trackingEnabled and trackingCat.."[[Category:Pages with empty portal template]]" or ""
end
end
return portals, trackingCat, errMsg
end
 
local function portalBox(args)
return mw.html.create('ul')
:attr('role', 'navigation')
:attr('aria-label', 'Portals')
:addClass('noprint')
:addClass(args.error and '' or sandboxVersion('portalbox'))
:addClass(args.border and sandboxVersion('portalborder') or '')
:addClass(sandboxVersion(args.left and 'portalleft' or 'portalright'))
:css('margin', args.margin or nil)
:newline()
end
 
local function fillBox(root, contents)
for _, item in ipairs(contents) do
local entry = root:tag('li')
entry:addClass(sandboxVersion('portalbox-entry'))
local image = entry:tag('span')
image:addClass(sandboxVersion('portalbox-image'))
image:wikitext(item[1])
local link = entry:tag('span')
link:addClass(sandboxVersion('portalbox-link'))
link:wikitext(item[2])
end
return root
end
 
local function noviewer(portalImage)
-- Function to add noviewer class to filespec for portalImage
local portalImage, hasClass = mw.ustring.gsub(portalImage, "class%s*=[^%|]+", "%0 noviewer")
if hasClass == 0 then
portalImage = portalImage.."|class=noviewer"
end
return portalImage
end
 
Line 193 ⟶ 222:
if args.redlinks == 'include' then args.redlinks = true end
args.addBreak = args['break']
for key, default in pairs({left=false,tracking=true,nominimum=false,
redlinks=false,addBreak=false,border=true}) do
if args[key] == nil then args[key] = default end
args[key] = yesno(args[key], default)
end
 
local root = mw.html.createportalBox('div'args)
:attr('role', 'navigation')
:attr('aria-label', 'Portals')
:addClass('noprint portalbox plainlist')
:addClass(args.left and 'tleft' or 'tright')
:css('margin', args.margin or nil)
:newline()
 
local trackingCat = ''
Line 214 ⟶ 238:
-- if error message, put it in the box and return
if errMsg then
if args.border then -- suppress error message when border=no
local errTag = root:tag('strong')
args.error = true -- recreate box without fancy formatting
errTag:addClass('error')
root = portalBox(args)
errTag:css('padding','0.2em')
errTag root:wikitext('Error: '..errMsgtrackingCat)
local errTag = root:tag('strong')
errTag:addClass('error')
errTag:css('padding','0.2em')
errTag:wikitext('Error: '..errMsg)
end
return tostring(root)
end
Line 225 ⟶ 254:
end
 
local contents = {}
-- Start the list. This corresponds to the start of the wikitext table in the old [[Template:Portal]].
local listroot = root:tag('ul')
:css('width', (tonumber(args.boxsize) or 0) > 0 and (args.boxsize .. 'px') or args.boxsize)
 
-- Display the portals specified in the positional arguments.
local defaultUsed = nil
for _, portal in ipairs(portals) do
local imageportalImage = getImageName(portal)
if portalImage == defaultImage then
defaultUsed = portal
else
portalImage = noviewer(portalImage)
end
local image = string.format('[[File:%s|32x28px]]',
portalImage)
local link = string.format('[[Portal:%s|%s%sportal]]',
portal, portal, args.addBreak and '<br />' or ' ')
table.insert(contents, {image, link})
end
if defaultUsed and args.tracking and checkTracking() then
local cat = string.format('[[Category:Portal templates with default image|%s]]',
defaultUsed)
root:wikitext(cat)
end
return tostring(fillBox(root, contents))
end
 
function p._demo(imageList, args)
-- Generate the html for the image and the portal name.
for key, default in pairs({left=false,border=true}) do
listroot
if args[key] == nil then args[key] = default end
:newline()
args[key] = yesno(args[key], default)
:tag('li')
:tag('span')
:wikitext(string.format('[[File:%s|32x28px|class=noviewer]]', image))
:done()
:tag('span')
:wikitext(string.format('[[Portal:%s|%s%sportal]]', portal, portal, args.addBreak and '<br />' or ' '))
end
return tostring(root)
local root = portalBox(args)
 
local contents = {}
-- Display the portals specified in the positional arguments.
for _, fn in ipairs(imageList) do
local image = string.format('[[File:%s|32x28px]]',noviewer(fn))
local link = string.format('[[:File:%s|%s]]',fn,fn)
table.insert(contents,{image,link})
end
 
return tostring(fillBox(root,contents))
end
 
function p._image(portalsportal,keep)
-- Wrapper function to allow getImageName() to be accessed through #invoke.
-- backward compatibility: if table passed, take first element
local name = getImageName(portals[1])
if type(portal) == 'table' then
return name:match('^(.-)|') or name -- FIXME: use a more elegant way to separate borders etc. from the image name
portal = portal[1]
end
local name = getImageName(portal)
-- If keep is yes (or equivalent), then allow all metadata (like image borders) to be returned
-- also, add "noviewer" class to metadata
local keepargs = yesno(keep)
if keepargs then
return noviewer(name)
end
-- otherwise, just keep filename, plus optional category
local args = mw.text.split(name, "|", true)
local result = {args[1]} -- the filename always comes first
local category = ''
-- parse name, looking for category arguments
for i = 2,#args do
local m = mw.ustring.match(args[i], "^%s*category%s*=")
if m then
table.insert(result, args[i])
end
end
-- reassemble arguments
return table.concat(result,"|")
end
 
 
local function getAllImageTables()
local function getAllImageTable()
-- Returns an array containing all image subpages (minus aliases) as loaded by mw.loadData.
local images = {}
for i, subpage in ipairs{'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'other'} do
images[i]local imageTable = mw.loadData('Module:Portal/images/' .. subpage .. (isSandbox and '/sandbox' or ''))
for portal, image in pairs(imageTable) do
local args = mw.text.split(image,"|")
images[portal] = args[1] -- just use image filename
end
end
return images
Line 266 ⟶ 344:
-- names are capitalized, so the portal links may be broken.
local lang = mw.language.getContentLanguage()
portals = portals or {}
local count = 1
for _, imageTableportal in ipairspairs(getAllImageTablesgetAllImageTable()) do
table.insert(portals,lang:ucfirst(portal))
for portal in pairs(imageTable) do
portals[count] = lang:ucfirst(portal)
count = count + 1
end
end
table.sort(portals)
args.redlinks = args.redlinks or "yes"
return p._portal(portals, args)
end
Line 281 ⟶ 358:
-- should be moved to a portal alias for ease of maintenance.
local exists, dupes = {}, {}
for _portal, imageTableimage in ipairspairs(getAllImageTablesgetAllImageTable()) do
if not exists[image] then
for portal, image in pairs(imageTable) do
if not exists[image] then= portal
else
exists[image] = portal
table.insert(dupes, string.format('The image "[[:File:%s|%s]]" is used for both portals "%s" and "%s".', image, image, exists[image], portal))
else
table.insert(dupes, string.format('The image "[[:File:%s|%s]]" is used for both portals "%s" and "%s".', image, image, exists[image], portal))
end
end
end
Line 322 ⟶ 397:
function p._processPortalArgs(args)
return processPortalArgs(args)
end
 
function p.image(frame)
local origArgs = getArgs(frame)
local portals, args = processPortalArgs(origArgs)
return p._image(portals[1],args.border)
end
 
function p.demo(frame)
local args = getArgs(frame)
local styles = frame:extensionTag{ name = 'templatestyles', args = { src = templatestyles} }
return styles..p._demo(args,args)
end
 
Line 343 ⟶ 430:
end
 
for _, funcName in ipairs{'portal', 'image', 'imageDupes', 'displayAll'} do
p[funcName] = makeWrapper('_' .. funcName)
end