Jump to content

Template:Television episode short description/doc

From Wikipedia, the free encyclopedia

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

[edit]

Parameter list

[edit]

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 Description
series_name series The TV series name.
episode_num episode The episode's number.
season_num season The season's number.
season_num_uk series_no The season's number if using the British "series" term.
not_dab same name Set if the TV series name has parentheses as part of its name.
special same name Setting to "yes" will set the description as a "special episode". Any other value will replace the word "special" with the one entered. For example |special=recap will set the text to "recap episode".
limited same name Set if the series is a single season series, such as miniseries or limited series and does not need a season number as part of the description.

TemplateData

[edit]
TemplateData documentation used by VisualEditor and other tools
See a monthly parameter usage report for Template:Television episode short description in articles based on its 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
Not dabnot_dab

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

Stringoptional
Specialspecial

Setting to "yes" will set the description as a "special episode". Any other value will replace the word "special" with the one entered. For example "recap" will set the text to "recap episode".

Stringoptional
Limited serieslimited_series

Set if the series is a single season series, such as miniseries or limited series and does not need a season number as part of the description.

Stringoptional

Examples

[edit]

No parameters

[edit]

Usage with only the TV series name

[edit]

Usage with the TV series name and season number

[edit]

Usage with the TV series name, episode and season number

[edit]

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

[edit]

Usage with a multi-part episode - two episodes

[edit]

Usage with a multi-part episode - three episodes

[edit]

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

[edit]
  • Code: {{Television episode short description|series_name=Randall and Hopkirk (Deceased)|season_num=1|episode_num=1|not_dab=yes}}
  • Produces: 1st episode of the 1st season of Randall and Hopkirk (Deceased)

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

[edit]

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

[edit]

Usage with a TV series name, and limited_series

[edit]

Issues

[edit]
  1. 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]

See also

[edit]