Module:Jcttop/core: Difference between revisions

Module documentation[view] [edit] [history] [purge]

This module implements {{jcttop/core}}.

The above documentation is transcluded from Module:Jcttop/core/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.

local p = {}

local format = mw.ustring.format -- Local version of string formatting function
local HtmlBuilder = require "Module:HtmlBuilder" -- Import module to build HTML code
local getArgs = require('Module:Arguments').getArgs -- Import module function to work with passed arguments

local function hatnote(args)
	local insert = table.insert
	local text = {}
	local tense
	
	insert(text, args.region_note)
	local hatnoteArg = args.hatnote
	if hatnoteArg == 'off' then
		insert(text, '')
	elseif hatnoteArg then
		insert(text, hatnoteArg .. " ")
	else
		local indep_city = args.indep_city
		local sub1 = args.sub1
		local sub2 = args.sub2
		if indep_city or sub1 or sub2 then
			local region = args.region
			local type = args.type or 'route'
			tense = args.former == 'yes'
			local verb = tense and 'was' or 'is'
			insert(text, format("The entire %s %s in ", type, verb))
			if indep_city then
				insert(text, format("[[%s, %s|%s]]", indep_city, region, indep_city))
			else
				local sub1name = args.sub1name
				if sub2 then
					insert(text, "[[" .. sub2)
					local area = args.area
					if area then
						insert(text, format(" (%s)", area))
					end
					local sub1dab = args.sub1dab == 'yes'
					if sub1dab then
						insert(text, format(", %s %s", sub1, sub1name))
					end
					insert(text, format(", %s|%s]]", region, sub2))
				end
				if sub1 and sub2 then
					insert(text, ', ')
				end
				if sub1 then
					insert(text, format("[[%s %s, %s|%s %s]]", sub1, sub1name, region, sub1, sub1name))
				end
			end
		end
		insert(text, '. ')
		insert(text, args.sub1_ref)
		insert(text, args.sub2_ref)
	end
	
	if args.unnum == 'yes' then
		local verb = tense and 'were' or 'are'
		insert(text, format("All exits %s unnumbered.", verb))
	end
	
	return mw.text.trim(table.concat(text))
end

local function header(args)
	local row = HtmlBuilder.create().tag('table', {unclosed = true}).attr('class', 'plainrowheaders wikitable hlist').tag('tr')
	local region_col = args.region_col
	if region_col then
		row.tag('th').attr('scope', 'col').wikitext(region_col)
	end
	
	local nosub1 = args.nosub1 == 'yes'
	local indep_city = args.indep_city
	if not(nosub1 or args.sub1 or indep_city) then
		local tag = row.tag('th').attr('scope', 'col')
		local sub1disp = args.sub1disp
		if sub1disp then
			tag.wikitext(sub1disp)
		else
			tag.wikitext(args.sub1name).wikitext(args.sub1_ref)
		end
	end
	
	if not(args.sub2 or indep_city) then
		local tag = row.tag('th').attr('scope', 'col')
		local location_def = args.location_def or 'Location'
		tag.wikitext(location_def).wikitext(args.sub2_ref)
	end
	
	local altunit = args.altunit
	if altunit then
		row.tag('th').attr('scope', 'col').wikitext(altunit).wikitext(args.altunit_ref)
	else
		local unit = args.length or args.unit
		if unit ~= 'off' then
			row.tag('th').attr('scope', 'col').wikitext(unit).wikitext(args.length_ref).done().tag('th').attr('scope', 'col').wikitext(args.unit2)
		end
	end
	
	local exit = args[1]
	if exit == 'old' then
		local old_def = args.old_def or 'Old exit'
		row.tag('th').attr('scope', 'col').wikitext(old_def).wikitext(args.old_ref)
		local exit_def = args.exit_def or 'New exit'
		row.tag('th').attr('scope', 'col').wikitext(exit_def).wikitext(args.exit_ref)
	elseif exit == 'exit' then
		local exit_def = args.exit_def or 'Exit'
		row.tag('th').attr('scope', 'col').wikitext(exit_def).wikitext(args.exit_ref)
	end
	
	if args[2] == 'name' then
		local name_def = args.name_def or 'Name'
		row.tag('th').attr('scope', 'col').wikitext(name_def).wikitext(args.name_ref)
	end
	
	local dest_def = args.dest_def or 'Destinations'
	row.tag('th').attr('scope', 'col').wikitext(dest_def).wikitext(args.dest_ref)
	
	local notes_def = args.notes_def or 'Notes'
	row.tag('th').attr('scope', 'col').wikitext(notes_def).wikitext(args.notes_ref)
	
	return tostring(row.allDone())
end

function p._jcttop(args)
	-- This function calls two other functions to generate a hatnote and header row.
	-- This function is accessible from other Lua modules.
	return hatnote(args) .. header(args)
end

function p.jcttop(frame)
	-- Entry function for {{jcttop/core}}
	local args = getArgs(frame) -- Gather passed arguments into easy-to-use table.
	return p._jcttop(args) -- Simply call another function with those arguments to actually create the header.
end

return p