Module:Switzerland by canton category navigation

File:Test Template Info-Icon - Version (2).svg Module documentation[create] [purge]

You might want to create a documentation page for this Scribunto module.
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this module.

--[[
	v01.18: fix handling of definite article (e.g. for 'the Northwest Territories')
	2.0 Resolve category redirects

 each title consists of three parts
    * prefix
    * canton name
    * suffix
 e.g. "Foo in Aargau"
    * prefix = "Foo in "
    * canton name = "Aargau"
    * suffix = ""
 e.g. "Appenzell Ausserrhoden-related lists"
    * prefix = ""
    * canton name = "Appenzell Ausserrhoden"
    * suffix = "-related lists"
]]

-- config
local textSize = '90%'
local tableClass="toc"
local evenRowStyle = "vertical-align:top; background-color:#f3f3f3;"
local oddRowStyle = "vertical-align:top;"
local labelStyle = "text-align:right; font-weight: bold; padding: 0.25em 0.5em 0.25em 0.5em;"
local listStyle = "text-align:left; font-weight: normal; padding: 0.25em 0.5em 0.25em 0.5em;"
local greyLinkColor = "#888"
--[[ Note that the table styles are designed to ensure that the navbox is as wide as possible, while still leaving
     enough enough space on the right for portal boxes, commons links, and GeoGroup templates.
     A lot of fiddling was needed to make it work, so please test any changes very carfully in the sandbox.
]]
local tableFallbackMaxWidth="auto"
local tableMaxWidth="calc(100% - 25em)" -- Template:GeoGroup has width: 23em<
-- local tableStyle="margin-left:0; margin-right:auto; clear:left !important; margin-top:0 !important; float:left; width:auto;"
local tableStyle="margin-left:0; margin-right:auto; clear:left !important; margin-top:0 !important; width:auto;"

-- Templates which are allowed to call this module
local callingTemplates = {
	'Template:Switzerland by canton category navigation',
}

-- globals for this module
local debugging = false
local debugmsg = ""
local tableRowNum = 0
local title_prefix = ""
local title_suffix = ""
local title_prefix
local title_suffix
local thisPageCanton
local greyLinkCount = 0
local blueLinkCount = 0
local parentname = ""
local templateName

local horizontal = require('Module:List').horizontal
local getArgs = require('Module:Arguments').getArgs
local yesno = require('Module:Yesno')
local ResolveCategoryRedirect = require('Module:Resolve category redirect').rtarget
local p = {}

--[[
	Plain text list of cantons
	* Each entry exactly as it appears in running text in category titles, with any prefix (e.g. "the")
	* Be sure to avoid hidden characters and duplicate spaces. They break the pattern-matching on which this module relies
]]
local SwitzerlandCantons = {
	'Aargau',
	'Appenzell Ausserrhoden',
	'Appenzell Innerrhoden',
	'Basel-Landschaft',
	'Basel-Stadt',
	'the canton of Bern',
	'the canton of Fribourg',
	'the canton of Geneva',
	'the canton of Glarus',
	'the Grisons',
	'the canton of Jura',
	'the canton of Lucerne',
	'the canton of Neuchâtel',
	'Nidwalden',
	'Obwalden',
	'the canton of Schaffhausen',
	'the canton of Schwyz',
	'the canton of Solothurn',
	'the canton of St. Gallen',
	'Thurgau',
	'Ticino',
	'the canton of Uri',
	'Valais',
	'Vaud',
	'the canton of Zug',
	'the canton of Zurich'
}
local SwitzerlandTheCantons = {
	'Canton of Bern',
	'Canton of Fribourg',
	'Canton of Geneva',
	'Canton of Glarus',
	'Canton of Jura',
	'Canton of Lucerne',
	'Canton of Neuchâtel',
	'Canton of Schaffhausen',
	'Canton of Schwyz',
	'Canton of Solothurn',
	'Canton of St. Gallen',
	'Canton of Uri',
	'Canton of Zug',
	'Canton of Zurich'
}

-- If the page title matches any of these Lua patterns, treat it as a false positive 
local falsePositiveChecks = {
}

local function publishDebugLog()
	if not debugging then
		return ""
	end
	return "==Debugging ==\n\n" .. debugmsg .. "\n== Output ==\n"
end

-- debugLog builds a log which can be output if debuging is enabled
-- each log entry is given a level, so that the output is not simply a flat list
-- a debug msg may be appended to the previous msg by setting the level to nil
local function debugLog(level, msg)

	if (debugmsg == nil) then
		debugmsg = ""
	end

	if (level ~= nil) then
		-- not appending, so make a new line
		debugmsg = debugmsg .. "\n"
		-- then add the level
		local i
		for i = 1, level do
			if (i % 2) == 1 then
				debugmsg = debugmsg .. "#"
			else
				debugmsg = debugmsg .. "*"
			end
		end 
	end
	debugmsg = debugmsg .. " " .. msg
	return true
end

local function makeTrackingCategory()
	-- discount the current page, which will always be coded as a blue link, but rendered as bold un-navigable
	blueLinkCount = blueLinkCount - 1
	if greyLinkCount == 0 then
		return "[[Category:" .. templateName .. " with no grey links|" .. mw.title.getCurrentTitle().text .. "]]"
	end
	if blueLinkCount == 0 then
		return "[[Category:" .. templateName .. " with all grey links|" .. mw.title.getCurrentTitle().text .. "]]"
	end
	if  greyLinkCount <= 5 then
		return "[[Category:" .. templateName .. " with 1–5 grey links|" .. mw.title.getCurrentTitle().text .. "]]"
	end
	if  greyLinkCount > 20 then
		return "[[Category:" .. templateName .. " with 21 or more grey links|" .. mw.title.getCurrentTitle().text .. "]]"
	end
	if  greyLinkCount > 5 then
		return "[[Category:" .. templateName .. " with 6–20 grey links|" .. mw.title.getCurrentTitle().text .. "]]"
	end
	return ""
end

-- Make a piped link to a category, if it exists
-- If it doesn't exist, just display the greyed the link title without linking
local function makeCatLink(catname, disp)
	local displaytext
	if (disp ~= "") and (disp ~= nil) then
		-- use 'disp' parameter, but strip any trailing disambiguator
		displaytext = mw.ustring.gsub(disp, "%s+%(.+$", "");
		-- also strip any leading word "the"
		displaytext = mw.ustring.gsub(displaytext, "^[tT]he%s+", "");
		-- also strip any leading word "canton of"
		displaytext = mw.ustring.gsub(displaytext, "^[cC]anton%sof%s+", "");
	else
		displaytext = catname
	end
	local fmtlink
	local catPage = mw.title.new( catname, "Category" )
	if (catPage.exists) then
		fmtlink = "[[:Category:" .. catname .. "|" .. displaytext .. "]]"
		blueLinkCount = blueLinkCount + 1
	else
		fmtlink = '<span style="color:' .. greyLinkColor .. '">' .. displaytext .. "</span>"
		greyLinkCount = greyLinkCount + 1
	end

	return fmtlink
end

local function makeCatName(cantonName, prefix, suffix)
	local thisCatName = prefix .. cantonName .. suffix
	debugLog(5, "thisCatName = [" .. thisCatName .. "]")
	--[[
		Now check whether the all following conditions are true
			1/ the cantonName begins with "the"
			2/ the category does NOT exist if we use "the "
			3/ the category does exist if we strip "the "
		 If those conditions are all true, them strip "the" 
	]] 
	if (mw.ustring.match(cantonName, "^[tT]he ") ~= nil) then
		debugLog(6, "CantonName begins with 'the'")
		local cantonNameStripped = mw.ustring.gsub(cantonName, "^[tT]he ", "", 1)
		local thisCatNameStripped = prefix .. cantonNameStripped .. suffix
		debugLog(6, "thisCatNameStripped = [" .. thisCatNameStripped .. "]")
		local testCatPage = mw.title.new(thisCatName, "Category" )
		local testCatPageStripped = mw.title.new(thisCatNameStripped, "Category" )
		if not testCatPage.exists then
			debugLog(7, "[" .. testCatPage.fullText .. "] .. does not exist") 
			if (testCatPageStripped.exists) then
				debugLog(7, "[" .. testCatPageStripped.fullText .. "] .. DOES exist, so use that") 
				return thisCatNameStripped
			end
		end
	end
	return thisCatName
end

local function makeTableRow(rowLabel, cantonList)
	debugLog(2, "makeTableRow, label: ")
	if (rowLabel == nil) then
		rowLabel = "By&nbsp;canton"
		debugLog(nil, rowLabel)
	else
		rowLabel = mw.text.trim(rowLabel)
		debugLog(nil, " [" .. rowLabel .. "]")
	end
	tableRowNum = tableRowNum + 1
	local thisRow
	if (tableRowNum % 2) == 0 then
		debugLog(3, "Even-numbered")
		thisRow = '<tr style="' .. evenRowStyle .. '">\n'
	else
		debugLog(3, "Odd-numbered")
		thisRow = '<tr style="' .. oddRowStyle .. '">\n'
	end
	if not ((rowLabel == nil) or (rowLabel =="")) then
		thisRow = thisRow .. '<td style="' .. labelStyle .. '">' .. rowLabel .. '</td>\n'
	end
	-- now begin making the row contents
	debugLog(3, "Process cantonList")
	local list_args = {}
	for i, aCanton in ipairs(cantonList) do
		debugLog(4, "No. " .. tostring(i) .. ": [" .. aCanton .. "]")
		myCatName = ResolveCategoryRedirect(makeCatName(aCanton, title_prefix, title_suffix))
		table.insert(list_args, makeCatLink(myCatName, aCanton))
	end
	return thisRow .. '<td style="' .. listStyle .. ';">' .. horizontal(list_args) .. '</td>\n</tr>'
end

local function makeTable()
	debugLog(1, "makeTable")
	tableRowNum = 0
	local myTable = '<table class="' .. tableClass .. '"'
	myTable = myTable .. ' style="' .. tableStyle .. '; font-size:' .. textSize .. '; max-width:' .. tableFallbackMaxWidth .. '; max-width:' .. tableMaxWidth ..'">\n'

	myTable = myTable .. makeTableRow(nil, SwitzerlandCantons)
	myTable = myTable .. "</table>\n"
	return myTable
end

local function patternSearchEncode(s)
	return mw.ustring.gsub(s, "([%W])", "%%%1")
end

-- Does the pagename include a canton name?
local function findcantonNameInPagename(pn, cantonList, description)
	local i, aCanton, testCanton
	debugLog(2, "checking [" .. pn .."] for a canton name in canton set: " .. description)
	for i, aCanton in ipairs(cantonList) do
		testCanton = aCanton
		debugLog(3, "testing: ["  .. testCanton .. "]")
		local testCantonEncoded = patternSearchEncode(testCanton)
		-- For efficiency, the first test is a simple match as a a screening test
		-- If the bare canton name is nowhere in the pagename, then no need for
		-- more precise checks
		-- This check would be one line in regex, but Lua pattern matching is cruder,
		--so we need several passes to ensure that any match is of a complete word
		debugLog(4, "simple match? ")
		if (not mw.ustring.match(pn, testCantonEncoded)) then
			debugLog(nil, "Fail")
		else
			debugLog(nil, "Success")

			-- test for false positives
			local j, aFalsePositiveTest
			for j, aFalsePositiveTest in ipairs(falsePositiveChecks) do
				debugLog(5, "false positive test pattern '" .. aFalsePositiveTest .. "' ? ")
				if (mw.ustring.match(pn, aFalsePositiveTest)) then
					debugLog(nil, "Match, so fail")
					return nil
				end
				debugLog(nil, "No match, so OK")
			end

			debugLog(4, "match whole name? ")
			if (pn == testCanton) then
				debugLog(nil, "Yes")
				return testCanton
			end
			debugLog(nil, "No")

			debugLog(4, "match at start, followed by separator? ")
			if mw.ustring.match(pn, "^" .. testCantonEncoded .. "[^%w]") then
				debugLog(nil, "Yes")
				return testCanton
			end
			debugLog(nil, "No")
			
			debugLog(4, "match at end, preceded by separator? ")
			if mw.ustring.match(pn, "[^%w]" .. testCantonEncoded .. "$") then
				debugLog(nil, "Yes")
				return testCanton
			end
			debugLog(nil, "No")

			debugLog(4, "match anywhere, preceded and followed by separator? ")
			if mw.ustring.match(pn, "[^%w]" .. testCantonEncoded .. "[^%w]") then
				debugLog(nil, "Yes")
				return testCanton
			end
			debugLog(nil, "No")

		end
		-- Special case: if the canton name we are testing begins with a prefixed "the"
		debugLog(4, "does testCanton begin with 'the' ? ")
		if (mw.ustring.match(testCanton, "^[tT]he ") == nil) then
			debugLog(nil, "No")
		else
			debugLog(nil, "Yes")
		end
		if (mw.ustring.match(testCanton, "^[tT]he ") ~= nil) then
			local testCantonStripped = mw.ustring.gsub(testCanton, "^[tT]he ", "", 1)
			local testCantonStrippedEncoded = patternSearchEncode(testCantonStripped)
			debugLog(4, "test pattern without leading definite article, i.e. '" .. testCantonStrippedEncoded .. "' ? ")
			if (mw.ustring.match(pn, "[^%w]" .. testCantonStrippedEncoded .. "[^%w]")  ~= nil)
			or (mw.ustring.match(pn, "^" .. testCantonStrippedEncoded .. "[^%w]")  ~= nil)
			or (mw.ustring.match(pn, "[^%w]" .. testCantonStrippedEncoded .. "$")  ~= nil)
			or (mw.ustring.match(pn, "^" .. testCantonStrippedEncoded .. "$")  ~= nil) then
				debugLog(nil, "Yes")
				return testCantonStripped
			end
			debugLog(nil, "No")
		end
	end
	return nil
end

-- parse the pagename to find three parts: prefix, canton name, suffix
local function parsePagename(pn)
	debugLog(1, "parsePagename: [" .. pn .. "]")
	local validcantonName
	validcantonName = findcantonNameInPagename(pn, SwitzerlandCantons, "cantonlst")
	if validcantonName == nil then
	validcantonName = findcantonNameInPagename(pn, SwitzerlandTheCantons, "cantonlst")
	if validcantonName == nil then
		return false
	end
	end
	
	-- if we get here, the page name "pn" includes a validcantonName
	-- so now we need to split the string
	
	debugLog(2, "split pagename around [" .. validcantonName .. "]")
	local validCantonEncoded = mw.ustring.gsub(validcantonName, "([%W])", "%%%1")
	match_prefix, match_canton, match_suffix = mw.ustring.match(pn, "^(.*)(" .. validCantonEncoded .. ")(.*)$")
	
	title_prefix = match_prefix
	title_suffix = match_suffix
	debugLog(2, "parse successful")
	debugLog(3, "title_prefix = [" .. title_prefix .. "]")
	debugLog(3, "thisPageCanton = [" .. match_canton .. "]")
	debugLog(3, "title_suffix = [" .. title_suffix .. "]")
	return true
end

local function getYesNoParam(args, thisParamName, defaultVal)
	local paramVal = args[thisParamName]
	if paramVal == nil then
		paramVal = ""
	end

	debugLog(2, "Evaluate yes/no parameter: [" .. thisParamName .. "] = [" .. paramVal .. "]")
	debugLog(3, "default = " .. ((defaultVal and "Yes") or "No"))
	debugLog(3, "Evaluate as: ")
	local returnValue
	if paramVal == "" then
		returnValue = defaultVal
	else
		returnValue = yesno(args[thisParamName], defaultVal)
	end
	if (returnValue) then
		debugLog(nil, "Yes")
	else
		debugLog(nil, "No")
	end
	return returnValue
end

local function makeErrorMsg(s)
	return '<p class="error">[[' .. parentname .. ']] Error: ' .. s .. '</p>\n'
end

local function isValidParent(p)
	for i, aParent in ipairs(callingTemplates) do
		if p == aParent then
			return true
		end
	end
	return false
end

function p.main(frame)
	local parent = frame:getParent()
	if parent then
		 parentname = parent:getTitle():gsub('/sandbox$', '')
	end

	if (parentname == nil) or not isValidParent(parentname) then
		local errormsg = '<p class="error"> Error: ' .. parentname .. ' is not a valid wrapper for [[' .. frame:getTitle() .. ']]\n'
		errormsg = errormsg .. '<br><br>Valid wrappers: '
		local i, aParent
		for i, aParent in ipairs(callingTemplates) do
			errormsg = errormsg .. '[[' .. aParent  .. ']]'
		end
		errormsg = errormsg .. '</p>'
		return errormsg
	end
	templateName = mw.ustring.gsub(parentname, "^Template:", "")
	
	debugLog(1, "Check parameters")
	debugging = getYesNoParam(frame.args, "debug", false)

	-- get the page title
	thispage = mw.title.getCurrentTitle()
	thispagename = thispage.text;
	
	debugLog(1, "mw.title.getCurrentTitle()")
	debugLog(2, "thispage.text = [" .. thispage.text .."]")
	debugLog(2, "thispage.namespace = [" .. thispage.namespace .."]")
	debugLog(2, "thispage.nsText = [" .. thispage.nsText .."]")
	debugLog(2, "is it a cat? using (thispage:inNamespace(14)): ")
	if not (thispage:inNamespace(14)) then
		debugLog(nil, "No, this is not a category")
		debugLog(1, "Not a category, so no output")
		return makeErrorMsg("only for use on a category page") .. publishDebugLog()
	end
	debugLog(nil, "Yes, this is a category")

	if not parsePagename(thispagename) then
		-- some error parsing the title, so don't proceed to output
		local trackingCatInvalid = "[[Category:" .. templateName .. " on invalid category|" .. mw.title.getCurrentTitle().text .. "]]"
		return makeErrorMsg('the name of this category does not include a valid Swiss canton') .. publishDebugLog() .. trackingCatInvalid
	end
	
	debugLog(1, "all parse done")
	debugLog(2, "title_prefix = [" .. title_prefix .. "]")
	debugLog(2, "title_suffix = [" .. title_suffix .. "]")
	
	local myNavTable = makeTable()
	debugLog(2, "blueLinkCount = [" .. blueLinkCount .. "]. &nbsp; (NB The current page is always counted as a bluelink, but will not be navigable)")
	debugLog(2, "greyLinkCount = [" .. greyLinkCount .. "]")
	
	if (blueLinkCount <= 1) then
		-- This is a navbar to nowhere, so suppress display
		myNavTable = ""
		debugLog(1, "Zero bluelinks (other than the current page) makes this a navbox to nowhere, so do not display the navbox")
	end
	
	local myTrackingCat = makeTrackingCategory()

	return publishDebugLog() .. myNavTable .. myTrackingCat

end

return p