Editing Module:Infobox television season name/doc

{{High-use}}
{{Lua|Module:Arguments|Module:Country adjective|Module:Delink|Module:String|noprotcat=yes}}

'''Module:Infobox television season name''' is used to validate or create a formatted season link for use in [[Template:Infobox television season]].

== Usage ==
* {{Mlx|{{BASEPAGENAME}}|isPrevOrNextSeasonLinkValid}}
* {{Mlx|{{BASEPAGENAME}}|isPrevSeasonLinkValid}}
* {{Mlx|{{BASEPAGENAME}}|isNextSeasonLinkValid}}
* {{Mlx|{{BASEPAGENAME}}|getPrevSeasonArticle}}
* {{Mlx|{{BASEPAGENAME}}|getNextSeasonArticle}}
* {{Mlx|{{BASEPAGENAME}}|getSeasonWord}}
* {{Mlx|{{BASEPAGENAME}}|getSubHeader}}
* {{Mlx|{{BASEPAGENAME}}|getListOfEpisodes|link}}

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

{| class="wikitable"
|-
! scope="col" | Parameter
! scope="col" | Explanation
! scope="col" | Status
|-
! scope="row" | <code>title</code>
| 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
|}

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

== Examples ==

=== isPrevOrNextSeasonLinkValid ===
* Code: {{Mlx|{{BASEPAGENAME}}|isPrevOrNextSeasonLinkValid|title{{=}}Dallas (1978 TV series, season 7)}}
* Produces: <code>{{#invoke:Infobox television season name|isPrevOrNextSeasonLinkValid|title=Dallas (1978 TV series, season 7)}}</code>

=== getPrevSeasonArticle ===
* Code: {{Mlx|{{BASEPAGENAME}}|getPrevSeasonArticle|title{{=}}Dallas (1978 TV series, season 7)}}
* Produces: <code>{{#invoke:Infobox television season name|getPrevSeasonArticle|title=Dallas (1978 TV series, season 7)}}</code>

=== getNextSeasonArticle ===
* Code: {{Mlx|{{BASEPAGENAME}}|getNextSeasonArticle|title{{=}}Lost (season 3)}}
* Produces: <code>{{#invoke:Infobox television season name|getNextSeasonArticle|title=Lost (season 3)}}</code>

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Infobox modules]]
[[Category:Television-related modules]]
}}</includeonly><noinclude>
[[Category:Module documentation pages]]
</noinclude>