Модуль:Portal
ХӀокху модулах лаьцна хааман Модуль:Portal/doc агӀо кхолла мега
local p = {}
-- local HtmlError = require('Модуль:Error')-- not needed
-- This (legacy) function generates the html code.
local function _portal_old(args)
local root = mw.html.create('div')
:addClass('noprint portal')
:addClass(args.left and 'tleft' or 'tright')
:css('border', 'solid #aaa 1px')
:css('margin', args.margin or (args.left == 'yes' and '0.5em 1em 0.5em 0') or '0.5em 0 0.5em 1em')
:newline()
-- Start the table. This corresponds to the start of the wikitext table in the old [[Template:Portal]].
local tableroot = root:tag('table')
:css('background', '#f9f9f9')
:css('font-size', '85%')
:css('line-height', '110%')
:css('max-width', '175px')
:css('width', type(args.boxsize) == 'string' and (args.boxsize .. 'px') or nil)
-- If no portals have been specified, display an error and add the page to a tracking category.
if not args[1] then
tableroot:wikitext('<strong class="error">No portals specified: please specify at least one portal</strong>[[Category:Portal templates without a parameter]]')
end
-- Display the portals specified in the positional arguments.
for i,v in ipairs(args) do
v = mw.ustring.match(v, '^%s*(.*%S)') or '' -- Trim whitespace.
-- Portal image names are stored in subtemplates of [[Кеп:Ков/Сурт]].
-- The name of the subtemplate is the portal name in all lower case, but with
-- the first character in upper case.
-- Work out the image subtemplate location.
local lang = mw.getContentLanguage()
local imagetemplatename = 'Ков/Сурт/' .. lang:ucfirst(lang:lc(v))
-- Check the image template name. We need three checks: 1) check with pcall to see if
-- we are over the expensive function call limit; 2) check if the proposed image template
-- name uses invalid characters (mw.title.new returns nil if this is the case); and 3)
-- check if the image subtemplate exists.
local goodtitlecall, imagetemplateobject = pcall(mw.title.new, imagetemplatename, 'Кеп')
if not (goodtitlecall and imagetemplateobject and imagetemplateobject.exists) then
imagetemplatename = 'Ков/Сурт/Ӏаддитарца'
end
-- Expand the image subtemplate to get the image name
local imagename = mw.getCurrentFrame():expandTemplate{ title = imagetemplatename }
-- Generate the html for the image and the portal name.
tableroot
:newline()
:tag('tr')
:css('vertical-align', 'middle')
:tag('td')
:css('text-align', 'center')
:wikitext('[[Файл:' .. imagename .. '|32x28px|alt=Кевнан значок]]')
:done()
:tag('td')
:css('padding', '0 0.2em')
:css('vertical-align', 'middle')
:css('font-style', 'italic')
:css('font-weight', 'bold')
:wikitext('[[Ков:' .. v .. '|Ков' .. ((args['break'] == 'yes' and '<br />') or ' ') .. '«' .. v .. '»]]')
end
return tostring(root)
end
-- This (legacy) function gets the arguments passed to the module and passes them
-- to the _portal_old() function above.
function p.portal_old(frame)
local orig_args
if frame == mw.getCurrentFrame() then
-- We're being called via #invoke. If the invoking template passed any arguments,
-- use them. Otherwise, use the arguments that were passed into the template.
orig_args = frame:getParent().args
for k, v in pairs(frame.args) do
orig_args = frame.args
break
end
else
-- We're being called from another module or from the debug console, so assume
-- the arguments are passed in directly.
orig_args = frame
end
-- We want to list all the portals in the order they were passed to the template.
-- We also want to be able to deal with positional arguments passed explicitly,
-- for example {{portal|2=Politics}}. However, pairs() doesn't guarantee the correct
-- order, and ipairs() will stop after the first nil value. To get around this, we
-- create a new table of arguments where nil values have been removed, so that we
-- can traverse the numerical arguments using ipairs(). We also remove values which
-- only consist of whitespace. ParserFunctions considers these to be false, and by
-- removing them Lua will consider them false too.
local args = {} -- Arguments table.
local name_args = {} -- Temporary table for named arguments.
for k, v in pairs(orig_args) do
if mw.ustring.match(v, '%S') then -- Remove values that are only whitespace.
if type(k) == 'number' then
table.insert(args, k) -- Put positional argument keys into the arguments table so we can sort them.
else
-- Put named argument values in their own table while we sort the positional arguments,
-- so that we don't have to cycle through all the original arguments again.
name_args[k] = v
end
end
end
table.sort(args) -- Sort the positional argument keys into numerical order.
for i,v in ipairs(args) do
args[i] = orig_args[v] -- Replace positional argument keys with their corresponding values.
end
for k,v in pairs(name_args) do
args[k] = v -- Add named arguments to the args table
end
return _portal_old(args)
end
--[==[ end old (legacy) functions ]==]--
--[==[ 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".
-- ....... "B" — "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 = {}--start of new code; claimed above
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)--temporary disabled
if (matchImagePage(s) or matchImagePage(getAlias(s))) then
return matchImagePage(s) or matchImagePage(getAlias(s))
else
----[==[legacy mode code start for get image from template if it exist, else do get from module
-- Work out the image subtemplate location.
local lang = mw.getContentLanguage()
local imagetemplatename = 'Ков/Сурт/' .. lang:ucfirst(lang:lc(s))
-- Check the image template name. We need three checks: 1) check with pcall to see if
-- we are over the expensive function call limit; 2) check if the proposed image template
-- name uses invalid characters (mw.title.new returns nil if this is the case); and 3)
-- check if the image subtemplate exists.
local goodtitlecall, imagetemplateobject = pcall(mw.title.new, imagetemplatename, 'Кеп')
if (goodtitlecall and imagetemplateobject and imagetemplateobject.exists) then
-- Expand the image subtemplate to get the image name
local imagename = mw.getCurrentFrame():expandTemplate{ title = imagetemplatename }
mw.log('Перенести до [[Модуль:Portal/image/other]] рядок:\n ["' .. s .. '"] = "' .. imagename .. '",')
return imagename
--legacy name retrieved from template above if it exist
else return default
end
end
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|Ков%s«%s»]]', portal, args['break'] and '<br />' or ' ', portal))--needs localisation
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{'other'} do --[=[{'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('<li> [[File:%s|24px]] "[[:File:%s|%s]]" "[[Ков:%s]] "[[Ков:%s]]".\n [[Модуль:Portal/images/aliases]] :\n ["%s"] = {"%s"},', image, image, image, exists[image], portal, 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