Module:Television episode short description/doc
< Module:Television episode short description
Jump to navigation
Jump to search
Revision as of 22:05, 9 July 2019 by blackwiki>Gonnym
This is the documentation page for Module:Television episode short description
| 30px | This module depends on the following other modules: |
| 40px | This Lua module is used on approximately 13,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages. Consider discussing changes on the talk page before implementing them.
Transclusion count updated automatically (see documentation). |
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.
Contents
- 1 Usage
- 2 Parameter list
- 3 Examples
- 3.1 An empty infobox
- 3.2 An infobox with only the TV series name
- 3.3 An infobox with the TV series name and season number
- 3.4 An infobox with the TV series name, episode and season number
- 3.5 An infobox with the TV series name with disambiguation, episode and season number
- 3.6 An infobox with a multi-episode
- 3.7 An infobox with a TV series name that has parentheses as part of its name
- 4 Issues
- 5 Tracking categories
- 6 See also
Usage
{{#invoke:Television episode short description|getShortDescription|episode_num= |season_num= |season_num_uk= |series_name= |multi_episodes= |not_dab= }}
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
An empty infobox
- Code:
{{#invoke:Television episode short description|getShortDescription}} - Produces:
A television episode
An infobox with only the TV series name
- Code:
{{#invoke:Television episode short description|getShortDescription|series_name=Lost}} - Produces:
An episode of Lost
An infobox with the TV series name and season number
- Code:
{{#invoke:Television episode short description|getShortDescription|series_name=Lost|season_num=1}} - Produces:
An episode of the first season of Lost
An infobox with the TV series name, episode and season number
- Code:
{{#invoke:Television episode short description|getShortDescription|series_name=Lost|season_num=5|episode_num=4}} - Produces:
4th episode of the fifth season of Lost
An infobox with the TV series name with disambiguation, episode and season number
- Code:
{{#invoke:Television episode short description|getShortDescription|series_name=[[Firefly (TV series)|Firefly]]|season_num=1|episode_num=1}} - Produces:
1st episode of the first season of Firefly
An infobox with a multi-episode
- Code:
{{#invoke:Television episode short description|getShortDescription|series_name=Lost|season_num=3|episode_num=22 and 23|multi_episodes=yes}} - Produces:
22nd and 23rd episodes of the third season of Lost
An infobox with a TV series name that has parentheses as part of its name
- Code:
{{#invoke:Television episode short description|getShortDescription|series_name=Randall and Hopkirk (Deceased)|season_num=1|episode_num=1|not_dab=yes}} - Produces:
1st episode of the first season of Randall and Hopkirk (Deceased)
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 / yandx & 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 (0)
- Category:Television episode articles with short description with no season number (0)
- Category:Television episode articles with short description with no episode number (0)
- Category:Television episode articles with short description for single episodes (0)
- Category:Television episode articles with short description for multi-part episodes (0)
- Category:Television episode articles with short description and disambiguated page names (0)
See also
- Template:Television episode short description
- Module:Extract short description
- Module:Television episode disambiguation description
- Template:Television episode disambiguation description