Module:Television episode short description/doc
Jump to navigation
Jump to search
This is the documentation page for Module:Television episode short description
![]() | This module uses Lua: |
![]() | This Lua module is used on approximately 11,000 pages, so changes to it will be widely noticed. Please test any changes in the module's /sandbox or /testcases subpages. Please 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[edit source]
{{#invoke:Television episode short description|getShortDescription|episode_num= |season_num= |season_num_uk= |series_name= |multi_episodes= |not_dab= }}
Parameter list[edit source]
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[edit source]
An empty infobox[edit source]
- Code:
{{#invoke:Television episode short description|getShortDescription}}
- Produces:
A television episode
An infobox with only the TV series name[edit source]
- 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[edit source]
- 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[edit source]
- 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[edit source]
- 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[edit source]
- 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[edit source]
- 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[edit source]
- 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[edit source]
- 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 (1)
- 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[edit source]
- Template:Television episode short description
- Module:Extract short description
- Module:Television episode disambiguation description
- Template:Television episode disambiguation description
External links[edit source]
- Module:Television episode short description/doc at Wikipedia, the free Terran-based encyclopedia that anyone can edit.