Modul:Portal

Seba na module şıma şenê yû pela dokumani vırazêModul:Portal/dok

--[==[ 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.
]==]

localp={}

localtrackingEnabled=true

-- Check whether to do tracking in this namespace
-- Returns true unless the page is one of the banned namespaces
localfunctioncheckTrackingNamespace()
localthisPage=mw.title.getCurrentTitle()
if(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
then
returnfalse
end
returntrue
end

-- Check whether to do tracking on this pagename
-- Returns false if the page title matches one of the banned strings
-- Otherwise returns true
localfunctioncheckTrackingPagename()
localthisPage=mw.title.getCurrentTitle()
localthisPageLC=mw.ustring.lower(thisPage.text)
if(string.match(thisPageLC,"/archive")~=nil)then
returnfalse
end
if(string.match(thisPageLC,"/doc")~=nil)then
returnfalse
end
if(string.match(thisPageLC,"/test")~=nil)then
returnfalse
end
returntrue
end


localfunctionmatchImagePage(s)
-- Finds the appropriate image subpage given a lower-case
-- portal name plus the first letter of that portal name.
iftype(s)~='string'or#s<1thenreturnend
localfirstLetter=mw.ustring.sub(s,1,1)
localimagePage
ifmw.ustring.find(firstLetter,'^[a-z]')then
imagePage='Module:Portal/images/'..firstLetter
else
imagePage='Module:Portal/images/other'
end
returnmw.loadData(imagePage)[s]
end

localfunctiongetAlias(s)
-- Gets an alias from the image alias data page.
localaliasData=mw.loadData('Module:Portal/images/aliases')
forportal,aliasesinpairs(aliasData)do
for_,aliasinipairs(aliases)do
ifalias==sthen
returnportal
end
end
end
end

localfunctiongetImageName(s)
-- Gets the image name for a given string.
localdefault='Portal-puzzle.svg|link=|alt='
iftype(s)~='string'or#s<1then
returndefault
end
s=mw.ustring.lower(s)
returnmatchImagePage(s)ormatchImagePage(getAlias(s))ordefault
end

localfunctioncheckPortalExists(portal)
returnnot(mw.title.makeTitle(100,portal).id==0)
end

functionp._portal(portals,args)
-- This function builds the portal box used by the {{portal}} template.
localroot=mw.html.create('div')
:attr('role','navigation')
:attr('aria-label','Portalê')
:addClass('noprint portal plainlist')
:addClass(args.leftand'tleft'or'tright')
:css('margin',args.marginor(args.left=='yes'and'0.5em 1em 0.5em 0')or'0.5em 0 0.5em 1em')
:css('border','solid #aaa 1px')
:newline()

-- 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 tests in checkTrackingNamespace()
-- 3/ the current page fails the pagename tests in checkTrackingPagename()
if(args.tracking=='no')or(args.tracking=='n')or(args.tracking=='false')then
trackingEnabled=false
end
if(checkTrackingNamespace()==false)then
trackingEnabled=false
end
if(checkTrackingPagename()==false)then
trackingEnabled=false
end

-- If no portals have been specified, display an error and add the page to a tracking category.
ifnotportals[1]then
if(args.nominimum=='yes')or(args.nominimum=='y')or(args.nominimum=='true')then
-- if nominimum as been set to yes (or similar), omit the warning

else
root:wikitext('<strong class= "error" >No portals specified: please specify at least one portal</strong>')
end
if(trackingEnabled)then
root:wikitext('[[Category:Portal templates without a parameter]]')
end
returntostring(root)
end

-- scan for nonexistent portals, if they exist remove them from the portals table. If redlinks=yes, then don't remove
localportallen=#portals
-- traverse the list backwards to ensure that no portals are missed (table.remove also moves down the portals in the list, so that the next portal isn't checked if going fowards.
-- going backwards allows us to circumvent this issue
fori=portallen,1,-1do
-- the use of pcall here catches any errors that may occour when attempting to locate pages when the page name is invalid
-- if pcall returns true, then rerun the function to find if the page exists
ifnotpcall(checkPortalExists,portals[i])ornotcheckPortalExists(portals[i])then
-- Getting here means a redlinked portal has been found
if(args.redlinks=='yes')or(args.redlinks=='y')or(args.redlinks=='true')or(args.redlinks=='include')then
-- if redlinks as been set to yes (or similar), add the cleanup category and then break the loop before the portal is removed from the list
if(trackingEnabled)then
root:wikitext('[[Kategoriye:Şablonê portalan be portalanê sûrkerdeyan]]')
end
break
end
-- remove the portal (this does not happen if redlinks=yes)
table.remove(portals,i)
end
end

-- if the length of the table is different, then rows were removed from the table, so portals were removed. If this is the case add the cleanup category
ifnot(portallen==#portals)then
if(trackingEnabled)then
if#portals==0then
return'[[Category:Portal templates with all redlinked portals]]'
else
root:wikitext('[[Kategoriye:Şablonê portalan be portalanê sûrkerdeyan]]')
end
end
end

-- Start the list. This corresponds to the start of the wikitext table in the old [[Template:Portal]].
locallistroot=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')ornil)
: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_,portalinipairs(portals)do
localimage=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('[[Portal:%s|%s%sportal]]',portal,portal,args['break']and'<br />'or' '))
end
returntostring(root)
end

functionp._image(portals)
-- Wrapper function to allow getImageName() to be accessed through #invoke.
localname=getImageName(portals[1])
returnname:match('^(.-)|')orname-- FIXME: use a more elegant way to separate borders etc. from the image name
end

localfunctiongetAllImageTables()
-- Returns an array containing all image subpages (minus aliases) as loaded by mw.loadData.
localimages={}
fori,subpageinipairs{'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
returnimages
end

functionp._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.
locallang=mw.language.getContentLanguage()
localcount=1
for_,imageTableinipairs(getAllImageTables())do
forportalinpairs(imageTable)do
portals[count]=lang:ucfirst(portal)
count=count+1
end
end
returnp._portal(portals,args)
end

functionp._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.
localexists,dupes={},{}
for_,imageTableinipairs(getAllImageTables())do
forportal,imageinpairs(imageTable)do
ifnotexists[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<1then
return'No duplicate images found.'
else
return'The following duplicate images were found:\n* '..table.concat(dupes,'\n* ')
end
end

localfunctionprocessPortalArgs(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'andargsor{}
localportals={}
localnamedArgs={}
fork,vinpairs(args)do
iftype(k)=='number'andtype(v)=='string'then-- Make sure we have no non-string portal names.
table.insert(portals,k)
elseiftype(k)~='number'then
namedArgs[k]=v
end
end
table.sort(portals)
fori,vinipairs(portals)do
portals[i]=args[v]
end
returnportals,namedArgs
end

localfunctionmakeWrapper(funcName)
-- Processes external arguments and sends them to the other functions.
returnfunction(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.
localorigArgs
iftype(frame.getParent)=='function'then
origArgs=frame:getParent().args
fork,vinpairs(frame.args)do
origArgs=frame.args
break
end
else
origArgs=frame
end
-- Trim whitespace and remove blank arguments.
localargs={}
fork,vinpairs(origArgs)do
iftype(v)=='string'then
v=mw.text.trim(v)
end
ifv~=''then
args[k]=v
end
end
returnp[funcName](processPortalArgs(args))-- passes two tables to func: an array of portal names, and a table of named arguments.
end
end

for_,funcNameinipairs{'portal','image','imageDupes','displayAll'}do
p[funcName]=makeWrapper('_'..funcName)
end

returnp