Module:Wp/khw/Portal

یہ ماڈیول باب اور تصویر دو کام کرتا ہے۔باب کا ایک ڈبہ مع ربط بابیا متعدد ابواب ہوتے ہیں اور اس کا استعمال Template:سا سانچہ سے ہوتا ہے۔ یہ اکثر کسی مضمون میں "مزید دیکھیے" کی سرخی کے تحت شامل کیا جاتا ہے۔ تصویر خاص اس باب کی نمائندہ ہوتی ہے جس باب کا ربط دیا جاتا ہے۔

باب کا کام

اس کا کام ایک ڈبے میں باب یا ابواب کے ربط/روابط ظاہر کرنا ہوتا ہے۔ Template:باب/دستاویز

تصویر کا کام

یہ اس باب یا ابواب کی نمائندہ تصویر یا تصاویر ظاہر کرتا ہے جس باب یا جن ابواب کے رواب دیئے گئے ہوں۔

استعمال

{{#invoke:Portal|image|Portal}}

مثال

• {{#invoke:Portal|image|فن}} → Portal-puzzle.svg

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۔

استعمال

{{#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 سانچہ:باب/دستاویز/تمام۔

استعمال

{{#invoke:Portal|displayAll}}

---

--[==[ This module is a Lua implementation of the old {{Wp/khw/Portal}} template. As of August 2015 it is used on nearly 42598 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:Wp/khw/Portal/images]], listed below:
-- [[Module:Wp/khw/Portal/images/ا]]		- for portal names beginning with "ا".
-- [[Module:Wp/khw/Portal/images/ب]]		- for portal names beginning with "ب".
-- [[Module:Wp/khw/Portal/images/ث]]		- for portal names beginning with "ث".
-- [[Module:Wp/khw/Portal/images/ڈ]]		- for portal names beginning with "ڈ".
-- [[Module:Wp/khw/Portal/images/خ]]		- for portal names beginning with "خ".
-- [[Module:Wp/khw/Portal/images/ن]]		- for portal names beginning with "ف".
-- [[Module:Wp/khw/Portal/images/ج]]		- for portal names beginning with "G".
-- [[Module:Wp/khw/Portal/images/h]]		- for portal names beginning with "H".
-- [[Module:Wp/khw/Portal/images/i]]		- for portal names beginning with "I".
-- [[Module:Wp/khw/Portal/images/چ]]		- for portal names beginning with "چ".
-- [[Module:Wp/khw/Portal/images/ک]]		- for portal names beginning with "ک".
-- [[Module:Wp/khw/Portal/images/ل]]		- for portal names beginning with "ل".
-- [[Module:Wp/khw/Portal/images/م]]		- for portal names beginning with "م".
-- [[Module:Wp/khw/Portal/images/ن]]		- for portal names beginning with "ن".
-- [[Module:Wp/khw/Portal/images/o]]		- for portal names beginning with "O".
-- [[Module:Wp/khw/Portal/images/پ]]		- for portal names beginning with "پ".
-- [[Module:Wp/khw/Portal/images/ق]]		- for portal names beginning with "ق".
-- [[Module:Wp/khw/Portal/images/ر]]		- for portal names beginning with "ر".
-- [[Module:Wp/khw/Portal/images/س]]		- for portal names beginning with "س".
-- [[Module:Wp/khw/Portal/images/t]]		- for portal names beginning with "T".
-- [[Module:Wp/khw/Portal/images/u]]		- for portal names beginning with "U".
-- [[Module:Wp/khw/Portal/images/v]]		- for portal names beginning with "V".
-- [[Module:Wp/khw/Portal/images/و]]		- for portal names beginning with "و".
-- [[Module:Wp/khw/Portal/images/x]]		- for portal names beginning with "X".
-- [[Module:Wp/khw/Portal/images/y]]		- for portal names beginning with "Y".
-- [[Module:Wp/khw/Portal/images/ز]]		- for portal names beginning with "ز".
-- [[Module:Wp/khw/Portal/images/دیگر]]	- for portal names beginning with any other letters. This includes numbers,
-- 									  letters with diacritics, and letters in non-Latin alphabets.
-- [[Module:Wp/khw/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:Wp/khw/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 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, '^[اآبپتٹثجچحخدڈذرڑزژسشصضطظعغفقکگلمنوھیے]') and mw.title.makeTitle(828, 'Wp/khw/Portal/images/' .. firstLetter).exists then
		-- آ و ا در یک پودمان قرار می‌گیرند.
		if firstLetter == "آ" then
			firstLetter = "ا"
		end
		imagePage = 'Module:Wp/khw/Portal/images/' .. firstLetter
	else
		imagePage = 'Module:Wp/khw/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:Wp/khw/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
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 portal box used by the {{portal}} template.
	local root = mw.html.create('div')
		:addClass('noprint portal')
		:addClass(args.right and 'tright' or 'tleft')
		: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:Wp/khw/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
		tableroot:wikitext('<strong class="error">No portals specified: please specify at least one portal</strong>[[Category:Wp/khw/Portal templates without a parameter]]')
	end

	-- 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.
		tableroot
			:newline()
			:tag('tr')
				:css('vertical-align', 'middle')
				:tag('td')
					:css('text-align', 'center')
					:wikitext(string.format('[[file:%s|32x28px|alt=Portal icon|class=noviewer]]', image))
					:done()
				:tag('td')
					:css('padding', '0 0.2em')
					:css('vertical-align', 'middle')
					:css('font-style', 'plain')
					:css('font-weight', 'bold')
					:wikitext(string.format('[[Portal:%s|Portal %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.
	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{'ا', 'ب', 'چ', 'ڈ', 'e', 'ف', 'ج', 'خ', 'آ', 'ج', 'ک', 'ل', 'م', 'ن', 'ش', 'پ', 'ق', 'ر', 'س', 'ٹ', 'ث', 'ص', 'ڈ', 'ژ', 'ڑ', 'ڑ', 'دیگر'} do
		images[i] = mw.loadData('Module:Wp/khw/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._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
	-- {{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', 'image', 'imageDupes', 'displayAll'} do
	p[funcName] = makeWrapper('_' .. funcName)
end

return p