"मोड्युल:Portal" का संशोधनहरू बिचको अन्तर
सा Changed protection level of Module:Portal: High-risk Lua module: allow template editors ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite)) |
नयाँ पृष्ठ: -- This module implements {{Portal}} local p = {} local HtmlBuilder = require('Module:HtmlBuilder') local HtmlError = require('Module:Error') -- This function ge... |
||
पङ्क्ति १: | पङ्क्ति १: | ||
-- This module implements {{Portal}} |
|||
--[==[ 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 table 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 htmlBuilder = require('Module:HtmlBuilder') |
|||
local p = {} |
local p = {} |
||
local HtmlBuilder = require('Module:HtmlBuilder') |
|||
local HtmlError = require('Module:Error') |
|||
-- This function generates the html code. |
|||
local function _portal(args) |
|||
-- 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 |
|||
local images = mw.loadData(imagePage) |
|||
local image = images[s] |
|||
if image then |
|||
return image |
|||
end |
|||
end |
|||
local |
local root = HtmlBuilder.create('div') |
||
-- Gets an alias from the image alias data page. |
|||
root |
|||
local aliasData = mw.loadData('Module:Portal/images/aliases') |
|||
.addClass('noprint') |
|||
for portal, aliases in pairs(aliasData) do |
|||
.addClass((args.left == 'yes' and 'tleft') or 'tright') |
|||
for _, alias in ipairs(aliases) do |
|||
.addClass('portal') |
|||
if alias == s then |
|||
.css('border', 'solid #aaa 1px') |
|||
return portal |
|||
.css('margin', args.margin or (args.left == 'yes' and '0.5em 1em 0.5em 0') or '0.5em 0 0.5em 1em') |
|||
end |
|||
.newline() |
|||
end |
|||
end |
|||
end |
|||
-- Start the table. This corresponds to the start of the wikitext table |
|||
local function getImageName(s) |
|||
-- in the old [[Template:Portal]]. |
|||
-- Gets the image name for a given string. |
|||
local tableroot = root.tag('table') |
|||
if type(s) ~= 'string' or #s < 1 then |
|||
.css('background', '#f9f9f9') |
|||
return 'Portal-puzzle.svg' |
|||
.css('font-size', '85%') |
|||
end |
|||
.css('line-height', '110%') |
|||
s = mw.ustring.lower(s) |
|||
.css('max-width', '175px') |
|||
local image = matchImagePage(s) |
|||
.css('width', args.boxsize and (args.boxsize .. 'px')) |
|||
if image then |
|||
return image |
|||
-- If no portals have been specified, display an error and add the page to a tracking category. |
|||
else |
|||
if not args[1] then |
|||
local alias = getAlias(s) |
|||
tableroot.wikitext( |
|||
image = matchImagePage(alias) -- If no alias was found this returns nil. |
|||
tostring(HtmlError.error{'No portals specified: please specify at least one portal'}) |
|||
if image then |
|||
.. '[[Category:प्राचल पोर्टल ढाँचा]]' |
|||
return image |
|||
) |
|||
else |
|||
end |
|||
return 'Portal-puzzle.svg' |
|||
end |
|||
end |
|||
end |
|||
-- Display the portals specified in the positional arguments. |
|||
function p._portal(portals, args) |
|||
for i,v in ipairs(args) do |
|||
-- This function builds the portal box used by the {{portal}} template. |
|||
v = mw.ustring.match(v, '^%s*(.*%S)') or '' -- Trim whitespace. |
|||
local root = htmlBuilder.create('div') |
|||
root |
|||
-- Portal image names are stored in subtemplates of [[Template:Portal/Images]]. |
|||
.addClass('noprint') |
|||
-- The name of the subtemplate is the portal name in all lower case, but with |
|||
.addClass(args.left and 'tleft' or 'tright') |
|||
-- the first character in upper case. |
|||
.addClass('portal') |
|||
.css('border', 'solid #aaa 1px') |
|||
-- Work out the image subtemplate location. |
|||
.css('margin', args.margin or (args.left == 'yes' and '0.5em 1em 0.5em 0') or '0.5em 0 0.5em 1em') |
|||
local lang = mw.getContentLanguage() |
|||
.newline() |
|||
local imagetemplatename = 'Portal/Images/' .. lang:ucfirst(lang:lc(v)) |
|||
-- Check the image template name. We need three checks: 1) check with pcall to see if |
|||
-- Start the table. This corresponds to the start of the wikitext table in the old [[Template:Portal]]. |
|||
-- we are over the expensive function call limit; 2) check if the proposed image template |
|||
local tableroot = root.tag('table') |
|||
-- name uses invalid characters (mw.title.new returns nil if this is the case); and 3) |
|||
.css('background', '#f9f9f9') |
|||
-- check if the image subtemplate exists. |
|||
.css('font-size', '85%') |
|||
local goodtitlecall, imagetemplateobject = pcall(mw.title.new, imagetemplatename, 'Template') |
|||
.css('line-height', '110%') |
|||
if not (goodtitlecall and imagetemplateobject and imagetemplateobject.exists) then |
|||
.css('max-width', '175px') |
|||
imagetemplatename = 'Portal/Images/Default' |
|||
.css('width', type(args.boxsize) == 'string' and (args.boxsize .. 'px')) |
|||
end |
|||
-- If no portals have been specified, display an error and add the page to a tracking category. |
|||
if not portals[1] then |
|||
tableroot.wikitext('<strong class="error">No portals specified: please specify at least one portal</strong>[[Category:Portal templates without a parameter]]') |
|||
end |
|||
-- Expand the image subtemplate to get the image name |
|||
-- Display the portals specified in the positional arguments. |
|||
local imagename = mw.getCurrentFrame():expandTemplate{ title = imagetemplatename } |
|||
for i, portal in ipairs(portals) do |
|||
local image = getImageName(portal) |
|||
-- Generate the html for the image and the portal name. |
|||
tableroot |
|||
-- Generate the html for the image and the portal name. |
|||
.newline() |
|||
tableroot |
|||
.tag('tr') |
|||
.newline() |
|||
.attr('valign', 'middle') |
|||
.tag('tr') |
|||
.tag('td') |
|||
.attr('valign', 'middle') |
|||
.css('text-align', 'center') |
|||
.tag('td') |
|||
.wikitext('[[File:' .. imagename .. '|32x28px|alt=Portal icon]]') |
|||
.css('text-align', 'center') |
|||
.done() |
|||
.wikitext(mw.ustring.format('[[File:%s|32x28px|alt=Portal icon]]', image)) |
|||
.tag('td') |
|||
.done() |
|||
.css('padding', '0 0.2em') |
|||
.tag('td') |
|||
.css('vertical-align', 'middle') |
|||
.css('font-style', 'italic') |
|||
.css('font-weight', 'bold') |
|||
.wikitext('[[प्रवेशद्वार:' .. v .. '|' .. v .. ((args['break'] == 'yes' and '<br />') or ' ') .. 'प्रवेशद्वार]]') |
|||
.css('font-weight', 'bold') |
|||
end |
|||
.wikitext(mw.ustring.format('[[Portal:%s|%s%sportal]]', portal, 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. |
|||
return getImageName(portals[1]) |
|||
end |
|||
local function getAllImageTables() |
|||
-- Returns an array containing all image subpages (minus aliases) as loaded by mw.loadData. |
|||
local images = {} |
|||
local subpages = {'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'} |
|||
for i, subpage in ipairs(subpages) do |
|||
table.insert(images, 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 images = getAllImageTables() |
|||
local count = 1 |
|||
for i, imageTable in ipairs(images) 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 = {}, {} |
|||
local images = getAllImageTables() |
|||
for i, imageTable in ipairs(images) do |
|||
for portal, image in pairs(imageTable) do |
|||
if not exists[image] then |
|||
exists[image] = portal |
|||
else |
|||
table.insert(dupes, mw.ustring.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 |
|||
return tostring(root) |
|||
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 frame == mw.getCurrentFrame() 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 |
end |
||
-- This function gets the arguments passed to the module and passes them |
|||
local funcNames = {'portal', 'image', 'imageDupes', 'displayAll'} |
|||
-- to the _portal() function above. |
|||
function p.portal(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(args) |
|||
for _, funcName in ipairs(funcNames) do |
|||
p[funcName] = makeWrapper('_' .. funcName) |
|||
end |
end |
||
२०:५३, २४ जुलाई २०१४ जस्तै गरी पुनरावलोकन
This Lua module is used on approximately ८,८९०,००० pages, or roughly 8004% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
यो मोड्युल निम्न अन्य मोड्युलहरूमा निर्भर छ: |
This module uses TemplateStyles: |
This module has two functions, portal
and image
. The portal
produces a box with links to a portal or to multiple portals, and is used by the {{portal}} template. It is most often used in the "See also" section of an article. The image
function produces the name of the image used by the specified portal.
See here, here, and here for test cases.
Portal function
The portal function produces a box of portal links. ढाँचा:Portal/doc
Image function
The image function produces the name of the image used by the specified portal.
Usage
{{#invoke:Portal|image|portal}}
Example
{{#invoke:Portal|image|Art}}
→ Script error: The function "image" does not exist.
Image dupes function
The image dupes function returns a list of all images that are being used by more than one portal (aliases are not included). This can be helpful in identifying image entries that should be changed to use aliases.
Usage
{{#invoke:Portal|imageDupes}}
Display all function
The display all function returns a box containing all portals that have images. This is used for maintenance, and should not be displayed in articles, because a) there are around 1500 portals with images, and displaying 1500 images on one page takes up a lot of server resources, and b) the module has no way to know the correct capitalisation of a portal name, so some links to portals will be broken. This function can be seen at Template:Portal/doc/all.
Usage
{{#invoke:Portal|displayAll}}
-- This module implements {{Portal}}
local p = {}
local HtmlBuilder = require('Module:HtmlBuilder')
local HtmlError = require('Module:Error')
-- This function generates the html code.
local function _portal(args)
local root = HtmlBuilder.create('div')
root
.addClass('noprint')
.addClass((args.left == 'yes' and 'tleft') or 'tright')
.addClass('portal')
.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', args.boxsize and (args.boxsize .. 'px'))
-- If no portals have been specified, display an error and add the page to a tracking category.
if not args[1] then
tableroot.wikitext(
tostring(HtmlError.error{'No portals specified: please specify at least one portal'})
.. '[[Category:प्राचल पोर्टल ढाँचा]]'
)
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 [[Template:Portal/Images]].
-- 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 = 'Portal/Images/' .. 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, 'Template')
if not (goodtitlecall and imagetemplateobject and imagetemplateobject.exists) then
imagetemplatename = 'Portal/Images/Default'
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')
.attr('valign', 'middle')
.tag('td')
.css('text-align', 'center')
.wikitext('[[File:' .. imagename .. '|32x28px|alt=Portal icon]]')
.done()
.tag('td')
.css('padding', '0 0.2em')
.css('vertical-align', 'middle')
.css('font-style', 'italic')
.css('font-weight', 'bold')
.wikitext('[[प्रवेशद्वार:' .. v .. '|' .. v .. ((args['break'] == 'yes' and '<br />') or ' ') .. 'प्रवेशद्वार]]')
end
return tostring(root)
end
-- This function gets the arguments passed to the module and passes them
-- to the _portal() function above.
function p.portal(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(args)
end
return p