Module:Television episode short description/doc
Appearance
![]() | 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 | Corresponding infobox parameter | Explanation | Status |
---|---|---|---|
episode_num
|
episode
|
The episode's number | optional |
season_num
|
season
|
The season's number | optional |
season_num_uk
|
series_no
|
The season's number if using the British "series" term | optional |
series_name
|
series
|
The TV series name | optional |
multi_episodes
|
multi_episodes
|
Set if the episode is a double episode | optional |
not_dab
|
not_dab
|
Set if the TV series name has parentheses as part of its name | optional |
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
andx & 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.
Tracking categories
- Category:Television episode articles with short description with no series name (1)
- Category:Television episode articles with short description with no season number (3,032)
- Category:Television episode articles with short description with no episode number (38)
- Category:Television episode articles with short description for single episodes (18,403)
- Category:Television episode articles with short description for multi-part episodes (331)
- Category:Television episode articles with short description and disambiguated page names (10,289)
See also
- Template:Television episode short description
- Module:Extract short description
- Module:Television episode disambiguation description
- Template:Television episode disambiguation description