Module:Infobox

From Fortnite Wiki
Jump to: navigation, search

Documentation[purge]

This module has been adapted from Wowpedia. See {{infobox}} for use.

About


--from https://en.wikipedia.org/wiki/Module:Infobox
--and https://wow.gamepedia.com/Module:Infobox
--
-- This module implements {{Infobox}}
--

local p = {}

local args = {}
local origArgs
local root

function union(t1, t2)
	-- Returns the union of the values of two tables, as a sequence.
	local vals = {}
	for k, v in pairs(t1) do
		vals[v] = true
	end
	for k, v in pairs(t2) do
		vals[v] = true
	end
	local ret = {}
	for k, v in pairs(vals) do
		table.insert(ret, k)
	end
	return ret
end

local function getArgNums(prefix)
	-- Returns a table containing the numbers of the arguments that exist
	-- for the specified prefix. For example, if the prefix was 'data', and
	-- 'data1', 'data2', and 'data5' exist, it would return {1, 2, 5}.
	local nums = {}
	for k, v in pairs(args) do
		local num = tostring(k):match('^' .. prefix .. '([1-9]%d*)$')
		if num then table.insert(nums, tonumber(num)) end
	end
	table.sort(nums)
	return nums
end
function split(str, delim, maxNb)
	-- Eliminate bad cases...
	if string.find(str, delim) == nil then
		return { str }
	end
	if maxNb == nil or maxNb < 1 then
		maxNb = 0 -- No limit
	end
	local result = {}
	local pat = '(.-)' .. delim .. '()'
	local nb = 0
	local lastPos
	for part, pos in string.gfind(str, pat) do
		nb = nb + 1
		result[nb] = part
		lastPos = pos
		if nb == maxNb then
			break
		end
	end
	-- Handle the last field
	if nb ~= maxNb then
		result[nb + 1] = string.sub(str, lastPos)
	end
	return result
end
function formatList(csv)
	for k, v in pairs(csv) do
		csv[k] = string.format('[[%s]]', v)
	end
	return csv
end
local function addRow(rowArgs)
	-- Adds a row to the infobox, with either a header cell
	-- or a label/data cell combination.
	if rowArgs.header then
		root
		:tag('tr')
		:addClass(rowArgs.rowclass)
		:tag('th')
		:attr('colspan', 2)
		:addClass(rowArgs.class)
		:addClass('infoboxdetails')
		:cssText(args.headerstyle)
		:wikitext(rowArgs.header)
	elseif rowArgs.image then
		if not rowArgs.caption then
			root
			:tag('tr')
			:addClass(rowArgs.imagerowclass)
			:tag('td')
			:attr('colspan', 2)
			:addClass(rowArgs.imageclass)
			:addClass('infoboxfieldimage')
			:cssText(args.imagestyle)
			:wikitext(rowArgs.image)
		elseif rowArgs.caption then
			root
			:tag('tr')
			:addClass(rowArgs.imagerowclass)
			:tag('td')
			:attr('colspan', 2)
			:addClass(rowArgs.imageclass)
			:addClass('infoboxfieldimage')
			:cssText(args.imagestyle)
			:wikitext(rowArgs.image)
			:tag('div')
			:addClass('infoboximagecaption')
			:cssText(args.captionstyle)
			:wikitext(rowArgs.caption)
		end
	elseif rowArgs.data then
		local mode = rowArgs.mode
		local row = root:tag('tr')
		row:addClass(rowArgs.rowclass)
		if rowArgs.label then
			row
			:tag('th')
			:attr('scope', 'row')
			:addClass('infoboxfieldname')
			:cssText(args.labelstyle)
			:wikitext(rowArgs.label)
			:done()
		end

		local dataCell = row:tag('td')
		if not rowArgs.label then
			dataCell
			:attr('colspan', 2)
		end
		dataCell
		:addClass(rowArgs.class)
		:cssText(args.datastyle)
		:newline()
		if mode == 'link' then
			dataCell
			:wikitext(string.format('[[%s]]', rowArgs.data))
		elseif mode == 'linklist' then
			dataCell
			:wikitext(table.concat(formatList(split(rowArgs.data, ',')), ',&#32;'))
		else
			dataCell
			:wikitext(rowArgs.data)
		end
	end
end

local function renderTitle()
	if not args.title then return end

	root
	:tag('tr')
	:tag('th')
	:attr('colspan', 2)
	:addClass(args.titleclass)
	:addClass('infoboxname')
	:cssText(args.titlestyle)
	:wikitext(args.title)
end

local function renderBelowRow()
	if not args.below then return end

	root
	:tag('tr')
	:tag('td')
	:attr('colspan', '2')
	:addClass(args.belowclass)
	:cssText(args.belowstyle)
	:newline()
	:wikitext(args.below)
end

local function renderImages()
	if args.image then
		args.image1 = args.image
	end
	if args.caption then
		args.caption1 = args.caption
	end
	local imagenums = getArgNums('image')
	table.sort(imagenums)
	for k, num in ipairs(imagenums) do
		addRow({
			image = args['image' .. tostring(num)],
			caption = args['caption' .. tostring(num)],
			imageclass = args['imageclass' .. tostring(num)],
			imagerowclass = args['imagerowclass' .. tostring(num)]
		})
	end
end

local function renderRows()
	-- Gets the union of the header and data argument numbers,
	-- and renders them all in order using addRow.
	local rownums = union(getArgNums('header'), getArgNums('data'))
	table.sort(rownums)
	for k, num in ipairs(rownums) do
		addRow({
			header = args['header' .. tostring(num)],
			label = args['label' .. tostring(num)],
			data = args['data' .. tostring(num)],
			mode = args['mode' .. tostring(num)],
			class = args['class' .. tostring(num)],
			rowclass = args['rowclass' .. tostring(num)]
		})
	end
end

local function renderTrackingCategories()
	if args.decat ~= 'yes' then
		if #(getArgNums('data')) == 0 and mw.title.getCurrentTitle().namespace == 0 then
			root:wikitext('[[Category:Articles which use infobox templates with no data rows]]')
		end
	end
end

local function _infobox()
	-- Specify the overall layout of the infobox
	root = mw.html.create('table')
	root
	:addClass(args.bodyclass)
	:cssText(args.bodystyle)
	if args.minibox == "true" then
		root
		:addClass('miniinfoboxtable')
	else
		root
		:addClass('infoboxtable')
	end
	if args.rarityclass then
		root
		:addClass('infobox'.. args.rarityclass)
	end

	renderTitle()
	renderImages()
	renderRows()
	renderBelowRow()
	renderTrackingCategories()

	return tostring(root)
end

local function preprocessSingleArg(argName)
	-- If the argument exists and isn't blank, add it to the argument table.
	-- Blank arguments are treated as nil to match the behaviour of ParserFunctions.
	if origArgs[argName] and origArgs[argName] ~= '' then
		args[argName] = origArgs[argName]
	end
end

local function preprocessArgs(prefixTable, step)
	-- Assign the parameters with the given prefixes to the args table, in order, in batches
	-- of the step size specified. This is to prevent references etc. from appearing in the
	-- wrong order. The prefixTable should be an array containing tables, each of which has
	-- two possible fields, a 'prefix' string and a 'depend' table. The function always parses
	-- parameters containing the 'prefix' string, but only parses parameters in the 'depend'
	-- table if the prefix parameter is present and non-blank.
	if type(prefixTable) ~= 'table' then
		error('Non-table value detected for the prefix table', 2)
	end
	if type(step) ~= 'number' then
		error('Invalid step value detected', 2)
	end

	-- Get arguments without a number suffix, and check for bad input.
	for i, v in ipairs(prefixTable) do
		if type(v) ~= 'table' or type(v.prefix) ~= 'string' or (v.depend and type(v.depend) ~= 'table') then
			error('Invalid input detected to preprocessArgs prefix table', 2)
		end
		preprocessSingleArg(v.prefix)
		-- Only parse the depend parameter if the prefix parameter is present and not blank.
		if args[v.prefix] and v.depend then
			for j, dependValue in ipairs(v.depend) do
				if type(dependValue) ~= 'string' then
					error('Invalid "depend" parameter value detected in preprocessArgs')
				end
				preprocessSingleArg(dependValue)
			end
		end
	end

	-- Get arguments with number suffixes.
	local a = 1 -- Counter variable.
	local moreArgumentsExist = true
	while moreArgumentsExist == true do
		moreArgumentsExist = false
		for i = a, a + step - 1 do
			for j, v in ipairs(prefixTable) do
				local prefixArgName = v.prefix .. tostring(i)
				if origArgs[prefixArgName] then
					moreArgumentsExist = true -- Do another loop if any arguments are found, even blank ones.
					preprocessSingleArg(prefixArgName)
				end
				-- Process the depend table if the prefix argument is present and not blank, or
				-- we are processing 'prefix1' and 'prefix' is present and not blank, and
				-- if the depend table is present.
				if v.depend and (args[prefixArgName] or (i == 1 and args[v.prefix])) then
					for j, dependValue in ipairs(v.depend) do
						local dependArgName = dependValue .. tostring(i)
						preprocessSingleArg(dependArgName)
					end
				end
			end
		end
		a = a + step
	end
end

function p.infobox(frame)
	if frame == mw.getCurrentFrame() then
		origArgs = require( 'Module:ProcessArgs' ).merge( true )
	else
		frame = mw.getCurrentFrame()
	end

	-- Parse the data parameters in the same order that the old {{infobox}} did, so that
	-- references etc. will display in the expected places. Parameters that depend on
	-- another parameter are only processed if that parameter is present, to avoid
	-- phantom references appearing in article reference lists.
	preprocessSingleArg('child')
	preprocessSingleArg('bodyclass')
	preprocessSingleArg('rarityclass')
	preprocessSingleArg('minibox')
	preprocessSingleArg('subbox')
	preprocessSingleArg('bodystyle')
	preprocessSingleArg('title')
	preprocessSingleArg('titleclass')
	preprocessSingleArg('titlestyle')
	preprocessArgs({
		{prefix = 'image', depend = {'caption', 'imagerowclass'}}
	}, 10)
	preprocessSingleArg('captionstyle')
	preprocessSingleArg('imagestyle')
	preprocessSingleArg('imageclass')
	preprocessArgs({
		{prefix = 'header'},
		{prefix = 'data', depend = {'label', 'mode'}},
		{prefix = 'rowclass'},
		{prefix = 'class'}
	}, 50)
	preprocessSingleArg('headerstyle')
	preprocessSingleArg('labelstyle')
	preprocessSingleArg('datastyle')
	preprocessSingleArg('below')
	preprocessSingleArg('belowclass')
	preprocessSingleArg('belowstyle')
	preprocessSingleArg('decat')

	return _infobox()
end

return p