Module:Redirect template handler/doc

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 <syntaxhighlight lang="lua" inline>setEpisodeRedirect(args)</syntaxhighlight> and <syntaxhighlight lang="lua" inline>setFictionalObjectRedirect(args, objectType)</syntaxhighlight>.

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.

<syntaxhighlight lang="lua"> local redirectTemplateHandler = require('Module:Redirect template handler') local redirectCategoryShell, mainRedirect = redirectTemplateHandler.setEpisodeRedirect(args) local redirectCategoryShell, mainRedirect = redirectTemplateHandler.setFictionalObjectRedirect(args, objectType) </syntaxhighlight>

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 Template:Para. 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 Template:Para value entered as the correct name to use. If Template:Para 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 Template:Para value entered as the correct capitalisation to use. If Template:Para 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.
• 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}}.
• 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.
• For episode redirects, a short description will be added only to the primary redirect. Additionally, If Template:Para (or higher) is used, a short description won't be added.