Module:Television episode short description/doc

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.

Parameter list

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

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

Usage

• {{#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= }}

Examples

An empty infobox

• Code: {{#invoke:Television episode short description|getShortDescription}}
• Produces:

An infobox with only the TV series name

• Code: {{#invoke:Television episode short description|getShortDescription|series_name=Lost}}
• Produces:

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 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:

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:

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:

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:

Issues

1. 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
2. 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.

See also

• Template:Television episode short description
• Module:Extract short description
• Module:Television episode disambiguation description
• Template:Television episode disambiguation description