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

From The Global Wiki
Jump to navigation Jump to search
en>Paine Ellsworth
(remove High-use template from sandbox display)
m (1 revision imported)
Line 1: Line 1:
{{Documentation subpage}}
{{Lua|Module:Arguments|Module:ConvertNumeric|Module:Sort title}}
{{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}}}}
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{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.
'''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.
 
This module implements the {{tl|Television episode short description}} template.


== Usage ==
== Usage ==
* {{Tlx|{{BASEPAGENAME}}|episode_num{{=}}|season_num{{=}}|series_name{{=}}}}
* {{Mlx|{{BASEPAGENAME}}|getShortDescription}}
* {{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 ==
== Parameter list ==
{{Transcluded section|source=Module:Television episode short description/doc}}
<section begin=Parameters/>
{{Trim|{{#section:Module:Television episode short description/doc|Parameters}}}}
The parameter names use a corresponding parameter from [[Template:Infobox television episode]] to fill in the data. They are listed below.


=== TemplateData ===
{| class="wikitable"
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
|-
{{TemplateData header|noheader=1}}
! scope="col" | Parameter
<templatedata>
! scope="col" | Corresponding infobox parameter
{
! 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.",
|-
"params": {
! scope="row" | <code>series_name</code>
"episode_num": {
| style="text-align: center;" | <code>series</code>
"label": "Episode number",
| The TV series name.
"type": "string",
|-
"required": false,
! scope="row" | <code>episode_num</code>
"suggested": true,
| style="text-align: center;" | <code>episode</code>
"deprecated": false,
| The episode's number.
"description": "The episode's number."
|-
},
! scope="row" | <code>season_num</code>
"season_num": {
| style="text-align: center;" | <code>season</code>
"label": "Season number",
| The season's number.
"type": "string",
|-
"required": false,
! scope="row" | <code>season_num_uk</code>
"suggested": true,
| style="text-align: center;" | <code>series_no</code>
"deprecated": false,
| The season's number if using the British "series" term.
"description": "The season's number."
|-
},
! scope="row" | <code>not_dab</code>
"season_num_uk": {
| style="text-align: center;" | same name
"label": "Season number UK",
| Set if the TV series name has parentheses as part of its name.
"type": "string",
|-
"required": false,
! scope="row" | <code>special</code>
"suggested": false,
| style="text-align: center;" | same name
"deprecated": 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".
"description": "The season's number if using the British \"series\" term."
|-
},
! scope="row" | <code>limited</code>
"series_name": {
| style="text-align: center;" | same name
"label": "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.
"type": "string",
|}<section end=Parameters/>
"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 ==
== Examples ==
=== No parameters ===
{{Further|Template:Television episode short description#Examples}}
* 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 ==
== Issues ==
{{Transcluded section|source=Module:Television episode short description/doc}}
<section begin=Issues/>
{{Trim|{{#section:Module:Television episode short description/doc|Issues}}}}
# 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/>


== Tracking categories ==
== Tracking categories ==
{{Transcluded section|source=Module:Television episode short description/doc}}
<section begin=Categories/>
{{Trim|{{#section:Module:Television episode short description/doc|Categories}}}}
* {{Category link with count|Television episode articles with short description with no series name}}
* {{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 ==
== See also ==
* [[Module:Television episode short description]]
* [[Template:Television episode short description]]
* [[Module:Extract short description]]
* [[Module:Television episode disambiguation description]]
* [[Module:Television episode disambiguation description]]
* [[Template:Television episode disambiguation description]]
* [[Template:Television episode disambiguation description]]


<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Television templates]]
[[Category:Television-related modules]]
 
[[Category:Modules that add a tracking category]]
[[Category:Modules that create a short description]]
[[Category:Modules that check for strip markers]]
}}</includeonly>
}}</includeonly>

Revision as of 01:03, 19 January 2023

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

Module:Television episode short description extracts data from a television episode article's Template:Infobox television episode and creates a relevant short description based on the data available.

This module implements the {{Television episode short description}} template.

Usage

Parameter list

<section begin=Parameters/> 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.

<section end=Parameters/>

Examples

Further information: Template:Television episode short description § Examples

Issues

<section begin=Issues/>

  1. 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/>

Tracking categories

<section begin=Categories/>

See also


Retrieved from "https://theglobalwiki.com/index.php?title=Template:Television_episode_short_description/doc&oldid=16432"