Module:Fiction redirect category handler

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

Module:Fiction redirect category handler is used tag a fictional character, element or location redirect with the relevant redirect categories.

Usage

• {{#invoke:Fiction redirect category handler|character}}
• {{#invoke:Fiction redirect category handler|element}}
• {{#invoke:Fiction redirect category handler|location}}

Function list

Function	Explanation
character	Creates a {{Redirect category shell}} with relevant redirects for fictional character redirects.
element	Creates a {{Redirect category shell}} with relevant redirects for fictional element redirects.
location	Creates a {{Redirect category shell}} with relevant redirects for fictional location redirects.

Parameter list

{{#section:Module:Redirect template handler/doc|Parameters}}

Notes

{{#section:Module:Redirect template handler/doc|Notes}}

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

require("strict")

local getArgs = require("Module:Arguments").getArgs

local p = {}

--[[ 
Local function which handles all the shared character, element and location redirect handling code.
--]]
local function main(args, objectType, validArgs)
	local redirectTemplateHandler = require("Module:Redirect template handler")
	local redirectCategoryShell, mainRedirect, unknownParametersErrors = redirectTemplateHandler.setFictionalObjectRedirect(args, objectType, validArgs)
	if (unknownParametersErrors) then
		return redirectCategoryShell .. unknownParametersErrors
	else
		return redirectCategoryShell
	end
end

--[[ 
Public function from other modules.
Function handles the unique character redirect code.
Do not merge with other sections to allow for future changes.
--]]
function p._character(args, validArgs)
	local additonalValidArgs = {"birth_name", "sort_name", "title_name"}
	for i = 1, #additonalValidArgs do
		table.insert(validArgs, additonalValidArgs[i])
	end
	return main(args, "character", validArgs)
end

--[[ 
Public function from other modules.
Function handles the unique element redirect code.
Do not merge with other sections to allow for future changes.
--]]
function p._element(args, validArgs)
	return main(args, "element", validArgs)
end

--[[ 
Public function from other modules.
Function handles the unique location redirect code.
Do not merge with other sections to allow for future changes.
--]]
function p._location(args, validArgs)
	return main(args, "location", validArgs)
end

--[[
Public function which is used to create a Redirect category shell
with relevant redirects for fictional character redirects.

Parameters: See module documentation for details.
--]]
function p.character(frame)
	local args = getArgs(frame)
	return p._character(args, {})
end

--[[
Public function which is used to create a Redirect category shell
with relevant redirects for fictional element redirects.

Parameters: See module documentation for details.
--]]
function p.element(frame)
	local args = getArgs(frame)
	return p._element(args, {})
end

--[[
Public function which is used to create a Redirect category shell
with relevant redirects for fictional location redirects.

Parameters: See module documentation for details.
--]]
function p.location(frame)
	local args = getArgs(frame)
	return p._location(args, {})
end

return p