Difference between revisions of "Module:Infobox television season name/doc"
Jump to navigation
Jump to search
test>Gonnym |
test>Gonnym |
||
| Line 12: | Line 12: | ||
* {{Mlx|{{BASEPAGENAME}}|getSeasonWord}} | * {{Mlx|{{BASEPAGENAME}}|getSeasonWord}} | ||
* {{Mlx|{{BASEPAGENAME}}|getInfoboxSubHeader}} | * {{Mlx|{{BASEPAGENAME}}|getInfoboxSubHeader}} | ||
| − | * {{Mlx|{{BASEPAGENAME}}|getListOfEpisodes}} | + | * {{Mlx|{{BASEPAGENAME}}|getListOfEpisodes|link}} |
== Parameter list == | == Parameter list == | ||
| Line 25: | Line 25: | ||
! scope="row" | <code>title</code> | ! scope="row" | <code>title</code> | ||
| The title of TV program. If not supplied, will use the article title. | | The title of TV program. If not supplied, will use the article title. | ||
| + | | optional | ||
| + | |- | ||
| + | ! scope="row" | <code>link</code> | ||
| + | | Only for getListOfEpisodes. The plain link to the list of episode article. If not supplied, will create one based on the series name. | ||
| optional | | optional | ||
|} | |} | ||
Revision as of 00:43, 15 July 2020
| 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.
Contents
Usage
{{#invoke:Infobox television season name|checkAll}}{{#invoke:Infobox television season name|checkPrevSeason}}{{#invoke:Infobox television season name|checkNextSeason}}{{#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
checkAll
- Code:
{{#invoke:Infobox television season name|checkAll|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