Module:Television episode short description/doc

This is a documentation subpage for Module:Television episode short description.
It may contain usage information, categories and other content that is not part of the original module page.

This module depends on the following other modules:

This Lua module is used on approximately 22,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.

Module:Television episode short description extracts data from a television episode article's Template:Infobox television episode and creates a relevant short description based on the data available.

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

Usage

{{#invoke:Television episode short description|getShortDescription}}

Parameter list

The parameter names use a corresponding parameter from Template:Infobox television episode to fill in the data. They are listed below.

Parameter	Explanation
`series_name`	The TV series name.
`episode_num`	The episode's number.
`season_num`	The season's number.
`season_num_uk`	The season's number if using the British "series" term.
`multi_episodes`	Set if the episode is a multi-part episode. Will use the value as the number of parts. Setting "yes" will default to a two-part episode.
`not_dab`	Set if the TV series name has parentheses as part of its name
`special`	Setting to "yes" will set the description as a "special episode". Any other value will replace the word "special" with the one entered. For example `\|special=recap` will set the text to "recap episode".
`single_season`	Set if the series is a single season series, such as a companion web series, a miniseries or a limited series and does not need "1st season" as part of the description.

Examples

Issues

If "multi_episodes" is set, make sure there are 2 episodes listed in the episode list, or it won't work. Supported styles are: x and y, x, y, x / y and x & y.
If an article does not show the short description with the data from the infobox, make sure you entered the parameter names correctly in the infobox.

Module:Television episode short description/doc

Usage

Parameter list

Examples

Issues

Tracking categories

See also