Module:Television episode disambiguation description

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

Module:Television episode disambiguation creates an entry in a disambiguation page by converting a plain text episode article name into a correctly formatted link and its short description. The style of the links follows the guidelines at WP:NCTV, MOS:DABENTRY, MOS:ITALICTITLE and MOS:QUOTETITLE.

This module implements the {{Television episode disambiguation description}} template.

Usage

• {{#invoke:Television episode disambiguation description|main}}

Parameter list

Parameter	Explanation	Status
name	The episode's full article name	required
not_disambiguated	Set if the parentheses is part of the episode name	optional
link_only	Set if you are only interested in getting a formatted article link	optional

Examples

Further information: Template:Television episode disambiguation description § Examples

See also

• Template:Television episode disambiguation description
• Module:Television episode short description
• Template:Television episode short description

The above documentation is transcluded from Module:Television episode disambiguation description/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.

-- Do not add a style which is not supported by the [[WP:NCTV]] guidelines.

local p = {}

-- Local function used to create the stylized article disambiguation.
local function getStylizedDisambiguation(disambiguation)
	local isDisambiguationExtended = string.find(disambiguation, "episode")				-- Search for the word "episode" in the article name disambiguation.
	
	if not isDisambiguationExtended then												-- Check if the article name has extended disambiguation.
		return "(''" .. disambiguation .. "'')"											-- Article does not have extended disambiguation; 
																						-- Add italics to the disambiguation which should only be the TV series name per [[MOS:ITALICTITLE]] and [[WP:NCTV]].
	else																				-- Articles has extended disambiguation;
		local tvSeries = string.gsub(disambiguation, "episode", "", 1, true)			-- Get the TV series name without the extended disambiguation.
		return "(''" .. tvSeries .. "'' episode)"										-- Add italics to the disambiguation which should only be the TV series name per [[MOS:ITALICTITLE]] and [[WP:NCTV]]; 
	end																					-- and add back the extended disambiguation.

end

-- Local function used to create the stylized article title.
local function getStylizedArticleTitle(articleName)
	local articleTitle = string.gsub(articleName, "%s+%b()$", "", 1, false)				-- Get the article title without the disambiguation.
	return "\"" .. articleTitle .. "\""													-- Add qutoation marks to the title per [[MOS:QUOTETITLE]].
end

-- Local function used to get the disambiguated formmated episode link.
local function getDisambiguatedFormmatedLink(articleName)
	local disambiguation = string.match(articleName, "%s%((.-)%)")						-- Get the text inside the disambiguation parentheses.
	local stylizedArticleName															-- Variable to save new stylized article name.
	
	if not disambiguation then															-- Check if the article name does not have disambiguation parentheses.
		stylizedArticleName = "\"" .. articleName .. "\""								-- Article does not have disambiguation parentheses; Add qutoation marks for the title per [[MOS:QUOTETITLE]].
	else																				-- Article has disambiguation parentheses;
		local stylizedArticleTitle = getStylizedArticleTitle(articleName)				-- Call getStylizedArticleTitle() to get the stylized article title.
		local stylizedDisambiguation = getStylizedDisambiguation(disambiguation)		-- Call getStylizedDisambiguation() to get the stylized disambiguation.
		stylizedArticleName = stylizedArticleTitle .. " " .. stylizedDisambiguation		-- Recreate the article name from the title and disambiguation.
	end
	
	return "[[" .. articleName .. "|" .. stylizedArticleName .. "]]"					-- Create a pipped link and return it.
end

-- Local function used to process the value of 'parenthesesPartOfTitle'.
local function isParenthesesPartOfTitle(parenthesesPartOfTitle)
	
	if (parenthesesPartOfTitle:lower() == "yes" or										-- Check if the value equals "yes"
		parenthesesPartOfTitle:lower() == "true") then									-- Check if the value equals "true"
		return true																		-- It is; Parentheses is part of the title; Return true.
	else																				-- Anything else - empty string or "no".
		return false																	-- Parentheses is not part of the title; Return false.
	end
	
end

-- Public function used to create a formmated episode link.
function p.getFormmatedArticleLink(frame)
	local articleName = frame.args[1]													-- Get the article name.
	local parenthesesPartOfTitle = frame.args[2]										-- Get the optional "yes"/"no" value.
	
	local formattedLink																	-- Variable to save the formmated link.

	if (isParenthesesPartOfTitle(parenthesesPartOfTitle) == true) then					-- Call isParenthesesPartOfTitle() to check if the parentheses is part of the episode title.
		formattedLink = "\"[[" .. articleName .. "]]\""									-- Parentheses is part of the title; Add qutoation marks for the title per [[MOS:QUOTETITLE]].
	else																				-- Parentheses is not part of the title; 
		formattedLink = getDisambiguatedFormmatedLink(articleName)						-- Call getDisambiguatedFormmatedLink() to get the disambiguated formmated episode link.
	end

    return formattedLink																-- Return the formmated link.
end

return p