Modulo:Portalo

El Vikipedio, la libera enciklopedio
Salti al navigilo Salti al serĉilo
Dokumentado Dokumentado


Ŝablona programado Diskutoj Lua Testoj Subpaĝoj
Modulo Esperanto English Deutsch

Modulo: Dokumentado


Se vi havas demandon pri ĉi tiu Lua-modulo, tiam vi povas demandi en la diskutejo pri Lua-moduloj. La Intervikiaj ligiloj estu metataj al Vikidatumoj. (Vidu Helpopaĝon pri tio.)
--[==[ Version from 2014-07-01
-- This modulo is a Lua implementation of the old {{Portal}} template.
-- 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 submodulos of [[Modulo:Portalo/bildoj]], listed below:
-- [[Modulo:Portalo/bildoj/a]]       - por portalnomoj komencante kun "A".
-- [[Modulo:Portalo/bildoj/b]]       - por portalnomoj komencante kun "B".
-- [[Modulo:Portalo/bildoj/c]]       - por portalnomoj komencante kun "C".
-- [[Modulo:Portalo/bildoj/d]]       - por portalnomoj komencante kun "D".
-- [[Modulo:Portalo/bildoj/e]]       - por portalnomoj komencante kun "E".
-- [[Modulo:Portalo/bildoj/f]]       - por portalnomoj komencante kun "F".
-- [[Modulo:Portalo/bildoj/g]]       - por portalnomoj komencante kun "G".
-- [[Modulo:Portalo/bildoj/h]]       - por portalnomoj komencante kun "H".
-- [[Modulo:Portalo/bildoj/i]]       - por portalnomoj komencante kun "I".
-- [[Modulo:Portalo/bildoj/j]]       - por portalnomoj komencante kun "J".
-- [[Modulo:Portalo/bildoj/k]]       - por portalnomoj komencante kun "K".
-- [[Modulo:Portalo/bildoj/l]]       - por portalnomoj komencante kun "L".
-- [[Modulo:Portalo/bildoj/m]]       - por portalnomoj komencante kun "M".
-- [[Modulo:Portalo/bildoj/n]]       - por portalnomoj komencante kun "N".
-- [[Modulo:Portalo/bildoj/o]]       - por portalnomoj komencante kun "O".
-- [[Modulo:Portalo/bildoj/p]]       - por portalnomoj komencante kun "P".
-- [[Modulo:Portalo/bildoj/q]]       - por portalnomoj komencante kun "Q".
-- [[Modulo:Portalo/bildoj/r]]       - por portalnomoj komencante kun "R".
-- [[Modulo:Portalo/bildoj/s]]       - por portalnomoj komencante kun "S".
-- [[Modulo:Portalo/bildoj/t]]       - por portalnomoj komencante kun "T".
-- [[Modulo:Portalo/bildoj/u]]       - por portalnomoj komencante kun "U".
-- [[Modulo:Portalo/bildoj/v]]       - por portalnomoj komencante kun "V".
-- [[Modulo:Portalo/bildoj/w]]       - por portalnomoj komencante kun "W".
-- [[Modulo:Portalo/bildoj/x]]       - por portalnomoj komencante kun "X".
-- [[Modulo:Portalo/bildoj/y]]       - por portalnomoj komencante kun "Y".
-- [[Modulo:Portalo/bildoj/z]]       - por portalnomoj komencante kun "Z".
-- [[Modulo:Portalo/bildoj/alia]]   - por portalnomoj komencante kun any alia letters. This includes numbers,
--                                    letters with diacritics, and letters in non-Latin alphabets.
-- [[Modulo:Portalo/bildoj/alternativaj nomoj]] - 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 bildoj data pages are separated by the first letter to reduce server load when bildoj are added, changed, or removed.
-- Previously all the images were on one data page at [[Modulo:Portalo/bildoj]], but this had the disadvantage that all
-- 5,000,000 pages using this modulo needed to be refreshed every time an image was added or removed.

-- The colors for the background are in the following submodule:
-- [[Modulo:Portalo/koloroj]]
]==]

local htmlBuilder = require('Modulo:HtmlBuilder')

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, '^[a-z]') then
		imagePage = 'Modulo:Portalo/bildoj/' .. firstLetter
	else
		imagePage= 'Modulo:Portalo/bildoj/alia'
	end
	local images = mw.loadData(imagePage)
	local image = images[s]
	if image then
		return image
	end
end

local function getAlias(s)
	-- Gets an alias from the image alias data page.
	local aliasData = mw.loadData('Modulo:Portalo/bildoj/alternativaj nomoj')
	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)
	local image = matchImagePage(s)
	if image then
		return image
	else
		local alias = getAlias(s)
		image = matchImagePage(alias) -- If no alias was found this returns nil.
		if image then
			return image
		else
			return 'Portal-puzzle.svg'
		end
	end
end

-- for colors
local function matchColorPage(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 colorPage
--	if mw.ustring.find(firstLetter, '^[a-z]') then
--		colorPage = 'Modulo:Portalo/koloroj/' .. firstLetter
--	else
--		colorPage= 'Modulo:Portalo/koloroj/alia'
--	end  
	colorPage = 'Modulo:Portalo/koloroj'
	local colors = mw.loadData(colorPage)
	local color = colors[s]
	if color then
		return color
	end
end

local function getColorName(s)
	-- Gets the image name for a given string.
	if type(s) ~= 'string' or #s < 1 then
		return '#B9B9B9'
	end
	s = mw.ustring.lower(s)
	local color = matchColorPage(s)
	if color then
		return color
	else
		local alias = getAlias(s)
		color = matchColorPage(alias) -- If no alias was found this returns nil.
		if color then
			return color
		else
			return '#B9B9B9'
		end
	end
end

function p._portal(portals, args)
	-- This function builds the portal box used by the {{portal}} template.
	-- translation of parameters in Esperanto into English ones
	if args.maldekstre == "jes" and (args.left == nil or args.left =="") then
		args.left = "yes"
	end
	if args["marĝeno"] ~= ""  and args["marĝeno"] ~= nil and (args.margin == nil or args.margin == "") then
		args.margin = args["marĝeno"]
	end
	if args["kestolarĝo"] ~= "" and args["kestolarĝo"] ~= nil and (args.boxsize == nil or args.boxsize =="") then
		args.boxsize = args["kestolarĝo"]
	elseif args["larĝo"] ~= "" and args["larĝo"] ~= nil and (args.boxsize == nil or args.boxsize =="") then	
		args.boxsize = args["larĝo"]
	end
	if args.linisalto ~= "" and args.linisalto ~= nil and (args['break'] == nil or args['break'] =="") then
		args['break'] = args.linisalto
	end
	local root = htmlBuilder.create('div')
	root
		.addClass('noprint')
		.addClass(args.left and 'tleft' or 'tright')
		.addClass('portal')
		.css('border', 'solid #aaa 1px')
		.css('text-align', 'center')
		.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:Portal]].
	local tableroot = root.tag('table')
		.css('background', '#f9f9f9')
		.css('font-size', '90%')
		.css('line-height', '110%')
		.css('max-width', '210px')
		.css('width', type(args.boxsize) == 'string' and (args.boxsize .. 'px'))
		.css('padding', '1ex')
	
	-- 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">Neniuj portaloj difinitaj: bonvolu difini almenaŭ unu portalon</strong>[[Kategorio:Portalaj ŝablonoj sen parametro]]')
	end
	
	-- some variables for variant
	    local variant = args.varianto or args.variant
	    -- local text
	    if variant == "longa" or variant == "long" then 
	    	text = "'''Rilataj artikoloj troviĝas en'''  <br />"
	    else
	    	text = ""
	    end	

	-- Display the portals specified in the positional arguments.
	for i, portal in ipairs(portals) do
		local image = getImageName(portal)
	    local color = getColorName(portal)	
	    -- image from the user, per index i
	    local userimage = args['bildo' .. i] or args['image' .. i]
	    if userimage ~= "" and userimage ~= nil then
	    	image = userimage
	    end
	    -- color from the user, per index i
	    local usercolor = args['koloro' .. i] or args['color' .. i]
	    if usercolor ~= "" and usercolor ~= nil then
	    	color = usercolor
	    end	   
	    -- image from the user, for portal
	    local userimage2 = args['bildo por ' .. portal]
	    if userimage2 ~= "" and userimage2 ~= nil then
	    	image = userimage2
	    end
	    -- color from the user, for portal
	    local usercolor2 = args['koloro por ' .. portal]
	    if usercolor2 ~= "" and usercolor2 ~= nil then
	    	color = usercolor2
	    end		    
		-- Generate the html for the image and the portal name.
		tableroot
			.newline()
			.tag('tr')
				.attr('valign', 'middle')
				.tag('td')
					.css('text-align', 'center')
					.wikitext(mw.ustring.format('[[Dosiero:%s|32x28px|alt=Portala ikono]]', image))
					.done()
				.tag('td')
					-- .css('padding', '0 0.2em')
					.css('padding', '0 1ex')
					.css('vertical-align', 'middle')
					.css('font-style', 'italic')
					.css('font-weight', 'bold')
					.wikitext(mw.ustring.format('%s[[Portalo:%s|<span style="color:white; padding:0.5px .7ex; display: block; background: ' .. color .. '">Portalo pri %s%s</span>]]', text, portal, args['break'] and '<br />' or ' ', portal))
	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 = {}
	--local subpages = {'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', 'alia'}
	local subpages = {'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'r', 's', 't', 'u', 'v', 'z', 'alia'}
	for i, subpage in ipairs(subpages) do
		table.insert(images, mw.loadData('Modulo:Portalo/bildoj/' .. subpage))
	end
	return images
end

function p._displayAll(portals, args)
	-- This function displays all portals that have portal bildoj. This function is for maintenance purposes and should not be used in
	-- articles, for two reasons: 1) there are over 1500 portals with portal bildoj, and 2) the modulo doesn't record how the portal
	-- names are capitalized, so the portal links may be broken.
	local lang = mw.language.getContentLanguage()
	local images = getAllImageTables()
	local count = 1
	for i, imageTable in ipairs(images) 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 bildoj. If duplicate bildoj 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 bildoj that
	-- should be moved to a portal alias for ease of maintenance.
	local exists, dupes = {}, {}
	local images = getAllImageTables()
	for i, imageTable in ipairs(images) do
		for portal, image in pairs(imageTable) do
			if not exists[image] then
				exists[image] = portal
			else
				table.insert(dupes, mw.ustring.format('La dosiero "[[:File:%s|%s]]" estas uzata por ambaŭ portaloj "%s" kaj "%s".', image, image, exists[image], portal))
			end
		end
	end
	if #dupes < 1 then
		return 'Neniu duplikata dosiero trovita.'
	else
		return 'La sekvaj duplikataj dosieroj estis trovitaj:\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 alia 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 modulo.
		local origArgs
		if frame == mw.getCurrentFrame() 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

local funcNames = {'portal', 'image', 'imageDupes', 'displayAll'}

for _, funcName in ipairs(funcNames) do
	p[funcName] = makeWrapper('_' .. funcName)
end

return p