View source for Template:Television episode short description/doc

{{Documentation subpage}}
{{auto short description}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-use}}
{{Lua|Module:Television episode short description}}

'''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 [[WP:Short description|short description]] based on the data available.

== Usage ==
* {{Tlx|{{BASEPAGENAME}}|episode_num{{=}}|season_num{{=}}|series_name{{=}}}}
* {{Tlx|{{BASEPAGENAME}}|episode_num{{=}}|season_num_uk{{=}}|series_name{{=}}}}
* {{Tlx|{{BASEPAGENAME}}|episode_num{{=}}|season_num{{=}}|series_name|multi_episodes{{=}}}}
* {{Tlx|{{BASEPAGENAME}}|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.

{| class="wikitable"
|-
! scope="col" | Parameter
! scope="col" | Corresponding infobox parameter
! scope="col" | Explanation
! scope="col" | Status
|-
! scope="row" | <code>episode_num</code>
| style="text-align:center;" | <code>episode</code>
| The episode's number
| optional
|-
! scope="row" | <code>season_num</code>
| style="text-align:center;" | <code>season</code>
| The season's number
| optional
|-
! 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
| 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>
| style="text-align:center;" | <code>multi_episodes</code>
| Set if the episode is a double episode
| optional
|-
! 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
| optional
|}

=== TemplateData ===
{{TemplateData header}}
<templatedata>
{
	"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.",
	"params": {
		"episode_num": {
			"label": "Episode number",
			"type": "string",
			"required": false,
			"suggested": true,
			"deprecated": false,
			"description": "The episode's number."
		},
		"season_num": {
			"label": "Season number",
			"type": "string",
			"required": false,
			"suggested": true,
			"deprecated": false,
			"description": "The season's number."
		},
		"season_num_uk": {
			"label": "Season number UK",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The season's number if using the British \"series\" term."
		},
		"series_name": {
			"label": "Series name",
			"type": "string",
			"required": false,
			"suggested": true,
			"deprecated": false,
			"description": "The TV series name."
		},
		"multi_episodes": {
			"label": "Multi episodes",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Set if the episode is a double episode."
		},
		"not_dab": {
			"label": "Not dab",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Set if the TV series name has parentheses as part of its name."
		}
	},
	"format": "inline"
}
</templatedata>

== Examples ==
=== No parameters ===
* Code: {{Tlx|{{BASEPAGENAME}}}}
* Produces: <code>{{Television episode short description|doc=yes}}</code>

=== Usage with only the TV series name ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost}}</code>

=== Usage with the TV series name and season number ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}1}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|season_num=1}}</code>

=== Usage with the TV series name, episode and season number ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}5|episode_num{{=}}4}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|season_num=5|episode_num=4}}</code>

=== Usage with the TV series name with disambiguation, episode and season number ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}[[Firefly (TV series)|Firefly]]|season_num{{=}}1|episode_num{{=}}1}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=[[Firefly (TV series)|Firefly]]|season_num=1|episode_num=1}}</code>

=== Usage with a multi-part episode - using "yes"  ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}3|episode_num{{=}}22 and 23|multi_episodes{{=}}yes}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|season_num=3|episode_num=22 and 23|multi_episodes=yes}}</code>

=== Usage with a multi-part episode - using a number value ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}3|episode_num{{=}}22, 23, 34|multi_episodes{{=}}3}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|season_num=3|episode_num=22, 23, 24|multi_episodes=3}}</code>

=== Usage with a TV series name that has parentheses as part of its name ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Randall and Hopkirk (Deceased)|season_num{{=}}1|episode_num{{=}}1|not_dab{{=}}yes}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Randall and Hopkirk (Deceased)|season_num=1|episode_num=1|not_dab=yes}}</code>

=== Usage with a TV series name, and special episode - using "yes" ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|special{{=}}1}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|special=yes}}</code>

=== Usage with a TV series name, and special episode - using text value ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|special{{=}}Recap}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|special=Recap}}</code>

=== Usage with a TV series name, and single_season ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost: Missing Pieces|single_season{{=}}yes|episode_num{{=}}1}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost: Missing Pieces|single_season=yes|episode_num=1}}</code>

== Issues ==
# If "multi_episodes" is set, make sure there is more than 1 episode listed, or it won't work. Supported styles are: <code>x and y</code>, <code>x, y</code>, <code>x / y</code> and <code>x & y</code>.
# 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 link with count|Category:Television episode articles with short description with no series name}}
* {{Category link with count|Category:Television episode articles with short description with no season number}}
* {{Category link with count|Category:Television episode articles with short description with no episode number}}
* {{Category link with count|Category:Television episode articles with short description for single episodes}}
* {{Category link with count|Category:Television episode articles with short description for multi-part episodes}}

== See also ==
* [[Module:Television episode short description]]
* [[Module:Television episode disambiguation description]]
* [[Template:Television episode disambiguation description]]
<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Television templates]]
}}</includeonly>