Module:Category tree/poscatboiler/data/rhymes

Documentation for this module may be created at Module:Category tree/poscatboiler/data/rhymes/documentation

local labels = {}
local raw_categories = {}
local raw_handlers = {}



-----------------------------------------------------------------------------
--                                                                         --
--                                  LABELS                                 --
--                                                                         --
-----------------------------------------------------------------------------


labels["rhymes"] = {
	description = "List of indexes of {{{langname}}} words by their rhymes.",
	umbrella_parents = "Fundamental",
	parents = {{name = "{{{langcat}}}", raw = true}},
}

labels["refractory rhymes"] = {
	description = "Lists of {{{langname}}} words that don't rhyme with other words.",
	umbrella_parents = "Rhymes subcategories by language",
	parents = {"rhymes"},
}



-----------------------------------------------------------------------------
--                                                                         --
--                              RAW CATEGORIES                             --
--                                                                         --
-----------------------------------------------------------------------------


raw_categories["Rhymes subcategories by language"] = {
	description = "Umbrella categories covering topics related to rhymes.",
	additional = "{{{umbrella_meta_msg}}}",
	parents = {
		"Umbrella metacategories",
		{name = "rhymes", is_label = true, sort = " "},
	},
}


raw_categories["Rhymes"] = {
	description = "Umbrella categories covering rhymes by language.",
	additional = "{{{umbrella_meta_msg}}}",
	parents = {
		"Umbrella metacategories",
		{name = "rhymes", is_label = true, sort = " "},
	},
}


-----------------------------------------------------------------------------
--                                                                         --
--                               RAW HANDLERS                              --
--                                                                         --
-----------------------------------------------------------------------------


table.insert(raw_handlers, function(data)
	local function rhymeTopCategory(lang)
		return {
			lang = lang:getCode(),
			description = "Lists of " .. lang:makeCategoryLink() .. " words by their rhymes.",
			additional = "This is an umbrella category. It contains no dictionary entries, but rather possible rhymes as subcategories.",
			parents = {
				"{{{langcat}}}",
				{name = "Rhymes", sort = langname},
			},
			breadcrumb = "Rhymes",
			toctemplateprefix = "rhymetop"
		}
	end
	
	local function linkRhymeIfExists(lang, rhyme) -- {{change new|Though this could be ported to Wikitionary}}
		if mw.title.new('Rhymes:' .. lang:getCanonicalName() .. "/" .. rhyme).exists then
			return "'''[[Rhymes:" .. lang:getCanonicalName() .. "/" .. rhyme ..'|<span class="IPA">-' .. rhyme .. "</span>]]'''"
		end
		return '<span class="IPA">-' .. rhyme .. '</span>'
	end
	
	local function rhymeCategory(lang, rhyme)
		return {
			lang = lang:getCode(),
			description = "List of " .. lang:makeCategoryLink() .. ' words with the rhyme ' .. linkRhymeIfExists(lang, rhyme) .. '.',
			parents = {
				{name = "Rhymes:" .. lang:getCanonicalName(), sort = rhyme},
			},
			breadcrumb = '<span class="IPA">-' .. rhyme .. '</span>',
			displaytitle = 'Rhymes:' .. lang:getCanonicalName() .. '/<span class="IPA">' .. rhyme .. '</span>'
		}
	end
	
	local function rhymeSyllableCountCategory(lang, rhyme, syllableCount)
		return {
			lang = lang:getCode(),
			description = "List of " .. syllableCount .. "-syllable " .. lang:makeCategoryLink() .. ' words with the rhyme ' .. linkRhymeIfExists(lang, rhyme) .. '.',
			parents = {
				{name = "Rhymes:" .. lang:getCanonicalName() .. "/" .. rhyme, sort = syllableCount},
			},
			breadcrumb = tostring(syllableCount) .. " syllables",
			displaytitle = 'Rhymes:' .. lang:getCanonicalName() .. '/<span class="IPA">' .. rhyme .. '</span>/' .. tostring(syllableCount) .. " syllable" .. (syllableCount > 1 and "s" or "")
		}
	end
	
	local langname = data.category:match("^Rhymes:([^/]+)")
	if langname then
		local lang = require("Module:languages").getByCanonicalName(langname)
		if lang then
			local tokens = mw.text.split(data.category, "/")
			if #tokens > 1 then
				local rhyme = tokens[2]
				if #tokens == 3 then
					-- rhyme + syllable count category
					local syllables = nil
					if tokens[3] == "1 syllable" then
						syllables = 1
					else
						local syllablesregex = tokens[3]:match("(%d+) syllables")
						if syllablesregex then
							syllables = tonumber(syllablesregex)
							if syllables < 2 then
								syllables = nil
							end
						end
					end
					if syllables then
						return rhymeSyllableCountCategory(lang, rhyme, syllables)
					end
				elseif #tokens == 2 then
					-- rhyme category
					return rhymeCategory(lang, rhyme)
				end
			else
				-- rhyme language top category
				return rhymeTopCategory(lang)
			end
		end
	end
end)




return {LABELS = labels, RAW_CATEGORIES = raw_categories, RAW_HANDLERS = raw_handlers}