Wikipedia>Gonnym at 16:08, 5 July 2021

2021-07-05T16:08:42Z

New page

{{Documentation subpage}}
{{auto short description}}

{{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 ==
{{Transcluded section|source=Module:Television episode short description/doc}}
{{Trim|{{#section:Module:Television episode short description/doc|Parameters}}}}

=== TemplateData ===
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<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."
},
"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."
},
"special": {
"label": "Special",
"type": "string",
"required": false,
"suggested": false,
"deprecated": false,
"description": "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\"."
},
"limited_series": {
"label": "Limited series",
"type": "string",
"required": false,
"suggested": false,
"deprecated": false,
"description": "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."
}
},
"format": "inline"
}
</templatedata>
{{Collapse bottom}}

== 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 - two episodes ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}3|episode_num{{=}}22 and 23}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|season_num=3|episode_num=22 and 23}}</code>

=== Usage with a multi-part episode - three episodes ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}3|episode_num{{=}}22, 23, 34}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|season_num=3|episode_num=22, 23, 24}}</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 limited_series ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost: Missing Pieces|limited_series{{=}}yes|episode_num{{=}}1}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost: Missing Pieces|limited_series=yes|episode_num=1}}</code>

== Issues ==
{{Transcluded section|source=Module:Television episode short description/doc}}
{{Trim|{{#section:Module:Television episode short description/doc|Issues}}}}

== Tracking categories ==
{{Transcluded section|source=Module:Television episode short description/doc}}
{{Trim|{{#section:Module:Television episode short description/doc|Categories}}}}

== See also ==
* [[Module:Television episode short description]]
* [[Module:Television episode disambiguation description]]
* [[Template:Television episode disambiguation description]]
<includeonly>{{Sandbox other||

[[Category:Television templates]]
}}</includeonly>

Template:Television episode short description/doc - Revision history

Wikipedia>Gonnym at 16:08, 5 July 2021