Modhul:Portal
 | Cithakan ikidiayomi saka penyuntinganamarga arupacithakan mawa résiko dhuwur(Dianggo ing 6500000+ pages, which is ≈3570% of all+ kaca). Mangga anggokaca dhiskusikanggo ngusulaké owah-owahan, lan aja lali nambahaké {{Edit protected}} kanggo narik kawigatèn panata. |
 | This module issubject to page protection.It is ahighly visible modulein use by a very large number of articles, or issubstitutedvery frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is isprotectedfrom editing. |
This module has two functions,portalandimage.Theportalproduces a box with links to aportalor to multiple portals, and is used by the {{portal}} template. It is most often used in the "See also" section of an article. Theimagefunction produces the name of the image used by the specified portal.
Portal function
[besut sumber]The portal function produces a box of portal links.
Usage
[besut sumber]
- Basic usage
{{#invoke:Portal|portal |Portal 1|Portal 2|Portal 3|... }}
- All options
{{#invoke:Portal|portal
|Portal 1
|Portal 2
|Portal 3
|...
| left =
| margin =
| break =
| boxsize =
}}
Location
[besut sumber]Within articles, the output of the portal function is meant to be placed at the top of the article'sSee alsosection. If there is noSee alsosection, you can put it in theExternal linkssection instead; there is no need to create a new section just to house this template. If there is noExternal linkssection either, just put it below the article text in the place that seems most appropriate.
There are no particular rules about the placement of portals on other kinds of pages.
Image
[besut sumber]The portal image names are stored in subpages ofModule:Portal/images,organised by the first letter of the portal name. For example, the first letter ofPortal:Fishingis "F", so the image name is stored atModule:Portal/images/f.If there is an entry for a portal on the correct page then the corresponding image will be shown next to the portal link. If no image is found thenFile:Portal-puzzle.svgwill be shown instead.
It is also possible to specify aliases for portal images. For example, the code{{Portal|Detroit}}produces the same image as the code{{Portal|Metro Detroit}}.The "Detroit" alias is found on the pageModule:Portal/images/aliases.
The image-detection algorithm is case-insensitive. For example, the code{{Portal|Detroit}}will produce the same image as the code{{Portal|detroit}}(although the portal links will be different). Portal names are stored in lower case in the image subpages, and input is converted to lower case before being checked.
To add new images to the list, pleasemake a protected edit request at Template talk:Portalto get an administrator to edit the correct subpage for you. Portal images must be either in the public domain or available under afree licensethat allows commercial reuse and derivative works;fair-useimages are not acceptable. The template {{Portal icon demonstration}} may be of use when deciding whether an image is suitable for use as a portal icon; it formats an image using the same size and style that the {{Portal}} template uses by default.
| List of image subpages | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Example
[besut sumber]| Code | Result |
|---|---|
{{#invoke:Portal|portal|Science}}
|
Parameters
[besut sumber]| Name | Value | Description |
|---|---|---|
1,2,3... |
The portal name, e.g.Literature |
The positional parameters specify the portals to be displayed. |
left |
yes |
If set toyes,the portal appears on the left side of the page instead of the right.
|
margin |
CSS margin value, e.g.1.2em 3em 0.5em 1em |
This allows you to set a custom margin. All valid CSS margin values are accepted. |
break |
yes |
If set toyes,a line break is inserted after the portal name and before the wordportal.
|
boxsize |
Size in pixels, e.g.300 |
This sets a custom box width in pixels. |
Maintenance
[besut sumber]The following tracking category lists instances where the module is used incorrectly:
Image function
[besut sumber]The image function produces the name of the image used by the specified portal.
Usage
[besut sumber]{{#invoke:Portal|image|portal}}
Example
[besut sumber]{{#invoke:Portal|image|Art}}→ Ballerina-icon.jpg
Image dupes function
[besut sumber]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
[besut sumber]{{#invoke:Portal|imageDupes}}
Display all function
[besut sumber]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 atTemplate:Portal/doc/all.
Usage
[besut sumber]{{#invoke:Portal|displayAll}}
--[==[ 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 Alpha bets.
-- [[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={}
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
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','Portals')
: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()
-- If no portals have been specified, display an error and add the page to a tracking category.
ifnotportals[1]then
root:wikitext('<strong class= "error" >No portals specified: please specify at least one portal</strong>[[Category:Portal templates without a parameter]]')
returntostring(root)
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('[[Gapura:%s|Gapura %s%s]]',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