Template:Television episode short description/sandbox
This is the template sandbox page for Template:Television episode short description (diff). See also the companion subpage for test cases. |
This template adds an automatically generated short description. If the automatic short description is not optimal, replace it by adding {{Short description}} at the top of the article. |
This template uses Lua: |
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]{{Television episode short description|episode_num=|season_num=|series_name=}}
{{Television episode short description|episode_num=|season_num_uk=|series_name=}}
{{Television episode short description|episode_num=|season_num=|series_name|multi_episodes=}}
{{Television episode short description|episode_num=|season_num=|series_name|not_dab=}}
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.
|
Examples
[edit]No parameters
[edit]- Code:
{{Television episode short description}}
- Produces:
Television episode
Usage with only the TV series name
[edit]- Code:
{{Television episode short description|series_name=Lost}}
- Produces:
Episode of Lost
Usage with the TV series name and season number
[edit]- Code:
{{Television episode short description|series_name=Lost|season_num=1}}
- Produces:
Episode of the 1st season of Lost
Usage with the TV series name, episode and season number
[edit]- Code:
{{Television episode short description|series_name=Lost|season_num=5|episode_num=4}}
- Produces:
4th episode of the 5th season of Lost
Usage with the TV series name with disambiguation, episode and season number
[edit]- Code:
{{Television episode short description|series_name=Firefly|season_num=1|episode_num=1}}
- Produces:
1st episode of the 1st season of Firefly
Usage with a multi-part episode - two episodes
[edit]- Code:
{{Television episode short description|series_name=Lost|season_num=3|episode_num=22 and 23}}
- Produces:
22nd and 23rd episodes of the 3rd season of Lost
Usage with a multi-part episode - three episodes
[edit]- Code:
{{Television episode short description|series_name=Lost|season_num=3|episode_num=22, 23, 34}}
- Produces:
22nd, 23rd and 24th episodes of the 3rd season of Lost
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]- Code:
{{Television episode short description|series_name=Lost|special=1}}
- Produces:
Special episode of Lost
Usage with a TV series name, and special episode - using text value
[edit]- Code:
{{Television episode short description|series_name=Lost|special=Recap}}
- Produces:
Recap episode of Lost
Usage with a TV series name, and limited_series
[edit]- Code:
{{Television episode short description|series_name=Lost: Missing Pieces|limited_series=yes|episode_num=1}}
- Produces:
Episode of Lost: Missing Pieces
Issues
[edit]- 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]- Category:Television episode articles with short description with no series name (0)
- Category:Television episode articles with short description with no season number (1,355)
- Category:Television episode articles with short description with no episode number (14)
- Category:Television episode articles with short description for single episodes (16,552)
- Category:Television episode articles with short description for multi-part episodes (328)
- Category:Television episode articles with short description and disambiguated page names (8,290)
- Category:Pages using Television episode short description with unknown parameters (0)