Module:Sandbox/BrandonXLF/1

Module documentationviewedithistorypurge

Parameters

(floor#) - Sets the name of a floor

(floor#)_(part#)_(param) - Sets a parameter for a row of a floor where (param) is:

• name - The name of the row, e.g. "Westbound track"
• desc - The description for the row
• Services
  • dir - The direction of the service(s) for the track (right or left)
  • service - The service running on the track
  • service(service#) - Additional services running on the track
  • dest - The destination for the service
  • dest(service#) - Destinations for the additional services
  • note - Note about the services
  • note(service#) - Notes about the additional services
• Platform
  • platform - The type of platform
  • accessible - Set if the platform is accessible
  • note - Note about the platform

The above documentation is transcluded from Module:Sandbox/BrandonXLF/1/doc. (edit | history)
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Subpages of this module.

-- Sandbox, do not delete

require('strict')

local p = {}

-- Parameters that can be numbered
local numeredParams = {
	service = true,
	dest = true,
	note = true
}

-- Labels for platform types
local platformLabels = {
	island = 'Island platform',
	top = 'Side platform',
	bottom = 'Side platform'
}

-- Generate the HTML to display a service
local function displayService(service, dest, note, dir)
	if not service then return '' end
	
	return '<div class="service">' ..
		'<div class="' .. (dir ~= 'left' and 'hidden' or '') .. '">←</div>' ..
		'<div>' .. service .. (dest and ' toward ' .. dest or '') .. (note and ' ' .. note or '') .. '</div>' ..
		(dir == 'right' and '<div>→</div>' or '') ..
	'</div>'
end

-- Generate the HTML to display a track (one or more services)
local function displayTrack(floorPart)
	if not floorPart.service then
		return ''
	end
	
	floorPart.dest = floorPart.dest or {}
	floorPart.note = floorPart.note or {}
	
	local out = ''
	
	for i = 1, floorPart.service.max do
		out = out .. displayService(floorPart.service[i], floorPart.dest[i], floorPart.note[i], floorPart.dir)
	end
	
	return out
end

-- Generate the HTML to generate a "row" of the floor
local function displayFloorPart(floorPart, floorNum, partNum)
	local out = ''
	
	if floorPart.name then
		return '<div class="track"><div>' .. floorPart.name .. '</div></div>' ..
			'<div class="track"><div class="desc"><div>' .. (floorPart.desc or '') .. '</div>' .. displayTrack(floorPart) .. '</div></div>'
	end
	
	if floorPart.platform then
		if not platformLabels[floorPart.platform] then
			return '<div class="part-error">Invalid platform type!</div>'
		end
		
		return '<div class="platform ' .. floorPart.platform .. '">' ..
			platformLabels[floorPart.platform] ..
			(floorPart.accessible and ' ' .. mw.getCurrentFrame():expandTemplate{ title = 'access icon' } or '') ..
			(floorPart.note and ', ' .. floorPart.note or '') ..
		'</div>'
	end 

	local prefix = floorNum .. '_' .. partNum .. '_'
	
	return '<div class="part-error">Invalid floor part! Must have either <code>' .. prefix .. 'name</code> or <code>' .. prefix .. 'platform</code></div>.'
end

-- Generate the HTML to display a floor
local function displayFloor(stationFloor, num, last)
	local out = '<div class="floor' .. (last and ' last' or '') .. '" style="grid-row: span ' .. stationFloor.count .. ';">' .. stationFloor.letter .. '</div>'

	for i = 1, stationFloor.max do
		out = out .. displayFloorPart(stationFloor[i], num, i)
	end
	
	return out
end

-- Create a table that can hold numbered arguments
local function createArgTable(tbl)
	tbl = tbl or {}
	
	tbl.max = 0
	tbl.count = 0
	
	return tbl
end

-- Add an argument number to a table of numbered arguments
local function addArg(tbl, num, value)
	if num > tbl.max then
		tbl.max = num
	end
	
	if not tbl[num] then
		tbl[num] = value
		tbl.count = tbl.count + 1
	end
end
	
-- Process an argument with the format level_part_param[paramNum]
local function processArg(out, level, part, param, paramNum, value)
	level = tonumber(level)
	part = tonumber(part)
	paramNum = paramNum and tonumber(paramNum) or 1
	
	addArg(out, level, createArgTable())
	addArg(out[level], part, {})
	
	if numeredParams[param] then
		if not out[level][part][param] then
			out[level][part][param] = createArgTable()
		end
		
		addArg(out[level][part][param], paramNum, value)
	else
		out[level][part][param] = value
	end
end
	
-- Process the argument table
local function processArgs(args)
	local out = createArgTable()
	
	for i, v in pairs(args) do
		if type(i) == 'number' then
			addArg(out, i, createArgTable({ letter = v }))
		else
			local level, part, param, paramNum = i:match('(%d+)_(%d+)_([^%d]+)(%d*)')
			
			if level and part and param then
				processArg(out, level, part, param, paramNum, v)
			end
		end
	end
	
	return out
end

-- Main function, called by wikitext
function p.main(frame)
	local sortedArgs = processArgs(frame.args)
	local out = frame:extensionTag{
		name = 'templatestyles',
		args = { src = 'User:BrandonXLF/styles.css' }
	}
	
	out = out .. '<div class="station-layout">'
	
	for i = 1, sortedArgs.max do
		out = out .. displayFloor(sortedArgs[i], i, i == sortedArgs.max)
	end
	
	return out .. '</div>'
end

return p