Template:Television episode short description/doc: Difference between revisions

Revision as of 11:53, 24 August 2022

This is a documentation subpage for Template:Television episode short description.
It contains usage information, categories and other content that is not part of the original template page.

File:Information icon4.svg

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.

Script error: No such module "High-use".

File:Lua-Logo.svg

This template uses 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 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

{{#section:Module:Television episode short description/doc|Parameters}}

TemplateData

TemplateData documentation used by VisualEditor and other tools

Click here to see a monthly parameter usage report for this template based on this 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.

Template parameters
This template prefers inline formatting of parameters.
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
Not dab	`not_dab`	Set if the TV series name has parentheses as part of its name.	String	optional
Special	`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 "recap" will set the text to "recap episode".	String	optional
Limited series	`limited_series`	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.	String	optional

Examples

No parameters

Code: {{Television episode short description}}
Produces: Television episode

Usage with only the TV series name

Code: {{Television episode short description|series_name=Lost}}
Produces: Episode of Lost

Usage with the TV series name and season number

Code: {{Television episode short description|series_name=Lost|season_num=1}}
Produces: Lua error in package.lua at line 80: module 'Module:Ordinal' not found.

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: Lua error in package.lua at line 80: module 'Module:Ordinal' not found.

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: Lua error in package.lua at line 80: module 'Module:Ordinal' not found.

Usage with a multi-part episode - two episodes

Code: {{Television episode short description|series_name=Lost|season_num=3|episode_num=22 and 23}}
Produces: Lua error in package.lua at line 80: module 'Module:Ordinal' not found.

Usage with a multi-part episode - three episodes

Code: {{Television episode short description|series_name=Lost|season_num=3|episode_num=22, 23, 34}}
Produces: Lua error in package.lua at line 80: module 'Module:Ordinal' not found.

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: Lua error in package.lua at line 80: module 'Module:Ordinal' not found.

Usage with a TV series name, and special episode - using "yes"

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

Code: {{Television episode short description|series_name=Lost|special=Recap}}
Produces: Recap episode of Lost

Usage with a TV series name, and limited_series

Code: {{Television episode short description|series_name=Lost: Missing Pieces|limited_series=yes|episode_num=1}}
Produces: Episode of Lost: Missing Pieces

Issues

{{#section:Module:Television episode short description/doc|Issues}}

Tracking categories

{{#section:Module:Television episode short description/doc|Categories}}

@@ Line 1: / Line 1: @@
-{{Lua|Module:Arguments|Module:ConvertNumeric|Module:Sort title}}
+{{Documentation subpage}}
+{{auto short description}}
+<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 {{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}
+{{Lua|Module:Television episode short description}}
-'''Module:Television episode short description''' extracts data from a television episode article's [[Template:Infobox television episode]] and creates a relevant [[WP:Short description|short description]] based on the data available.
+'''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.
-This module implements the {{tl|Television episode short description}} template.
 == Usage ==
-* {{Mlx|{{BASEPAGENAME}}|getShortDescription}}
+* {{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 ==
-<section begin=Parameters/>
+{{Transcluded section|source=Module:Television episode short description/doc}}
-The parameter names use a corresponding parameter from [[Template:Infobox television episode]] to fill in the data. They are listed below.
+{{Trim|{{#section:Module:Television episode short description/doc|Parameters}}}}
-{| class="wikitable"
+=== TemplateData ===
-|-
+{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
-! scope="col" | Parameter
+{{TemplateData header|noheader=1}}
-! scope="col" | Corresponding infobox parameter
+<templatedata>
-! scope="col" | Description
+{
-|-
+	"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.",
-! scope="row" | <code>series_name</code>
+	"params": {
-| style="text-align: center;" | <code>series</code>
+		"episode_num": {
-| The TV series name.
+			"label": "Episode number",
-|-
+			"type": "string",
-! scope="row" | <code>episode_num</code>
+			"required": false,
-| style="text-align: center;" | <code>episode</code>
+			"suggested": true,
-| The episode's number.
+			"deprecated": false,
-|-
+			"description": "The episode's number."
-! scope="row" | <code>season_num</code>
+		},
-| style="text-align: center;" | <code>season</code>
+		"season_num": {
-| The season's number.
+			"label": "Season number",
-|-
+			"type": "string",
-! scope="row" | <code>season_num_uk</code>
+			"required": false,
-| style="text-align: center;" | <code>series_no</code>
+			"suggested": true,
-| The season's number if using the British "series" term.
+			"deprecated": false,
-|-
+			"description": "The season's number."
-! scope="row" | <code>not_dab</code>
+		},
-| style="text-align: center;" | same name
+		"season_num_uk": {
-| Set if the TV series name has parentheses as part of its name.
+			"label": "Season number UK",
-|-
+			"type": "string",
-! scope="row" | <code>special</code>
+			"required": false,
-| style="text-align: center;" | same name
+			"suggested": false,
-| 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".
+			"deprecated": false,
-|-
+			"description": "The season's number if using the British \"series\" term."
-! scope="row" | <code>limited</code>
+		},
-| style="text-align: center;" | same name
+		"series_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.
+			"label": "Series name",
-|}<section end=Parameters/>
+			"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 ==
-{{Further|Template:Television episode short description#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 ==
-<section begin=Issues/>
+{{Transcluded section|source=Module:Television episode short description/doc}}
-# 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.<section end=Issues/>
+{{Trim|{{#section:Module:Television episode short description/doc|Issues}}}}
 == Tracking categories ==
-<section begin=Categories/>
+{{Transcluded section|source=Module:Television episode short description/doc}}
-* {{Category link with count|Television episode articles with short description with no series name}}
+{{Trim|{{#section:Module:Television episode short description/doc|Categories}}}}
-* {{Category link with count|Television episode articles with short description with no season number}}
-* {{Category link with count|Television episode articles with short description with no episode number}}
-* {{Category link with count|Television episode articles with short description for single episodes}}
-* {{Category link with count|Television episode articles with short description for multi-part episodes}}
-* {{Category link with count|Television episode articles with short description and disambiguated page names}}
-* {{Category link with count|Category:Pages using Television episode short description with unknown parameters}}<section end=Categories/>
 == See also ==
-* [[Template:Television episode short description]]
+* [[Module:Television episode short description]]
-* [[Module:Extract short description]]
 * [[Module:Television episode disambiguation description]]
 * [[Template:Television episode disambiguation description]]
 <includeonly>{{Sandbox other||
-<!-- Categories below this line; interwikis at Wikidata -->
+<!-- Categories below this line, please; interwikis at Wikidata -->
-[[Category:Television-related modules]]
+[[Category:Television templates]]
-[[Category:Modules that add a tracking category]]
-[[Category:Modules that create a short description]]
-[[Category:Modules that check for strip markers]]
 }}</includeonly>

Template:Television episode short description/doc: Difference between revisions

Revision as of 11:53, 24 August 2022

Contents

Usage

Parameter list

TemplateData

Examples

No parameters

Usage with only the TV series name

Usage with the TV series name and season number

Usage with the TV series name, episode and season number

Usage with the TV series name with disambiguation, episode and season number

Usage with a multi-part episode - two episodes

Usage with a multi-part episode - three episodes

Usage with a TV series name that has parentheses as part of its name

Usage with a TV series name, and special episode - using "yes"

Usage with a TV series name, and special episode - using text value

Usage with a TV series name, and limited_series

Issues

Tracking categories

See also

Navigation menu

Template:Television episode short description/doc: Difference between revisions

Revision as of 11:53, 24 August 2022

Usage

Parameter list

TemplateData

Examples

No parameters

Usage with only the TV series name

Usage with the TV series name and season number

Usage with the TV series name, episode and season number

Usage with the TV series name with disambiguation, episode and season number

Usage with a multi-part episode - two episodes

Usage with a multi-part episode - three episodes

Usage with a TV series name that has parentheses as part of its name

Usage with a TV series name, and special episode - using "yes"

Usage with a TV series name, and special episode - using text value

Usage with a TV series name, and limited_series

Issues

Tracking categories

See also

Navigation menu

Search