Difference between revisions of "Module:Television episode short description/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Gonnym
m (30 revisions imported)
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
{{Lua|Module:Arguments|Module:ConvertNumeric|Module:Sort title}}
 
{{Lua|Module:Arguments|Module:ConvertNumeric|Module:Sort title}}
{{High-use| 11,305 }}
+
{{High-use}}
  
 
'''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.
 
'''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.
Line 8: Line 8:
  
 
== Usage ==
 
== Usage ==
* <code><nowiki>{{#invoke:Television episode short description|getShortDescription|episode_num= |season_num= |season_num_uk=  |series_name= |multi_episodes= |not_dab= }}</nowiki></code>
+
* {{Mlx|{{BASEPAGENAME}}|getShortDescription}}
  
 
== Parameter list ==
 
== Parameter list ==
The parameter names use a corresponding parameter from [[Template:Infobox television episode]] to fill in the data. They are listed below.
+
<section begin=Parameters/>
 
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
 
! scope="col" | Parameter
 
! scope="col" | Parameter
! scope="col" | Corresponding infobox parameter
 
 
! scope="col" | Explanation
 
! scope="col" | Explanation
! scope="col" | Status
+
|-<noinclude>
|-
+
! scope="row" | <code>series_name</code>
 +
| The TV series name.
 +
|-</noinclude>
 
! scope="row" | <code>episode_num</code>
 
! scope="row" | <code>episode_num</code>
| style="text-align:center;" | <code>episode</code>
+
| The episode's number.
| The episode's number
 
| optional
 
 
|-
 
|-
 
! scope="row" | <code>season_num</code>
 
! scope="row" | <code>season_num</code>
| style="text-align:center;" | <code>season</code>
+
| The season's number.
| The season's number
 
| optional
 
 
|-
 
|-
 
! scope="row" | <code>season_num_uk</code>
 
! 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.
| 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>
 
! scope="row" | <code>multi_episodes</code>
| style="text-align:center;" | <code>multi_episodes</code>
+
| Set if the episode is a multi-part episode. Will use the value as the number of parts. Setting "yes" will default to a two-part episode.
| Set if the episode is a double episode
 
| optional
 
 
|-
 
|-
 
! scope="row" | <code>not_dab</code>
 
! 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
 
| Set if the TV series name has parentheses as part of its name
| optional
+
|-
|}
+
! scope="row" | <code>special</code>
 +
| 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".
 +
|-
 +
! scope="row" | <code>single_season</code>
 +
| Set if the series is a single season series, such as a companion web series, a miniseries or a limited series and does not need "1st season" as part of the description.
 +
|}<section end=Parameters/>
  
 
== Examples ==
 
== Examples ==
 
+
{{Further|Template:Television episode short description#Examples}}
=== An empty infobox ===
 
* Code: <code><nowiki>{{#invoke:Television episode short description|getShortDescription}}</nowiki></code>
 
* Produces: <code>{{#invoke:Television episode short description|getShortDescription|doc=yes}}</code>
 
 
 
=== An infobox with only the TV series name ===
 
* Code: <code><nowiki>{{#invoke:Television episode short description|getShortDescription|series_name=Lost}}</nowiki></code>
 
* Produces: <code>{{#invoke:Television episode short description|getShortDescription|doc=yes|series_name=Lost}}</code>
 
 
 
=== An infobox with the TV series name and season number ===
 
* Code: <code><nowiki>{{#invoke:Television episode short description|getShortDescription|series_name=Lost|season_num=1}}</nowiki></code>
 
* Produces: <code>{{#invoke:Television episode short description|getShortDescription|doc=yes|series_name=Lost|season_num=1}}</code>
 
 
 
=== An infobox with the TV series name, episode and season number ===
 
* Code: <code><nowiki>{{#invoke:Television episode short description|getShortDescription|series_name=Lost|season_num=5|episode_num=4}}</nowiki></code>
 
* Produces: <code>{{#invoke:Television episode short description|getShortDescription|doc=yes|series_name=Lost|season_num=5|episode_num=4}}</code>
 
 
 
=== An infobox with the TV series name with disambiguation, episode and season number ===
 
* Code: <code><nowiki>{{#invoke:Television episode short description|getShortDescription|series_name=[[Firefly (TV series)|Firefly]]|season_num=1|episode_num=1}}</nowiki></code>
 
* Produces: <code>{{#invoke:Television episode short description|getShortDescription|doc=yes|series_name=[[Firefly (TV series)|Firefly]]|season_num=1|episode_num=1}}</code>
 
 
 
=== An infobox with a multi-episode ===
 
* Code: <code><nowiki>{{#invoke:Television episode short description|getShortDescription|series_name=Lost|season_num=3|episode_num=22 and 23|multi_episodes=yes}}</nowiki></code>
 
* Produces: <code>{{#invoke:Television episode short description|getShortDescription|doc=yes|series_name=Lost|season_num=3|episode_num=22 and 23|multi_episodes=yes}}</code>
 
 
 
=== An infobox with a TV series name that has parentheses as part of its name ===
 
* Code: <code><nowiki>{{#invoke:Television episode short description|getShortDescription|series_name=Randall and Hopkirk (Deceased)|season_num=1|episode_num=1|not_dab=yes}}</nowiki></code>
 
* Produces: <code>{{#invoke:Television episode short description|getShortDescription|doc=yes|series_name=Randall and Hopkirk (Deceased)|season_num=1|episode_num=1|not_dab=yes}}</code>
 
  
 
== Issues ==
 
== Issues ==
Line 86: Line 50:
  
 
== Tracking categories ==
 
== Tracking categories ==
* {{clc|Category:Television episode articles with short description with no series name}}
+
* {{Category link with count|Category:Television episode articles with short description with no series name}}
* {{clc|Category:Television episode articles with short description with no season number}}
+
* {{Category link with count|Category:Television episode articles with short description with no season number}}
* {{clc|Category:Television episode articles with short description with no episode number}}
+
* {{Category link with count|Category:Television episode articles with short description with no episode number}}
* {{clc|Category:Television episode articles with short description for single episodes}}
+
* {{Category link with count|Category:Television episode articles with short description for single episodes}}
* {{clc|Category:Television episode articles with short description for multi-part episodes}}
+
* {{Category link with count|Category:Television episode articles with short description for multi-part episodes}}
* {{clc|Category:Television episode articles with short description and disambiguated page names}}
+
* {{Category link with count|Category:Television episode articles with short description and disambiguated page names}}
  
 
== See also ==
 
== See also ==

Latest revision as of 17:18, 29 September 2020

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

Parameter Explanation
series_name The TV series name.
episode_num The episode's number.
season_num The season's number.
season_num_uk The season's number if using the British "series" term.
multi_episodes Set if the episode is a multi-part episode. Will use the value as the number of parts. Setting "yes" will default to a two-part episode.
not_dab Set if the TV series name has parentheses as part of its name
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 |special=recap will set the text to "recap episode".
single_season Set if the series is a single season series, such as a companion web series, a miniseries or a limited series and does not need "1st season" as part of the description.

<section end=Parameters/>

Examples

Issues

  1. If "multi_episodes" is set, make sure there are 2 episodes listed in the episode list, or it won't work. Supported styles are: x and y, x, y, x / y and x & y.
  2. 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

See also