Difference between revisions of "Category talk:Television episode short description/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Gonnym
blackwiki>Gonnym
Line 16: Line 16:
 
|-
 
|-
 
! scope="col" | Parameter
 
! scope="col" | Parameter
! scope="col" | Corresponding infobox parameter
 
 
! scope="col" | Explanation
 
! scope="col" | Explanation
! scope="col" | Status
+
|-<noinclude>
|-
+
! scope="row" | <code>series_name</code>
 +
| The TV series name.
 +
|-</noinclude>
 
! scope="row" | <code>episode_num</code>
 
! scope="row" | <code>episode_num</code>
| style="text-align:center;" | <code>episode</code>
+
| The episode's number.
| The episode's number
 
| optional
 
 
|-
 
|-
 
! scope="row" | <code>season_num</code>
 
! scope="row" | <code>season_num</code>
| style="text-align:center;" | <code>season</code>
+
| The season's number.
| The season's number
 
| optional
 
 
|-
 
|-
 
! scope="row" | <code>season_num_uk</code>
 
! scope="row" | <code>season_num_uk</code>
| style="text-align:center;" | <code>series_no</code>
+
| The season's number if using the British "series" term.
| The season's number if using the British "series" term
 
| optional
 
|-
 
! scope="row" | <code>series_name</code>
 
| style="text-align:center;" | <code>series</code>
 
| The TV series name
 
| optional
 
 
|-
 
|-
 
! scope="row" | <code>multi_episodes</code>
 
! scope="row" | <code>multi_episodes</code>
| style="text-align:center;" | <code>multi_episodes</code>
+
| Set if the episode is a multi-part episode. Will use the value as the number of parts. Setting "yes" will default to a two-part episode.
| Set if the episode is a double episode
 
| optional
 
 
|-
 
|-
 
! scope="row" | <code>not_dab</code>
 
! scope="row" | <code>not_dab</code>
| style="text-align:center;" | <code>not_dab</code>
 
 
| Set if the TV series name has parentheses as part of its name
 
| Set if the TV series name has parentheses as part of its name
| optional
+
|-
 +
! scope="row" | <code>special</code>
 +
| 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 {{para|special|recap}} will set the text to "recap episode".
 +
|-
 +
! scope="row" | <code>single_season</code>
 +
| Set if the series is a single season series, such as a companion web series, a miniseries or a limited series and does not need "1st season" as part of the description.
 
|}
 
|}
  

Revision as of 20:05, 19 January 2020

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

Parameter list

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

Parameter Explanation
series_name The TV series name.
episode_num The episode's number.
season_num The season's number.
season_num_uk The season's number if using the British "series" term.
multi_episodes Set if the episode is a multi-part episode. Will use the value as the number of parts. Setting "yes" will default to a two-part episode.
not_dab Set if the TV series name has parentheses as part of its name
special 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".
single_season Set if the series is a single season series, such as a companion web series, a miniseries or a limited series and does not need "1st season" as part of the description.

Examples

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