وحدة:Portal
يمكن إنشاء صفحة توثيق الوحدة في وحدة:Portal/شرح
--[==[ This module is a Lua implementation of the old {{Portal}} template.
-- [[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 mPagetype = require('Module:Pagetype')
local fPagetype = mPagetype.main
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, '^[اأإآبجدهوزحطيكلمنسعفصقرشتثخذضظغ]') 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
return s
end
local function getImageName(s)
-- Gets the image name for a given string.
if type(s) ~= 'string' or #s < 1 then
return 'Portal-puzzle.svg'
end
s = mw.ustring.lower(s)
return matchImagePage(s) or matchImagePage(getAlias(s)) or 'Portal-puzzle.svg'
end
function p._portal(portals, args)
-- This function builds the vertical portal box used by the {{بوابة}} template.
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.5em 0.5em 0')
: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 portals[1] then
root:wikitext('<li><strong class="error">خطأ في استعمال [[قالب:بوابة]]: يلزم [[س:ق#وسيط فعلي|إعطاء]] [[ن:ق#وسيط شكلي|وسيط]] واحد على الأقل.</strong></li>')
end
local isRedandant = false --متغير لاكتشاف البوابات المكررة في شريط البوابات
local redundantPortals = "" --متغير آخر لتخزين البوابات
-- Display the portals specified in the positional arguments.
for _, portal in ipairs(portals) do
local image = getImageName(portal)
portal = getAlias(portal);
if string.match(redundantPortals, "ااا" .. portal .. "ااا") then --إذا كانت البوابة الثانية موجودة فعلا
isRedandant = true
else
redundantPortals = redundantPortals .. "ااا" .. portal .. "ااا"
-- 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(string.format('[[File:%s|32x28px|alt=بوابة %s|class=noviewer|link=بوابة:%s]]', image, portal, portal))
:done()
:tag('td')
:css('padding', '0 0.2em')
:css('vertical-align', 'middle')
:css('font-style', 'italic')
:css('font-weight', 'bold')
:wikitext(string.format('[[بوابة:%s|بوابة%s%s]]', portal, args['break'] and '<br />' or ' ', portal))
:allDone()
end
end
if (isRedandant) then --إذا كان هناك بوابات مكررة
return tostring(root) .. '[[تصنيف:صفحات_تحتوي_بوابات_مكررة_باستخدام_قالب_بوابة]]';
else
return tostring(root)
end
end
function p._hPortal(portals, args)
-- This function builds the horizontal portal box used by the {{شريط بوابات}} template.
local root = mw.html.create('ul')
if args['نمط'] == 'قائمة' then
root:addClass('liste-portail')
root:attr( 'id', 'liste-portail' )
else
root:addClass('bandeau-portail إعلام')
root:attr( 'id', 'bandeau-portail' )
end
-- If no portals have been specified, display an error and add the page to a tracking category.
if not portals[1] then
root:wikitext('<li><strong class="error">خطأ في استعمال [[قالب:شريط بوابات]]: يلزم [[س:ق#وسيط فعلي|إعطاء]] [[ن:ق#وسيط شكلي|وسيط]] واحد على الأقل.</strong></li>')
end
local portalcats = ''
local isRedandant = false --متغير لاكتشاف البوابات المكررة في شريط البوابات
local redundantPortals = "" --متغير آخر لتخزين البوابات
-- Display the portals specified in the positional arguments.
for _, portal in ipairs(portals) do
local image = getImageName(portal)
local portalname = getAlias(portal);
if string.match(redundantPortals, "ااا" .. portalname .. "ااا") then --إذا كانت البوابة الثانية موجودة فعلا
isRedandant = true
else --إذا لم تكن البوابة موجودة في المتغير
redundantPortals = redundantPortals .. "ااا" .. portalname .. "ااا"
portalcats = portalcats .. string.format('[[تصنيف:بوابة %s/مقالات متعلقة]]', portalname);
-- Generate the html for the image and the portal name.
root
:newline()
:tag('li')
:addClass('bandeau-portail-element')
:tag('span')
:addClass('bandeau-portail-icone')
:css('margin-right', '1em')
:wikitext(string.format('[[File:%s|32x28px|alt=أيقونة بوابة|class=noviewer|link=بوابة:%s]]', image, portalname))
:done()
:tag('span')
:addClass('bandeau-portail-texte')
:wikitext(string.format('[[بوابة:%s|بوابة %s]]', portalname, portalname))
:allDone()
end
end
if fPagetype() == 'مقالة' then
portalcats = portalcats .. '[[تصنيف:جميع_المقالات_التي_تستخدم_شريط_بوابات]]';
if (isRedandant) then --إذا كان هناك بوابات مكررة
portalcats = portalcats .. '[[تصنيف:مقالات_تحتوي_بوابات_مكررة]]';
end
return tostring(root) .. portalcats
else
return tostring(root)
end
end
function p._relatedPortal2(portals, args)
local root = mw.html.create('ul')
root:cssText('margin:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;'
..'-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap;-webkit-justify-content:space-around;-ms-flex-pack:distribute;'
..'justify-content:space-around;-webkit-box-align:center;-webkit-align-items:center;-ms-flex-align:center;align-items:center;'
..'text-align:center;font-weight:bold;list-style:none none')
local iconeSize = '60x60'
dims = {}
if args['حجم'] then
iconeSize= args['حجم']
end
local per_row = #portals
if args['في_سطر'] then
per_row= tonumber(args['في_سطر'])
end
local width = math.floor( 100/per_row )
-- If no portals have been specified, display an error and add the page to a tracking category.
if not portals[1] then
root:wikitext('<li><strong class="error">خطأ في استعمال [[قالب:بوابات متعلقة]]: يلزم [[س:ق#وسيط فعلي|إعطاء]] [[ن:ق#وسيط شكلي|وسيط]] واحد على الأقل.</strong></li>')
end
-- Display the portals specified in the positional arguments.
for _, portal in ipairs(portals) do
local image = getImageName(portal)
local portalname = getAlias(portal);
-- Generate the html for the image and the portal name.
root
:newline()
:tag('li')
:cssText('box-sizing:border-box;margin:0;padding:1em .5em 0;display:inline-block;min-width:9em;'
..'width:'..width..'%;vertical-align:middle')
:wikitext(string.format('[[File:%s|%spx|link=بوابة:%s]]' , image, iconeSize, portalname))
:wikitext(string.format('<br /><strong>[[بوابة:%s|%s]]</strong>', portalname, portalname))
end
return tostring(root)
end
function p._relatedPortal(portals, args)
-- This function builds the portal box used by the {{portal}} template.
local root = mw.html.create('div')
root:addClass('related-portals')
root:cssText('margin-right: auto; margin-left: auto; display: table;text-align:center;')
local iconeSize = '65x40'
dims = {}
if args['حجم'] then
iconeSize= args['حجم']
end
for s in string.gmatch(iconeSize,"%d+") do table.insert(dims,s) end
if #dims == 1 then
newWidth = dims[1]
newHeight = dims[1]
else
newWidth = dims[1]
newHeight = dims[2]
end
-- If no portals have been specified, display an error and add the page to a tracking category.
if not portals[1] then
root:wikitext('<li><strong class="error">خطأ في استعمال [[قالب:بوابات متعلقة]]: يلزم [[س:ق#وسيط فعلي|إعطاء]] [[ن:ق#وسيط شكلي|وسيط]] واحد على الأقل.</strong></li>')
end
-- Display the portals specified in the positional arguments.
for _, portal in ipairs(portals) do
local image = getImageName(portal)
local portalname = getAlias(portal);
-- Generate the html for the image and the portal name.
root
:newline()
:tag('div')
:cssText('text-align:center;width:100px;height:'..(newHeight+90)..'px;display:inline-block;')
:tag('div')
:cssText('height:'..newHeight..'px;padding:8px 2px')
:wikitext(string.format('[[File:%s|%spx|link=بوابة:%s]]' , image, iconeSize, portalname))
:done()
:tag('div')
:cssText('height:90px;padding:8px')
:wikitext(string.format('<strong>[[بوابة:%s|%s]]</strong>', portalname, portalname))
end
return tostring(root)
end
function p._simplePortal(portals, args)
-- If no portals have been specified, display an error and add the page to a tracking category.
if not portals[1] then
root:wikitext('<li><strong class="error">خطأ في استعمال [[قالب:بوابة بسيط]]: يلزم [[س:ق#وسيط فعلي|إعطاء]] [[ن:ق#وسيط شكلي|وسيط]] واحد فقط.</strong></li>')
end
local image = getImageName(portals[1])
local portalname = getAlias(portals[1]);
return string.format('[[File:%s|20px|link=بوابة:%s]] [[بوابة:%s|بوابة %s]]', image, portalname, portalname, portalname)
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 = {}
for i, subpage in ipairs{'ا', 'أ', 'إ', 'آ', 'ب', 'ج', 'د', 'ه', 'و', 'ز', 'ح', 'ط', 'ي', 'ك', 'ل', 'م', 'ن', 'س', 'ع', 'ف', 'ص', 'ق', 'ر', 'ش', 'ت', 'ث', 'خ', 'ذ', 'ض', 'ظ', 'غ', '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._hPortal(portals, args)
end
function p._display1Table(portals, args)
-- This function displays all portals that have portal images from one table.
local lang = mw.language.getContentLanguage()
local firstLetter = portals[1]
local imagePage
local imageTable
if mw.ustring.find(firstLetter, '^[اأإآبجدهوزحطيكلمنسعفصقرشتثخذضظغ]') then
imagePage = 'Module:Portal/images/' .. firstLetter
else
imagePage = 'Module:Portal/images/other'
end
local count = 1
imageTable = mw.loadData(imagePage)
for portal in pairs(imageTable) do
portals[count] = lang:ucfirst(portal)
count = count + 1
end
return p._relatedPortal(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','hPortal', 'relatedPortal', 'relatedPortal2', 'image', 'imageDupes', 'displayAll', 'display1Table', 'simplePortal'} do
p[funcName] = makeWrapper('_' .. funcName)
end
return p