Template:Television episode short description/doc: Difference between revisions
Jump to navigation
Jump to search
en>Paine Ellsworth (remove High-use template from sandbox display) |
m (1 revision imported) |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
{{ | {{Lua|Module:Arguments|Module:ConvertNumeric|Module:Sort title}} | ||
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}} | {{#ifeq:{{SUBPAGENAME}}|sandbox||{{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. | ||
This module implements the {{tl|Television episode short description}} template. | |||
== Usage == | == Usage == | ||
* {{ | * {{Mlx|{{BASEPAGENAME}}|getShortDescription}} | ||
== Parameter list == | == 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. | |||
{| class="wikitable" | |||
{ | |- | ||
! scope="col" | Parameter | |||
! scope="col" | Corresponding infobox parameter | |||
! scope="col" | Description | |||
|- | |||
! scope="row" | <code>series_name</code> | |||
| style="text-align: center;" | <code>series</code> | |||
| The TV series name. | |||
|- | |||
! scope="row" | <code>episode_num</code> | |||
| style="text-align: center;" | <code>episode</code> | |||
| The episode's number. | |||
|- | |||
! scope="row" | <code>season_num</code> | |||
| style="text-align: center;" | <code>season</code> | |||
| The season's number. | |||
|- | |||
! 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. | |||
|- | |||
! scope="row" | <code>not_dab</code> | |||
| style="text-align: center;" | same name | |||
| Set if the TV series name has parentheses as part of its name. | |||
|- | |||
! scope="row" | <code>special</code> | |||
| style="text-align: center;" | 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 {{para|special|recap}} will set the text to "recap episode". | |||
|- | |||
! scope="row" | <code>limited</code> | |||
| style="text-align: center;" | 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 == | == Examples == | ||
{{Further|Template:Television episode short description#Examples}} | |||
== Issues == | == Issues == | ||
<section begin=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 == | ||
{{ | <section begin=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 == | ||
* [[ | * [[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 | <!-- Categories below this line; interwikis at Wikidata --> | ||
[[Category:Television | [[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> |
Latest revision as of 01:03, 19 January 2023
File:Lua-Logo.svg | This template uses Lua: |
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
{{#invoke:Television episode short description|getShortDescription}}
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
Issues
<section begin=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
<section begin=Categories/>
- Category:Television episode articles with short description with no series name (0)
- Category:Television episode articles with short description with no season number (0)
- Category:Television episode articles with short description with no episode number (0)
- Category:Television episode articles with short description for single episodes (0)
- Category:Television episode articles with short description for multi-part episodes (0)
- Category:Television episode articles with short description and disambiguated page names (0)
- Category:Pages using Television episode short description with unknown parameters (0)<section end=Categories/>
See also
- Template:Television episode short description
- Module:Extract short description
- Module:Television episode disambiguation description
- Template:Television episode disambiguation description