Module:Top icons

From Old School RuneScape Wiki
Jump to navigation Jump to search
Module documentation
This documentation is transcluded from Module:Top icons/doc. [edit] [history] [purge]
Module:Top icons's function main is invoked by Template:External.
Module:Top icons is required by Module:Update.

This module is used in Template:External to generate the top icons. It can also be called from other modules using its helper function.

This module is a helper module to be used by other modules; it may not be designed to be invoked directly. See RuneScape:Lua/Helper modules for a full list and more information.

ModuleFunctionTypeUse
Top icons_main(args)StringReturns a string that adds top icons to the page. args must be a table of arguments. Numbered arguments must have values of rs, rsc, meta or wp. To provide a specific pagename on the top icon link, specify named arguments with those same indices, with the value being the external pagename.

local p = {}

local sites = {
	rsc = {
		format = 'The RuneScape Classic Wiki also has an article on: [[classicrsw:%s]]',
		params = { 'rsc', 'classic', 'c' },
		abbr = 'CS',
		title = 'The RuneScape Classic Wiki also has an article on %s.',
		},
	rs = {
		format = 'The RuneScape Wiki also has an article on: [[rsw:%s]]',
		params = { 'runescape', 'rs', 'rsw', 'rs3' },
		abbr = 'RuneScape',
		title = 'The RuneScape Wiki also has an article on %s.',
		},
	wp = { 
		format = 'Wikipedia also has an article on: [[wikipedia:%s]]',
		params = { 'wikipedia', 'wp', 'w' },
		abbr = 'Wikipedia',
		title = 'Wikipedia also has an article on %s.',
		},
	wg = {
		format = '[[meta:%s]]',
		params = { 'meta', 'wg' },
		abbr = 'Weird Gloop',
		title = 'The Weird Gloop meta wiki also has an article on %s.',
		},
	}

local order = { 'rs', 'rsc', 'wp', 'wg' }

local allparams = {}

function p.main(frame)
	local args = frame:getParent().args
	return p._main(args)
end

function p._main(args)
	local pagename = mw.title.getCurrentTitle().fullText
	local vals = {}
	-- create allparams
	for s,t in pairs(sites) do
		for _,v in ipairs(t.params) do
			allparams[v] = s
		end
	end
	
	-- loop named params
	for i,v in pairs(allparams) do
		if args[i] and not vals[v] then
			vals[v] = args[i]
		end
	end
	
	-- loop unnamed params
	local i = 1
	local v
	while args[i] do
		v = allparams[args[i]] 
		if v and not vals[v] then
			vals[v] = pagename
		end
		i = i + 1
	end
	
	local ret = mw.html.create('div')
	ret:addClass('rs-external-header-links'):css('display', 'none')
	for _,v in ipairs(order) do
		if vals[v] then
			local span = ret:tag('span')
			span:wikitext(string.format(sites[v].format, vals[v]))
				:addClass('rs-header-icon rs-header-icon-'..v)
				:attr({
						['data-title'] = string.format(sites[v].title, vals[v]),
						['data-site'] = v,
						['data-text'] = sites[v].abbr,
					})
		end
	end

	return tostring(ret)	
end

return p