Template:Television episode short description/doc

From HandWiki
< Template:Television episode short description
Revision as of 16:37, 27 March 2021 by imported>Goszei (→‎See also)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Template:Television episode short description is used to create a short description by either automatically extracting data from a television episode article's Template:Infobox television episode or by manually receiving the needed values. It then creates a relevant short description based on the data available.

Usage

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Television episode short description

This template is used to create a short description by either automatically extracting data from a television episode article's Template:Infobox television episode or by manually receiving the needed values. It then creates a relevant short description based on the data available.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Episode numberepisode_num

The episode's number.

Stringsuggested
Season numberseason_num

The season's number.

Stringsuggested
Season number UKseason_num_uk

The season's number if using the British "series" term.

Stringoptional
Series nameseries_name

The TV series name.

Stringsuggested
Multi episodesmulti_episodes

Set if the episode is a double episode.

Stringoptional
Not dabnot_dab

Set if the TV series name has parentheses as part of its name.

Stringoptional

Examples

No parameters

Usage with only the TV series name

Usage with the TV series name and season number

Usage with the TV series name, episode and season number

Usage with the TV series name with disambiguation, episode and season number

Usage with a multi-part episode - using "yes"

  • Code: {{Television episode short description|series_name=Lost|season_num=3|episode_num=22 and 23|multi_episodes=yes}}
  • Produces: Script error: No such module "Television episode short description".

Usage with a multi-part episode - using a number value

  • Code: {{Television episode short description|series_name=Lost|season_num=3|episode_num=22, 23, 34|multi_episodes=3}}
  • Produces: Script error: No such module "Television episode short description".

Usage with a TV series name that has parentheses as part of its name

  • Code: {{Television episode short description|series_name=Randall and Hopkirk (Deceased)|season_num=1|episode_num=1|not_dab=yes}}
  • Produces: Script error: No such module "Television episode short description".

Usage with a TV series name, and special episode - using "yes"

Usage with a TV series name, and special episode - using text value

Usage with a TV series name, and single_season

  • Code: {{Television episode short description|series_name=Lost: Missing Pieces|single_season=yes|episode_num=1}}
  • Produces: Script error: No such module "Television episode short description".

Issues

  1. If "multi_episodes" is set, make sure there is more than 1 episode listed, or it won't work. Supported styles are: x and y, x, y, x / y and 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.

Tracking categories

See also