Template:Television episode short description/doc
This is a documentation subpage for Template:Television episode short description It may contain usage information, categories and other content that is not part of the original template page. |
This template adds an automatically generated short description. |
This template is used on approximately 11,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Transclusion count updated automatically (see documentation). |
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
{{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
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
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Episode number | episode_num | The episode's number. | String | suggested |
Season number | season_num | The season's number. | String | suggested |
Season number UK | season_num_uk | The season's number if using the British "series" term. | String | optional |
Series name | series_name | The TV series name. | String | suggested |
Multi episodes | multi_episodes | Set if the episode is a double episode. | String | optional |
Not dab | not_dab | Set if the TV series name has parentheses as part of its name. | String | optional |
Examples
No parameters
- Code:
{{Television episode short description}}
- Produces:
Script error: No such module "Television episode short description".
Usage with only the TV series name
- Code:
{{Television episode short description|series_name=Lost}}
- Produces:
Script error: No such module "Television episode short description".
Usage with the TV series name and season number
- Code:
{{Television episode short description|series_name=Lost|season_num=1}}
- Produces:
Script error: No such module "Television episode short description".
Usage with the TV series name, episode and season number
- Code:
{{Television episode short description|series_name=Lost|season_num=5|episode_num=4}}
- Produces:
Script error: No such module "Television episode short description".
Usage with the TV series name with disambiguation, episode and season number
- Code:
{{Television episode short description|series_name=Firefly|season_num=1|episode_num=1}}
- Produces:
Script error: No such module "Television episode short description".
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"
- Code:
{{Television episode short description|series_name=Lost|special=1}}
- Produces:
Script error: No such module "Television episode short description".
Usage with a TV series name, and special episode - using text value
- Code:
{{Television episode short description|series_name=Lost|special=Recap}}
- Produces:
Script error: No such module "Television episode short description".
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
- 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
andx & y
. - 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
- Category:Television episode articles with short description with no series name (0)
- Category:Television episode articles with short description with no season number (0)
- Category:Television episode articles with short description with no episode number (0)
- Category:Television episode articles with short description for single episodes (0)
- Category:Television episode articles with short description for multi-part episodes (0)