Module:Infobox television season name/doc

This is the documentation page for Module:Infobox television season name

This Lua module is used on approximately 10,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:Infobox television season name is used to validate or create a formatted season link for use in Template:Infobox television season.

Usage

{{#invoke:Infobox television season name|isPrevOrNextSeasonLinkValid}}
{{#invoke:Infobox television season name|isPrevOrNextSeasonLinkValid}}
{{#invoke:Infobox television season name|isNextSeasonLinkValid}}
{{#invoke:Infobox television season name|getPrevSeasonArticle}}
{{#invoke:Infobox television season name|getNextSeasonArticle}}
{{#invoke:Infobox television season name|getSeasonWord}}
{{#invoke:Infobox television season name|getInfoboxSubHeader}}
{{#invoke:Infobox television season name|getListOfEpisodes|link}}

Parameter list

The following parameters can be used as named parameters or nameless positional parameters.

Parameter	Explanation	Status
`title`	The title of TV program. If not supplied, will use the article title.	optional
`link`	Only for getListOfEpisodes. The plain link to the list of episode article. If not supplied, will create one based on the series name.	optional

Function list

Function	Explanation
`checkAll`	Checks if the next or previous season have a created article or redirect.
`checkPrevSeason`	Checks if the previous season has a created article or redirect.
`checkNextSeason`	Checks if the next season has a created article or redirect.
`getPrevSeasonArticle`	Retrieves the previous season article title.
`getNextSeasonArticle`	Retrieves the next season article title.
`getSeasonWord`	Returns either the word "season" or "series" as used in the disambiguation of the article title.
`getInfoboxSubHeader`	Returns the relevant text for the sub-header field. The text is returned in the format of `Season #` or `Series #`, depending on either what the article disambiguation uses, or on manually entered parameters of the infobox.
`getListOfEpisodes`	Returns the formatted link to the list of episodes article in the style of: `[[List of <series name> <disambiguation if present> episodes <seasons if present>\|List of ''<series name>'' episodes <seasons if present>]]`. The link will only return if the page exists.

Examples

isPrevOrNextSeasonLinkValid

Code: {{#invoke:Infobox television season name|isPrevOrNextSeasonLinkValid|title=Dallas (1978 TV series, season 7)}}
Produces:

getPrevSeasonArticle

Code: {{#invoke:Infobox television season name|getPrevSeasonArticle|title=Dallas (1978 TV series, season 7)}}
Produces: Season 6

getNextSeasonArticle

Code: {{#invoke:Infobox television season name|getNextSeasonArticle|title=Lost (season 3)}}
Produces: Season 4