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

From blackwiki
Jump to navigation Jump to search
blackwiki>Gonnym
blackwiki>Gonnym
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|11,305}}
  
 
'''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 ==
Line 52: Line 52:
  
 
== 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 59:
  
 
== 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 ==

Revision as of 13:54, 10 January 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

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 Explanation Status
episode_num episode The episode's number optional
season_num season The season's number optional
season_num_uk series_no The season's number if using the British "series" term optional
series_name series The TV series name optional
multi_episodes multi_episodes Set if the episode is a double episode optional
not_dab not_dab Set if the TV series name has parentheses as part of its name optional

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