Module:Redirect template handler

This Lua module is used on approximately 8,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

Module:Redirect template handler is used to facilitate editor-friendly redirect template usage. This module is currently used with episode and fictional characters, elements and locations via Module:Television episode redirect handler and Module:Fiction redirect category handler.

Usage

The module has two entry points setEpisodeRedirect(args) and setFictionalObjectRedirect(args, objectType).

The functions return a {{Redirect category shell}} and a boolean value if the redirect is the primary redirect. If an unknown parameter is used, the module also returns a warning about the usage and adds the page to tracking category.

local redirectTemplateHandler = require('Module:Redirect template handler')
local redirectCategoryShell, mainRedirect = redirectTemplateHandler.setEpisodeRedirect(args)
local redirectCategoryShell, mainRedirect = redirectTemplateHandler.setFictionalObjectRedirect(args, objectType)

Parameter list

Parameter	Explanation	{{R with possibilities}}	{{R printworthy}} or {{R unprintworthy}}
`series_name`	The name of the series article, including disambiguation. Will set the value entered as series which this redirect belongs to.	-	-
`series_name#`	For multiple series starting from the 2nd series in the style of `\|series_name2=`. The name of the series article names, including disambiguation. Will set the values entered as series which this object belongs to.	-	-
`multi_series_name_table`	Multiple series article names, including disambiguation. Will set the values entered as series which this object belongs to. This parameter can only be used from other modules as it requires the parameters to be passed as an args table.	-	-
`parent_series`	Used for scenarios where a series has a short web-based companion series ("minisodes"), and the redirects should be placed in the parent series category.	-	-
`restricted`	Will tag the redirect with: {{R restricted}} and set the value entered as the correct title.	Yes	printworthy
`birth_name`	Only valid for character redirects; Any value will tag the redirect with: {{R from birth name}}.	No	printworthy
`alt_name`	Any value will tag the redirect with: {{R from alternative name}}.	No	printworthy
`former_name`	Any value will tag the redirect with: {{R from former name}}.	No	printworthy
`short_name`	Any value will tag the redirect with: {{R from short name}}.	No	printworthy
`long_name`	Any value will tag the redirect with: {{R from long name}}.	No	printworthy
`sort_name`	Only valid for character redirects; Any value will tag the redirect with: {{R from sort name}}. The value must be two characters. See {{R from sort name}} for more information.	No	printworthy
`title_name`	Only valid for character redirects; Any value will tag the redirect with: {{R from name with title}}.	No	unprintworthy
`alt_spelling`	Will tag the redirect with: {{R from alternative spelling}} and set the value entered as the correct spelling to use.	No	unprintworthy
`to_diacritic`	Any value will tag the redirect with: {{R to diacritic}}.	No	unprintworthy
`incorrect_name`	Any value will tag the redirect with: {{R from incorrect name}} and set the `\|primary=` value entered as the correct name to use. If `\|primary=` isn't used, it will instead use the value entered here.	No	unprintworthy
`capitalisation`	Any value will tag the redirect with: {{R from miscapitalisation}} and set the `\|primary=` value entered as the correct capitalisation to use. If `\|primary=` isn't used, it will instead use the value entered here.	No	unprintworthy
`unneeded_dab`	Any value will tag the redirect with: {{R from unnecessary disambiguation}}.	No	unprintworthy
`draft_move`	Any value will tag the redirect with: {{R from move}} and {{R from drafts}}.	No	unprintworthy
`anchor`	Set as default for episode redirects. Any value will tag the redirect with: {{R to anchor}}.	-	-
`section`	Set as default for fictional character, element and location redirects. Any value will tag the redirect with: {{R to section}}.	-	-
`list`	Any value will tag the redirect with: {{R to list entry}}.	-	-
`to_article`	Used for redirects to articles, and not to a specific section of the article.	-	-
`primary`	Will tag the redirect with: {{R avoided double redirect}} and set the value entered as the primary redirect.	-	-
`merge`	Any value will tag the redirect with: {{R from merge}}.	-	-
`history`	Any value will tag the redirect with: {{R with history}}.	-	-
`dab_exception`	Any value will set the current disambiguation used as correct, regardless if it follows a standard style. See note below.	-	-
`correct_disambiguation`	Value will be used for disambiguation validation. Should be used if the disambiguation is different than the series name, such as when using a franchise name.	-	-
`test`	Any value will set instruct the function to return only testing validation data. Used in /testcases.	-	-
`test_title`	Value will be used for title validation. Used in /testcases.	-	-

Notes

The redirect will automatically be tagged with {{R from television episode}}, {{R from fictional character}}, {{R from fictional element}}, {{R from fictional location}} or {{R from song}} depending on the type of redirect, and be placed in the relevant category.<section end="Notes-small"/>
Using the series parameters will place the redirect in a series-specific category: [[Category:(series) (object) redirects to lists]], such as Category:Arrow (TV series) character redirects to lists.
If the redirect does not use one of the following correct disambiguation — (series), (series) episode, (series) character, (series) element or (series) character — the redirect will be tagged with {{R from incorrect disambiguation}} and {{R unprintworthy}}.<section begin="Notes-small"/>
If the redirect is using one of the unprintworthy templates, it will be categorized as {{R unprintworthy}}. If not, it will be categorized as {{R printworthy}}.
If the redirect is using one of the templates marked above as not {{R with possibilities}}, it won't be categorized with it.<section end="Notes-small"/><section end="Notes"/>
For episode redirects, a short description will be added only to the primary redirect. Additionally, If |series_name2= (or higher) is used, a short description won't be added.<section end="Notes-episode"/>

Tracking category

Category:Pages using Module:Redirect template handler with unknown parameters (0)

local p = {}

local currentFrame
local redirectTemplateList = {}
local debugTemplateUsedList = {}
local errorList = {
	["MULTI_SERIES"] = "|multi_series_name_table= can only be used in other modules"
}

--[[
Local function which validates parameter usage through Module:Check for unknown parameters.
If calling module has additional valid args that are not part of this module,
it should pass them as a seperate table - "additonalValidArgs".
--]]
local function getUnknownParametersErrors(args, additonalValidArgs)
	local templateName = currentFrame:getParent():getTitle() or "Module:Redirect template handler"
	local validArgs = {
		["unknown"] = "[[Category:Pages using Module:Redirect template handler with unknown parameters|_VALUE_]]",
		["preview"] = 'Page using [[' .. templateName .. ']] with unknown parameter "_VALUE_".',
		"alt_name",
		"alt_spelling",
		"anchor",
		"capitalisation",
		"correct_disambiguation",
		"dab_exception",
		"draft_move",
		"former_name",
		"history",
		"incorrect_name",
		"list",
		"long_name",
		"merge",
		"primary",
		"restricted",
		"section",
		"series_name",
		"short_name",
		"to_article",
		"to_diacritic",
		"unneeded_dab",
	}
	
	-- Add optional series_name2-10 parameters.
	for i = 2, 10 do
		table.insert(validArgs, "series_name" .. i)
	end
	
	-- Safety check.
	if (additonalValidArgs) then
		for i = 1, #additonalValidArgs do
			table.insert(validArgs, additonalValidArgs[i])
		end
	end

	local checkForUnknownParameters = require("Module:Check for unknown parameters")
	return checkForUnknownParameters._check(validArgs, args)
end

--[[
Local function which handles the addition of redirect templates.
--]]
local function addRedirectTemplate(templateName, templateArgs)
	-- Args might already be a table.
	if (type(templateArgs) ~= "table") then
		templateArgs = {templateArgs}
	end

	-- Get the redirect template.
	local redirectTemplate = currentFrame:expandTemplate{title = templateName, args = templateArgs}
	-- Insert it to the redirect template list.
	table.insert(redirectTemplateList, redirectTemplate)
	-- Insert the name only to the debug list.
	table.insert(debugTemplateUsedList, templateName)
end

--[[ 
Local function which retrieves the redirect's correct disambiguation style.
This is needed to check if the current redirect title is using a correct disambiguation or not.
--]]
local function getCorrectDisambiguation(args)
	-- If a correct disambiguation was set, use it.
	if (args.correct_disambiguation) then
		return args.correct_disambiguation
	elseif (args.series_name) then
		-- If not, return the series name without disambiguation.
		local correctDisambiguation = string.gsub(args.series_name, "%(.*%)", "", 1)
		return mw.text.trim(correctDisambiguation)
	else
		-- If no series name was set, return an empty string.
		return ""
	end
end

--[[ 
Local function which retrieves the redirect's current disambiguation, if any.
--]]
local function getDisambiguation(args)
	local title
	if (args.test_title) then
		title = args.test_title
	else
		title = mw.title.getCurrentTitle().text
	end

	local stringMatch = require("Module:String")._match
	-- Return disambiguation.
	return stringMatch(title, "%s%((.-)%)", 1, -1, false, "")
end

--[[ 
Local function which checks if the current disambiguation used
is using a correct disambiguation style.

Returns true if one of the following is correct:
	-- Has no disambiguation.
	-- Disambiguation is equal to a correct disambiguation style.
	-- Disambiguation is equal to an extended correct disambiguation style,
		which includes the type of redirects.
	-- Disambiguation is tagged with an allowed exception.
--]]
local function isRedirectUsingCorrectDisambiguation(args, objectType)
	local disambiguation = getDisambiguation(args)
	local correctDisambiguation = getCorrectDisambiguation(args)
	objectType = objectType or ""

	if (args.dab_exception or 
		(not disambiguation) or 
		(disambiguation == "") or
		(disambiguation == correctDisambiguation) or 
		(disambiguation == correctDisambiguation .. " " .. objectType)
		) then
		return true
	else
		return false
	end
end

--[[ 
Local function which handles all the shared character, element and location redirect handling code.
--]]
local function getRedirectCategoryTemplates(args, objectType)
	local mainRedirect = true
	local printworthy = true

-----------------[[ Printworthy categories ]]-----------------

	-- See [[WP:NCHASHTAG]] for more details.
	-- This redirect can be a main redirect.
	if (args.restricted) then
		addRedirectTemplate("R restricted", args.restricted)
	end
	
	if (args.birth_name) then
		addRedirectTemplate("R from birth name")
		mainRedirect = false
	end

	if (args.alt_name) then
		addRedirectTemplate("R from alternative name")
		mainRedirect = false
	end

	if (args.former_name) then
		addRedirectTemplate("R from former name")
		mainRedirect = false
	end

	if (args.short_name) then
		addRedirectTemplate("R from short name")
		mainRedirect = false
	end

	if (args.long_name) then
		addRedirectTemplate("R from long name")
		mainRedirect = false
	end

	if (args.sort_name) then
		addRedirectTemplate("R from sort name", {string.sub(args.sort_name, 1, 1), string.sub(args.sort_name, 2)})
		mainRedirect = false
	end

-----------------[[ Unprintworthy categories ]]-----------------

	if (args.title_name) then
		addRedirectTemplate("R from name with title")
		printworthy = false
		mainRedirect = false
	end

	if (args.alt_spelling) then
		addRedirectTemplate("R from alternative spelling", args.alt_spelling)
		printworthy = false
		mainRedirect = false
	end

	if (args.to_diacritic) then
		addRedirectTemplate("R to diacritic")
		mainRedirect = false
		printworthy = false
	end

	if (args.incorrect_name) then
		addRedirectTemplate("R from incorrect name", args.primary or args.incorrect_name)
		mainRedirect = false
		printworthy = false
	end

	if (args.capitalisation) then
		addRedirectTemplate("R from miscapitalisation", args.primary or args.capitalisation)
		mainRedirect = false
		printworthy = false
	end

	if (args.unneeded_dab) then
		addRedirectTemplate("R from unnecessary disambiguation")
		mainRedirect = false
		printworthy = false
	end

	if (not isRedirectUsingCorrectDisambiguation(args, objectType)) then
		addRedirectTemplate("R from incorrect disambiguation")
		mainRedirect = false
		printworthy = false
	end

	if (args.draft_move) then
		addRedirectTemplate("R from move")
		addRedirectTemplate("R from drafts")
		mainRedirect = false
		printworthy = false
	end

-----------------[[ Technical categories ]]-----------------

	--[[
	Redirect target can be:
	-- a link to an anchor in a list.
	-- a link to a list, where the redirect is an entry.
	-- an article, for which the redirect is an alt title of. These are not currently categorized.
	-- a section of an article.
	]]--
	if (args.anchor) then
		addRedirectTemplate("R to anchor")
	elseif (args.list) then
		addRedirectTemplate("R to list entry")
	elseif (args.to_article) then
		-- Currently do nothing.
	else
		addRedirectTemplate("R to section")	
	end

	if (args.primary) then
		addRedirectTemplate("R avoided double redirect", args.primary)
		mainRedirect = false
	end

	if (args.merge) then
		addRedirectTemplate("R from merge")
	end
	
	if (args.history) then
		addRedirectTemplate("R with history")
	end

	if (mainRedirect) then
		addRedirectTemplate("R with possibilities")
	end

	if (printworthy) then
		addRedirectTemplate("R printworthy")
	else
		addRedirectTemplate("R unprintworthy")
	end

	return table.concat(redirectTemplateList), mainRedirect
end

--[[ 
Local function which handles the main process.
--]]
local function main(args, objectType, validArgs)
	local redirectCategoryTemplates, mainRedirect = getRedirectCategoryTemplates(args, objectType)
	local redirectCategoryShell = currentFrame:expandTemplate{title = "Redirect category shell", args = {redirectCategoryTemplates}}
	
	local unknownParametersErrors = getUnknownParametersErrors(args, validArgs)
	-- Used for /testcases testing.
	if (args.test) then
		return table.concat(debugTemplateUsedList, ", "), mainRedirect
	else
		return redirectCategoryShell, mainRedirect, unknownParametersErrors
	end
end

--[[ 
Local function which is used when redirects are tagged with more than one series name.
It retrieves the complete lists of series used.
Series entered should be in the style of "series_name#", as in series_name4.
--]]
local function getMultipleSeriesNames(args)
	local seriesArgs = {}
	table.insert(seriesArgs, args.series_name)
	for i = 2, 10 do
		local tvSeries = args["series_name" .. i]
		if (tvSeries) then
			table.insert(seriesArgs, tvSeries)
		end
	end
	table.insert(debugTemplateUsedList, table.concat(seriesArgs, ", "))
	seriesArgs["multi"] = "yes"
	return seriesArgs
end

--[[ 
Entry point for episode redirects.
--]]
function p.setEpisodeRedirect(args, validArgs)
	currentFrame = mw.getCurrentFrame()
	
	-- For scenarios where the redirect is a crossover episode redirect
	-- and it should appear in more than one series category.
	if (args.series_name2) then
		local seriesArgs = getMultipleSeriesNames(args)
		addRedirectTemplate("R from television episode", seriesArgs)
	else
		
		-- For scenarios where a series has a short web-based series ("minisodes"),
		-- and the redirects should be placed in the parent series category.
		-- Creating a seriesName variable here. This is needed since changing
		-- arg.series_name directly affects code in invoking module.
		local seriesName = args.series_name
		if (args.parent_series) then
			seriesName = args.parent_series
		end
		
		addRedirectTemplate("R from television episode", seriesName)
	end
	
	if (not (args.list or args.to_article or args.section)) then
		args.anchor = true
	end
	
	return main(args, "episode", validArgs)
end

--[[ 
Entry point for song redirects.
--]]
function p.setSongRedirect(frame)
	currentFrame = frame
	local getArgs = require("Module:Arguments").getArgs
	local args = getArgs(currentFrame)
	addRedirectTemplate("R from song", "printworthy")

	if (not (args.list or args.to_article or args.section)) then
		args.anchor = true
	end

	local redirectCategoryShell, mainRedirect, unknownParametersErrors = main(args, "song", {})
	if (unknownParametersErrors) then
		return redirectCategoryShell .. unknownParametersErrors
	else
		return redirectCategoryShell
	end
end

--[[ 
Entry point for fictional object redirects.
This includes character, element and location redirects.
--]]
function p.setFictionalObjectRedirect(args, objectType, validArgs)
	currentFrame = mw.getCurrentFrame()

	if (args.multi_series_name_table) then
		-- For scenarios where the redirect is a character that appears in several different series
		-- and it should appear in more than one series category.
		-- This parameter is used by franchise modules which handle multiple series fields.
		if (type(args.multi_series_name_table) == "table") then
			table.insert(debugTemplateUsedList, table.concat(args.multi_series_name_table, ", "))
			addRedirectTemplate("R from fictional " .. objectType, args.multi_series_name_table)
		else
			error(errorList[MULTI_SERIES], 0)
		end
	elseif (args.series_name2) then
		-- For scenarios where the redirect is a character that appears in several different series
		-- and it should appear in more than one series category.
		local seriesArgs = getMultipleSeriesNames(args)
		addRedirectTemplate("R from fictional " .. objectType, seriesArgs)
	else
		addRedirectTemplate("R from fictional " .. objectType, args.series_name)
	end
	
	return main(args, objectType, validArgs)
end

return p

v t e Fiction-related redirects templates
Used on redirects	Episode redirect Character redirect Element redirect Location redirect Arrowverse-specific Character redirect Element redirect Location redirect
Used on categories	Redirects to list entries category handler
Modules	Module:Television episode redirect handler Module:Fiction redirect category handler Franchise Module:Arrowverse redirect category handler Module:Fiction-based redirects to list entries category handler RedirectType Module:Redirect template handler