मोड्युल:पोर्टल

मोड्युल कागजात[सिर्जना गर्नुहोस्] [ताजा गर्नुहोस्]

You might want to सिर्जना गर्नुहोस् a documentation page for this Scribunto module.
सम्पादकहरूले यस मोड्युलको प्रयोगस्थल (सिर्जना गर्नुहोस् | नक्कल गर्नुहोस्) र परीक्षण (सिर्जना गर्नुहोस्) पृष्ठहरूमा प्रयोग गर्न सक्छन्।
/कागजात उपपृष्ठमा श्रेणीहरू थप्नुहोस्। यस मोड्युलका उपपृष्ठहरू।

--[==[ This module is a Lua implementation of the old {{पोर्टल}} 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:पोर्टल/तस्बिरहरू]], listed below:
-- [[Module:पोर्टल/तस्बिरहरू/क]]		- "क" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ख]]		- "ख" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ग]]		- "ग" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/घ]]		- "घ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ङ]]		- "ङ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/च]]		- "च" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/छ]]		- "छ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ज]]		- "ज" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/झ]]		- "झ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ञ]]		- "ञ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ट]]		- "ट" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ठ]]		- "ठ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ड]]		- "ड" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ढ]]		- "ढ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ण]]		- "ण" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/त]]		- "त" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/थ]]		- "थ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/द]]		- "द" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ध]]		- "ध" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/न]]		- "न" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/प]]		- "प" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/फ]]		- "फ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ब]]		- "ब" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/भ]]		- "भ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/म]]		- "म" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/य]]		- "य" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/र]]		- "र" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ल]]		- "ल" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/व]]		- "व" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/श]]		- "श" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ष]]		- "ष" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/स]]		- "स" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ह]]		- "ह" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/क्ष]]		- "क्ष" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/त्र]]		- "त्र" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/ज्ञ]]		- "ज्ञ" नामका साथ सुरू भएका पोर्टलहरूको लागि ।
-- [[Module:पोर्टल/तस्बिरहरू/अन्य]]	- for portal names beginning with any other letters. This includes numbers,
-- 									  letters with diacritics, and letters in non-Latin alphabets.
-- [[Module:पोर्टल/तस्बिरहरू/उपनामहरू]]	- 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:पोर्टल/तस्बिरहरू]], 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 = {}

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:पोर्टल/तस्बिरहरू/' .. firstLetter
	else
		imagePage = 'Module:पोर्टल/तस्बिरहरू/अन्य'
	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:पोर्टल/तस्बिरहरू/उपनामहरू')
	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)
	return matchImagePage(s) or matchImagePage(getAlias(s)) or default
end

function p._portal(portals, args)
	-- This function builds the portal box used by the {{पोर्टल}} 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:मापदण्ड बिनाका पोर्टल ढाँचाहरू]]')
		return tostring(root)
	end

	-- Start the list. This corresponds to the start of the wikitext table in the old [[Template:पोर्टल]].
	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, 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.
	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 p, subpage in ipairs{'क', 'ख', 'ग', 'घ', 'ङ', 'च', 'छ', 'ज', 'झ', 'ञ', 'ट', 'ठ', 'ड', 'ढ', 'ण', 'त', 'थ', 'द', 'ध', 'न', 'प', 'फ', 'ब', 'भ', 'म', 'य', 'र', 'ल', 'व', 'श', 'ष', 'स', 'ह', 'क्ष', 'त्र', 'ज्ञ', 'अन्य'} do
		images[p] = mw.loadData('Module:पोर्टल/तस्बिरहरू/' .. 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('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
	-- {{पोर्टल|2=प्रविधि}}. 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