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.

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

Parameter list

All parameter names use the same names as the corresponding parameters in Template:Infobox television episode.

episode_num — optional; The episode's number.
season_num — optional; The season's number.
season_num_uk — optional; The season's number if using the British "series" term.
series_name — optional; The TV series name.
multi_episodes — optional; Set if the episode is a double episode.
not_dab — optional; Set if the TV series name has parentheses as part of its name.

{{#invoke:Television episode short description|getShortDescription|episode_num= |season_num= |series_name= }}
{{#invoke:Television episode short description|getShortDescription|episode_num= |season_num_uk= |series_name= }}
{{#invoke:Television episode short description|getShortDescription|episode_num= |season_num= |series_name= |multi_episodes= }}
{{#invoke:Television episode short description|getShortDescription|episode_num= |season_num= |series_name= |not_dab= }}

Code: {{#invoke:Television episode short description|getShortDescription|series_name=Lost|season_num=1}}

Code: {{#invoke:Television episode short description|getShortDescription|series_name=Lost|season_num=1}}
Produces: An episode of the first season of Lost

Code: {{#invoke:Television episode short description|getShortDescription|series_name=Lost|season_num=5|episode_num=4}}
Produces: 5th episode of the fourth season of Lost

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

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 episode of the third season of Lost

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)

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, 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.