Модул:Portal-lat
Документацију овог модула можете да направите на страници Модул:Portal-lat/док
--[==[ This module is a Lua implementation of the old {{Portal}} template. As of February 2019 it is used on nearly 7,900,000 articles.
---- Please take care when updating it! It outputs two functions: p.portal, which generates a list of portals, and p.image, which
---- produces the image name for an individual portal.
--
---- The portal image data is kept in submodules of [[Module:Portal/images]], listed below:
---- [[Module:Portal/images/a]] - for portal names beginning with "A".
---- [[Module:Portal/images/b]] - for portal names beginning with "B".
---- [[Module:Portal/images/c]] - for portal names beginning with "C".
---- [[Module:Portal/images/d]] - for portal names beginning with "D".
---- [[Module:Portal/images/e]] - for portal names beginning with "E".
---- [[Module:Portal/images/f]] - for portal names beginning with "F".
---- [[Module:Portal/images/g]] - for portal names beginning with "G".
---- [[Module:Portal/images/h]] - for portal names beginning with "H".
---- [[Module:Portal/images/i]] - for portal names beginning with "I".
---- [[Module:Portal/images/j]] - for portal names beginning with "J".
---- [[Module:Portal/images/k]] - for portal names beginning with "K".
---- [[Module:Portal/images/l]] - for portal names beginning with "L".
---- [[Module:Portal/images/m]] - for portal names beginning with "M".
---- [[Module:Portal/images/n]] - for portal names beginning with "N".
---- [[Module:Portal/images/o]] - for portal names beginning with "O".
---- [[Module:Portal/images/p]] - for portal names beginning with "P".
---- [[Module:Portal/images/q]] - for portal names beginning with "Q".
---- [[Module:Portal/images/r]] - for portal names beginning with "R".
---- [[Module:Portal/images/s]] - for portal names beginning with "S".
---- [[Module:Portal/images/t]] - for portal names beginning with "T".
---- [[Module:Portal/images/u]] - for portal names beginning with "U".
---- [[Module:Portal/images/v]] - for portal names beginning with "V".
---- [[Module:Portal/images/w]] - for portal names beginning with "W".
---- [[Module:Portal/images/x]] - for portal names beginning with "X".
---- [[Module:Portal/images/y]] - for portal names beginning with "Y".
---- [[Module:Portal/images/z]] - for portal names beginning with "Z".
---- [[Module:Portal/images/other]] - for portal names beginning with any other letters. This includes numbers,
---- letters with diacritics, and letters in non-Latin alphabets.
---- [[Module:Portal/images/aliases]] - for adding aliases for existing portal names. Use this page for variations
---- in spelling and diacritics, etc., no matter what letter the portal begins with.
----
---- The images data pages are separated by the first letter to reduce server load when images are added, changed, or removed.
---- Previously all the images were on one data page at [[Module:Portal/images]], but this had the disadvantage that all
---- 5,000,000 pages using this module needed to be refreshed every time an image was added or removed.
--]==]
--
--local p = {}
--
---- determine whether we're being called from a sandbox
--local isSandbox = mw.getCurrentFrame():getTitle():find('sandbox', 1, true)
--local sandbox = isSandbox and '/sandbox' or ''
--
--local function sandboxVersion(s)
-- 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 checkTracking(title)
-- local thisPage = title or mw.title.getCurrentTitle()
-- if thisPage.isTalkPage then
-- 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
--
--local function matchImagePage(s)
-- -- Finds the appropriate image subpage given a lower-case
-- -- portal name plus the first letter of that portal name.
-- if type(s) ~= 'string' or #s < 1 then return end
-- local firstLetter = mw.ustring.sub(s, 1, 1)
-- local imagePage
-- if mw.ustring.find(firstLetter, '^[a-z]') then
-- imagePage = 'Module:Portal/images/' .. firstLetter .. sandbox
-- else
-- imagePage = 'Module:Portal/images/other' .. sandbox
-- end
-- return mw.loadData(imagePage)[s]
--end
--
--local function getAlias(s)
-- -- Gets an alias from the image alias data page.
-- local aliasData = mw.loadData('Module:Portal/images/aliases'..sandbox)
-- for portal, aliases in pairs(aliasData) do
-- for _, alias in ipairs(aliases) do
-- if alias == s then
-- return portal
-- end
-- end
-- end
--end
--
--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 default
-- end
-- s = mw.ustring.lower(s)
-- return matchImagePage(s) or matchImagePage(getAlias(s)) or default
--end
--
-- -- Function to check argument portals for errors, generate tracking categories if needed
-- -- Function first checks for too few/many portals provided
-- -- Then checks the portal list to purge any portals that don't exist
-- -- Arguments:
-- -- portals: raw list of portals
-- -- args.tracking: is tracking requested? (will not track on bad titles or namespaces)
-- -- args.redlinks: should redlinks be displayed?
-- -- args.minPortals: minimum number of portal arguments
-- -- args.maxPortals: maximum number of portal arguments
-- -- Returns:
-- -- portals = list of portals, with redlinks purged (if args.redlinks=false)
-- -- trackingCat = possible tracking category
-- -- errorMsg = error message
--function p._checkPortals(portals, args)
-- local trackingCat = ''
-- local errMsg = nil
--
-- -- Tracking is on by default.
-- -- It is disabled if any of the following is true
-- -- 1/ the parameter "tracking" is set to 'no, 'n', or 'false'
-- -- 2/ the current page fails the namespace or pagename tests
-- local trackingEnabled = args.tracking and checkTracking()
--
-- args.minPortals = args.minPortals or 1
-- args.maxPortals = args.maxPortals or -1
-- -- check for too few portals
-- if #portals < args.minPortals then
-- errMsg = 'please specify at least '..args.minPortals..' portal'..(args.minPortals > 1 and 's' or '')
-- trackingCat = (trackingEnabled and '[[Category:Portal templates with too few portals]]' or '')
-- return portals, trackingCat, errMsg
-- end
-- -- check for too many portals
-- if args.maxPortals >= 0 and #portals > args.maxPortals then
-- errMsg = 'too many portals (maximum = '..args.maxPortals..')'
-- trackingCat = (trackingEnabled and '[[Category:Portal templates with too many portals]]' or '')
-- return portals, trackingCat, errMsg
-- end
-- if not args.redlinks or trackingEnabled then
-- -- make new list of portals that exist
-- local existingPortals = {}
-- for _, portal in ipairs(portals) do
-- local portalTitle = mw.title.new(portal,"Портал")
-- -- if portal exists, put it into list
-- if portalTitle and portalTitle.exists then
-- table.insert(existingPortals,portal)
-- -- otherwise set tracking cat
-- elseif trackingEnabled then
-- trackingCat = "[[Category:Portal templates with redlinked portals]]"
-- end
-- end
-- -- If redlinks is off, use portal list purged of redlinks
-- portals = args.redlinks and portals or existingPortals
-- -- if nothing left after purge, set tracking cat
-- if #portals == 0 and trackingEnabled then
-- trackingCat = trackingCat.."[[Category:Pages with empty portal template]]"
-- end
-- end
-- return portals, trackingCat, errMsg
--end
--
--function p._portal(portals, args)
-- -- This function builds the portal box used by the {{portal}} template.
--
-- -- Normalize all arguments
-- 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.create('div')
-- :attr('role', 'navigation')
-- :attr('aria-label', 'Portali')
-- :addClass('noprint plainlist')
-- :addClass(sandboxVersion('portalbox'))
-- :addClass(args.border and sandboxVersion('portalborder') or '')
-- :addClass(args.left and 'tleft' or 'tright')
-- :css('margin', args.margin or nil)
-- :newline()
--
-- local trackingCat = ''
-- local errMsg = nil
-- args.minPortals = args.nominimum and 0 or 1
-- args.maxPortals = -1
-- portals, trackingCat, errMsg = p._checkPortals(portals, args)
-- root:wikitext(trackingCat)
-- -- 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')
-- errTag:addClass('error')
-- errTag:css('padding','0.2em')
-- errTag:wikitext('Error: '..errMsg)
-- end
-- return tostring(root)
-- end
-- -- if no portals (and no error), just return tracking category
-- if #portals == 0 then
-- return trackingCat
-- end
--
-- -- 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.
-- for _, portal in ipairs(portals) do
-- local image = getImageName(portal)
--
-- -- Generate the html for the image and the portal name.
-- listroot
-- :newline()
-- :tag('li')
-- :tag('span')
-- :wikitext(string.format('[[File:%s|32x28px|class=noviewer]]', image))
-- :done()
-- :tag('span')
-- :wikitext(string.format('[[Портал:%s|Portal %s%s]]', portal, portal, args.addBreak and '<br />' or ' '))
-- end
-- return tostring(root)
--end
--
--function p._image(portal,nostrip)
-- -- Wrapper function to allow getImageName() to be accessed through #invoke.
-- -- backward compatibility: if table passed, take first element
-- if type(portal) == 'table' then
-- portal = portal[1]
-- end
-- local name = getImageName(portal)
-- -- If nostrip is yes (or equivalent), then allow all metadata (like image borders) to be returned
-- local strip = not yesno(nostrip)
-- return strip and name:match('^(.-)|') or name -- FIXME: use a more elegant way to separate borders etc. from the image name
--end
--
--local function getAllImageTables()
-- -- 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] = mw.loadData('Module:Portal/images/' .. subpage .. sandbox)
-- end
-- return images
--end
--
--function p._displayAll(portals, args)
-- -- This function displays all portals that have portal images. This function is for maintenance purposes and should not be used in
-- -- articles, for two reasons: 1) there are over 1500 portals with portal images, and 2) the module doesn't record how the portal
-- -- names are capitalized, so the portal links may be broken.
-- local lang = mw.language.getContentLanguage()
-- local count = 1
-- for _, imageTable in ipairs(getAllImageTables()) do
-- for portal in pairs(imageTable) do
-- portals[count] = lang:ucfirst(portal)
-- count = count + 1
-- end
-- end
-- return p._portal(portals, args)
--end
--
--function p._imageDupes()
-- -- This function searches the image subpages to find duplicate images. If duplicate images exist, it is not necessarily a bad thing,
-- -- as different portals might just happen to choose the same image. However, this function is helpful in identifying images that
-- -- should be moved to a portal alias for ease of maintenance.
-- local exists, dupes = {}, {}
-- for _, imageTable in ipairs(getAllImageTables()) do
-- for portal, image in pairs(imageTable) do
-- if not exists[image] then
-- 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
-- if #dupes < 1 then
-- return 'No duplicate images found.'
-- else
-- return 'The following duplicate images were found:\n* ' .. table.concat(dupes, '\n* ')
-- end
--end
--
--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|2=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
--
---- Entry point for sorting portals from other named arguments
--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
--
--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.
-- -- Also: trim whitespace and remove blank arguments
-- local origArgs = getArgs(frame)
-- -- create two tables to pass to func: an array of portal names, and a table of named arguments.
-- local portals, args = processPortalArgs(origArgs)
-- local results = ''
-- if funcName == '_portal' or funcName == '_displayAll' then
-- results = frame:extensionTag{ name = 'templatestyles', args = { src = templatestyles} }
-- end
-- return results .. p[funcName](portals, args)
-- end
--end
--
--for _, funcName in ipairs{'portal', 'imageDupes', 'displayAll'} do
-- p[funcName] = makeWrapper('_' .. funcName)
--end
--
--return p
--[==[ This module is a Lua implementation of the old {{Portal}} template. As of August 2013 it is used on nearly 5,000,000 articles.
-- Please take care when updating it! It outputs two functions: p.portal, which generates a list of portals, and p.image, which
-- produces the image name for an individual portal.
-- The portal image data is kept in submodules of [[Module:Portal/images]], listed below:
-- [[Module:Portal/images/a]] - for portal names beginning with "A".
-- [[Module:Portal/images/b]] - for portal names beginning with "B".
-- [[Module:Portal/images/c]] - for portal names beginning with "C".
-- [[Module:Portal/images/d]] - for portal names beginning with "D".
-- [[Module:Portal/images/e]] - for portal names beginning with "E".
-- [[Module:Portal/images/f]] - for portal names beginning with "F".
-- [[Module:Portal/images/g]] - for portal names beginning with "G".
-- [[Module:Portal/images/h]] - for portal names beginning with "H".
-- [[Module:Portal/images/i]] - for portal names beginning with "I".
-- [[Module:Portal/images/j]] - for portal names beginning with "J".
-- [[Module:Portal/images/k]] - for portal names beginning with "K".
-- [[Module:Portal/images/l]] - for portal names beginning with "L".
-- [[Module:Portal/images/m]] - for portal names beginning with "M".
-- [[Module:Portal/images/n]] - for portal names beginning with "N".
-- [[Module:Portal/images/o]] - for portal names beginning with "O".
-- [[Module:Portal/images/p]] - for portal names beginning with "P".
-- [[Module:Portal/images/q]] - for portal names beginning with "Q".
-- [[Module:Portal/images/r]] - for portal names beginning with "R".
-- [[Module:Portal/images/s]] - for portal names beginning with "S".
-- [[Module:Portal/images/t]] - for portal names beginning with "T".
-- [[Module:Portal/images/u]] - for portal names beginning with "U".
-- [[Module:Portal/images/v]] - for portal names beginning with "V".
-- [[Module:Portal/images/w]] - for portal names beginning with "W".
-- [[Module:Portal/images/x]] - for portal names beginning with "X".
-- [[Module:Portal/images/y]] - for portal names beginning with "Y".
-- [[Module:Portal/images/z]] - for portal names beginning with "Z".
-- [[Module:Portal/images/other]] - for portal names beginning with any other letters. This includes numbers,
-- letters with diacritics, and letters in non-Latin alphabets.
-- [[Module:Portal/images/aliases]] - for adding aliases for existing portal names. Use this page for variations
-- in spelling and diacritics, etc., no matter what letter the portal begins with.
--
-- The images data pages are separated by the first letter to reduce server load when images are added, changed, or removed.
-- Previously all the images were on one data page at [[Module:Portal/images]], but this had the disadvantage that all
-- 5,000,000 pages using this module needed to be refreshed every time an image was added or removed.
]==]
local p = {}
local function matchImagePage(s)
-- Finds the appropriate image subpage given a lower-case
-- portal name plus the first letter of that portal name.
if type(s) ~= 'string' or #s < 1 then return end
local firstLetter = mw.ustring.sub(s, 1, 1)
local imagePage
if mw.ustring.find(firstLetter, '^[a-z]') then
imagePage = 'Module:Portal/images/' .. firstLetter
else
imagePage = 'Module:Portal/images/other'
end
return mw.loadData(imagePage)[s]
end
local function getAlias(s)
-- Gets an alias from the image alias data page.
local aliasData = mw.loadData('Module:Portal/images/aliases')
for portal, aliases in pairs(aliasData) do
for _, alias in ipairs(aliases) do
if alias == s then
return portal
end
end
end
end
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 default
end
s = mw.ustring.lower(s)
return matchImagePage(s) or matchImagePage(getAlias(s)) or default
end
function p._portal(portals, args)
-- This function builds the portal box used by the {{portal}} template.
local root = mw.html.create('div')
:attr('role', 'navigation')
:attr('aria-label', 'Portals')
:addClass('noprint portal plainlist')
:addClass(args.left and 'tleft' or 'tright')
:css('margin', args.margin or (args.left == 'yes' and '0.5em 1em 0.5em 0') or '0.5em 0 0.5em 1em')
:css('border', 'solid #aaa 1px')
:newline()
-- If no portals have been specified, display an error and add the page to a tracking category.
if not portals[1] then
root:wikitext('<strong class="error">No portals specified: please specify at least one portal</strong>[[Category:Portal templates without a parameter]]')
return tostring(root)
end
-- Start the list. This corresponds to the start of the wikitext table in the old [[Template:Portal]].
local listroot = root:tag('ul')
:css('display', 'table')
:css('box-sizing', 'border-box')
:css('padding', '0.1em')
:css('max-width', '175px')
:css('width', type(args.boxsize) == 'string' and (args.boxsize .. 'px') or nil)
:css('background', '#f9f9f9')
:css('font-size', '85%')
:css('line-height', '110%')
:css('font-style', 'italic')
:css('font-weight', 'bold')
-- Display the portals specified in the positional arguments.
for _, portal in ipairs(portals) do
local image = getImageName(portal)
-- Generate the html for the image and the portal name.
listroot
:newline()
:tag('li')
:css('display', 'table-row')
:tag('span')
:css('display', 'table-cell')
:css('padding', '0.2em')
:css('vertical-align', 'middle')
:css('text-align', 'center')
:wikitext(string.format('[[File:%s|32x28px|class=noviewer]]', image))
:done()
:tag('span')
:css('display', 'table-cell')
:css('padding', '0.2em 0.2em 0.2em 0.3em')
:css('vertical-align', 'middle')
:wikitext(string.format('[[Портал:%s|Portal %s%s]]', portal, mw.language.getContentLanguage():ucfirst(portal), args['break'] and '<br />' or ' '))
end
return tostring(root)
end
function p._image(portals)
-- Wrapper function to allow getImageName() to be accessed through #invoke.
local name = getImageName(portals[1])
return name:match('^(.-)|') or name -- FIXME: use a more elegant way to separate borders etc. from the image name
end
local function getAllImageTables()
-- 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] = mw.loadData('Module:Portal/images/' .. subpage)
end
return images
end
function p._displayAll(portals, args)
-- This function displays all portals that have portal images. This function is for maintenance purposes and should not be used in
-- articles, for two reasons: 1) there are over 1500 portals with portal images, and 2) the module doesn't record how the portal
-- names are capitalized, so the portal links may be broken.
local lang = mw.language.getContentLanguage()
local count = 1
for _, imageTable in ipairs(getAllImageTables()) do
for portal in pairs(imageTable) do
portals[count] = lang:ucfirst(portal)
count = count + 1
end
end
return p._portal(portals, args)
end
function p._imageDupes()
-- This function searches the image subpages to find duplicate images. If duplicate images exist, it is not necessarily a bad thing,
-- as different portals might just happen to choose the same image. However, this function is helpful in identifying images that
-- should be moved to a portal alias for ease of maintenance.
local exists, dupes = {}, {}
for _, imageTable in ipairs(getAllImageTables()) do
for portal, image in pairs(imageTable) do
if not exists[image] then
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
if #dupes < 1 then
return 'No duplicate images found.'
else
return 'The following duplicate images were found:\n* ' .. table.concat(dupes, '\n* ')
end
end
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|2=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{'portal', 'image', 'imageDupes', 'displayAll'} do
p[funcName] = makeWrapper('_' .. funcName)
end
return p