Jump to content

Template:Aired episodes/doc: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
No edit summary
See also: bypass redirect
 
(45 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{Lua|Module:Aired episodes}}
<!-- 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]]) -->

== Usage ==
==Usage==
The purpose of the '''{{tl|Aired episodes}}''' template is to add a formatted string to ''List of ... episodes'' pages for television series, displaying the date of the last episode, the number of episodes that have aired in the series, and whether a season has recently finished.
The purpose of the '''{{tl|Aired episodes}}''' template is to add a formatted string to ''List of ... episodes'' pages for television series, displaying the date of the last episode, the number of episodes that have aired in the series, and whether a season has recently finished.


===Syntax===
===Syntax===
* {{tlx|Aired episodes|YEAR|MONTH|DAY|num{{=}}NUMBER|title{{=}}SERIES NAME}}
: <syntaxhighlight lang="wikitext">{{Aired episodes|YEAR|MONTH|DAY|num=NUMBER|showpage=SERIES PARENT ARTICLE|title=SERIES NAME|finished=SEASON|finished_part=NUMBER|finished_half=TEXT|airing=SEASON|uk=TEXT|part=TEXT|YEAR|MONTH|DAY}}</syntaxhighlight>
* {{tlx|Aired episodes|YEAR|MONTH|DAY|num{{=}}NUMBER|title{{=}}SERIES NAME|finished{{=}}FINISHED SEASON}}


* If {{para|num}} is set, then it can either be set using a number, or transcluding the {{para|num_episodes}} parameter from {{tl|Infobox television}} in the series' parent article using <<nowiki />onlyinclude><<nowiki />/onlyinclude>. Setting {{para|num}} takes precedence.
;Examples
* If {{para|num}} is not included, then {{para|showpage}} is set to the series' parent article, and the template gains the value of the {{para|num_episodes}} parameter from {{tl|Infobox television}} in the series' parent article ''without'' the need for <<nowiki />onlyinclude><<nowiki />/onlyinclude>.
* {{tlx|Aired episodes|2015|6|7|num{{=}}49|title{{=}}Game of Thrones}}:
* If neither {{para|num}} or {{para|showpage}} are set, then the template assumes {{para|showpage}} is set with the value of {{para|title}}; this can be used for where the series' title and series' parent article title are the same.
:: {{Aired episodes|2015|6|7|num=49|title=Game of Thrones}}
* {{tlx|Aired episodes|2015|6|14|num{{=}}50|title{{=}}Game of Thrones|finished{{=}}fifth}}:
:: {{Aired episodes|2015|6|14|num=50|title=Game of Thrones|finished=fifth}}
* {{tlx|Aired episodes|2014|12|25|num{{=}}813|title{{=}}Doctor Who|finished{{=}}ninth|uk=y}}:
:: {{Aired episodes|2014|12|25|num=813|title=Doctor Who|finished=ninth|uk=y}}


== Parameters==
====Examples====
; General
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|num=50|title=Generic Series}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|num=50|title=Generic Series}}
; Airing season
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|num=50|title=Generic Series|airing=4}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|num=50|title=Generic Series|airing=4}}
; Concluded season
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4}}
; Partial season (half)
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|finished_half=y}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|finished_half=y}}
; Partial season (parts)
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|finished_part=2}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|finished_part=2}}
; Parts instead of seasons
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|part=y}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|part=y}}
; British English
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|uk=y}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|uk=y}}
; Concluded series
: <syntaxhighlight lang="wikitext">{{Aired episodes|num=50|title=Generic Series|finished=all|seasons=4}}</syntaxhighlight>
: {{Aired episodes|num=50|title=Generic Series|finished=all|seasons=4}}
; Concluded series with dates
: <syntaxhighlight lang="wikitext">{{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4}}</syntaxhighlight>
: {{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4}}
: <syntaxhighlight lang="wikitext">{{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4|uk=y}}</syntaxhighlight>
: {{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4|uk=y}}
; Released
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|num=50|title=Generic Series|released=y}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|num=50|title=Generic Series|released=y}}
; Specials
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|num=50|title=Generic Series|specials=2}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|num=50|title=Generic Series|specials=2}}
; Show page
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|showpage=Lucifer (TV series)}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|showpage=Lucifer (TV series)}}
; Show page (showpage = title)
: <syntaxhighlight lang="wikitext">{{Aired episodes|2016|1|1|title=Game of Thrones}}</syntaxhighlight>
: {{Aired episodes|2016|1|1|title=Game of Thrones}}

==Parameters==
{| class="wikitable"
{| class="wikitable"
! colspan="2" | Parameter
! colspan="2" | Parameter
Line 23: Line 63:
! Status
! Status
|-
|-
! Date (most recent or premiere)
! Year
| 1
| 1–3
| The year that the statement is valid to.<br />''Format:'' YYYY
| The year (1), month (2) and day (3) of the series' most recently aired episode or premiere date.<br />''Format:'' YYYY/MM/DD
| Number
| Number
| Optional/Required<br />Required for airing series (ignored when date set), Optional when "finished" equals "all" (inclusion will list date as a premiere date)
| Required
|-
|-
! Date (finale)
! Month
| 2
| 4–6
| The month that the statement is valid to.<br />''Format:'' M / MM
| The year (4), month (5) and day (6) of the series' finale date.<br />''Format:'' YYYY/MM/DD
| Number
| Number
| Optional/Required<br />Not required for airing series, Optional when "finished" equals "all" but required if 1–3 parameters are set (inclusion will list date as a finale date)
| Required
|-
! Day
| 3
| The day that the statement is valid to.<br />''Format:'' D / DD
| Number
| Required
|-
|-
! Number
! Number
| num
| num
| The number of episodes that the statement is valid to.<br />''Format:'' 9 / nine
| The number of episodes that have been aired up until the most recent, as a number, string or transclusion.<br />''Format:'' 9 / nine
| Number/String
| Number/String
| Required
| Optional/Required
|-
! Date
| date
| The date when entered manually; the first three numbered parameters will be ignored when this is used.<br />''Format:'' June 23, 2018
| String
| Optional
|-
! Show's parent article
| showpage
| The unlinked parent article of the series, for usage with {{tl|Template parameter value}} instead of using {{para|num}} (see explanation in syntax). {{para|title}} does not need to be used when {{para|showpage}} is used, as the template will automatically derive the series name from this parameter using {{tl|PAGENAMEBASE}}.<br />''Format:'' Lucifer (TV series)
| String
| Optional
|-
|-
! Series
! Series
| title
| title
| The un-italicized title of the series. {{para|title}} does not need to be used when {{para|showpage}} is used, as the template will automatically derive the series name from this parameter using {{tl|PAGENAMEBASE}}. Using {{para|title}} without {{para|showpage}} will set {{para|showpage}} (i.e. the show's parent article) to the value of {{para|title}}.<br />''Format:'' Game of Thrones
| The title of the series that the statement is valid to.<br />''Format:'' Game of Thrones (no italics)
| String
| String
| Required
| Required
|-
! Released
| released
| Whether the season in question has been released online, rather than aired.<br />''Format:'' y
| String
| Optional
|-
! Airing
| airing
| Whether the season in question is currently airing.<br />''Format:'' 5
| Number
| Optional
|-
|-
! Finished
! Finished
| finished
| finished
| Whether the season in question that the statement is valid to has been concluded.<br />''Format:'' fifth (ordinal)
| Whether the season in question has been concluded. <br>Use "all" for the conclusion of the series.<br />''Format:'' 5 or all
| Number / String
| Optional
|-
! Finished (halfed season)
| finished_half
| Whether the season in question has paused at its halfway break, for seasons in two distinct halves. Set to "y".<br />''Format:'' y
| String
| String
| Optional
|-
! Finished (parted season)
| finished_part
| If the season in question has paused after a distinct part, this value is the number of that concluded part. <br />''Format:'' 2
| Number
| Optional
|-
! Seasons
| seasons
| The number of seasons that a concluded series aired over. Converted to word for less than 10 seasons.<br />''Format:'' 3
| Number
| Optional
| Optional
|-
|-
! UK Format
! UK Format
| uk
| uk
| Whether the series in question that the statement is valid to follows the British format of titling and dating.<br />''Format:'' y / <blank>
| Whether the series in question follows the British format of titling and dating. Use {{para|df|y}} to change the date format to DMY but not change the terminology.<br />''Format:'' Text / <blank>
| String
| String
| Optional
|-
! Part
| part
| Use the term "part" as opposed to "season", especially for Netflix series that are released specifically in parts.<br />''Format:'' Text / <blank>
| String
| Optional
|-
! Specials
| specials
| How many specials have been aired throughout the series.<br />''Format:'' 1 or one
| Number / String
| Optional
| Optional
|}
|}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
"params": {
"1": {
"label": "Year",
"description": "The year of the series' most recently aired episode.",
"type": "number"
},
"2": {
"label": "Month",
"description": "The month of the series' most recently aired episode.",
"type": "number"
},
"3": {
"label": "Day",
"description": "The day of the series' most recently aired episode.",
"type": "number"
},
"finished": {
"label": "Finished",
"description": "Whether the season in question has been concluded. Add \".5\" for conclusions of split seasons. Use \"all\" for the conclusion of the series.",
"type": "line"
},
"finished_half": {
"label": "Finished (halfed season)",
"description": "Whether the season in question has paused at its halfway break, for seasons in two distinct halves. Set to \"y\".",
"type": "line"
},
"finished_part": {
"label": "Finished (parted season)",
"description": "If the season in question has paused after a distinct part, this value is the number of that concluded part.",
"type": "number"
},
"uk": {
"label": "UK Format",
"description": "Whether the series in question follows the British format of titling and dating.",
"example": "y",
"type": "line"
},
"date": {
"label": "Date",
"description": "The date when entered manually; the first three numbered parameters will be ignored when this is used.",
"type": "line"
},
"num": {
"label": "Number",
"description": "The number of episodes that have been aired up until the most recent, as a number, string or transclusion.",
"type": "number"
},
"showpage": {
"label": "Show's parent article",
"description": "The unlinked parent article of the series, for usage with {{Template parameter value}} instead of using |num=.",
"type": "wiki-page-name"
},
"title": {
"label": "Series",
"description": "The un-italicized title of the series.",
"type": "line",
"required": true
},
"released": {
"label": "Released",
"description": "Whether the season in question has been released online, rather than aired.",
"example": "y",
"type": "line"
},
"specials": {
"label": "Specials",
"description": "How many specials have been aired throughout the series.",
"type": "number"
},
"seasons": {
"label": "Seasons",
"description": "The number of seasons that a concluded series aired over. Converted to word for less than 10 seasons.",
"type": "number"
}
},
"description": "The purpose of the {{Aired episodes}} template is to add a formatted string to List of ... episodes pages for television series, displaying the date of the last episode, the number of episodes that have aired in the series, and whether a season has recently finished.",
"paramOrder": [
"1",
"2",
"3",
"num",
"date",
"showpage",
"title",
"released",
"finished",
"finished_half",
"finished_part",
"seasons",
"uk",
"specials"
]
}
</templatedata>

== Tracking categories ==
<section begin=Tracking/>
* {{Category link with count|Aired episodes using equal showpage and title parameters}}
* {{Category link with count|Aired episodes using both showpage and title parameters}}<section end=Tracking/>

== See also ==
{{tl|Television franchise episode count}} – for franchises

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Television templates]]
}}</includeonly>

Latest revision as of 10:30, 19 December 2024

Usage

[edit]

The purpose of the {{Aired episodes}} template is to add a formatted string to List of ... episodes pages for television series, displaying the date of the last episode, the number of episodes that have aired in the series, and whether a season has recently finished.

Syntax

[edit]
{{Aired episodes|YEAR|MONTH|DAY|num=NUMBER|showpage=SERIES PARENT ARTICLE|title=SERIES NAME|finished=SEASON|finished_part=NUMBER|finished_half=TEXT|airing=SEASON|uk=TEXT|part=TEXT|YEAR|MONTH|DAY}}
  • If |num= is set, then it can either be set using a number, or transcluding the |num_episodes= parameter from {{Infobox television}} in the series' parent article using <onlyinclude></onlyinclude>. Setting |num= takes precedence.
  • If |num= is not included, then |showpage= is set to the series' parent article, and the template gains the value of the |num_episodes= parameter from {{Infobox television}} in the series' parent article without the need for <onlyinclude></onlyinclude>.
  • If neither |num= or |showpage= are set, then the template assumes |showpage= is set with the value of |title=; this can be used for where the series' title and series' parent article title are the same.

Examples

[edit]
General
{{Aired episodes|2016|1|1|num=50|title=Generic Series}}
As of January 1, 2016, 50 episodes of Generic Series have aired.
Airing season
{{Aired episodes|2016|1|1|num=50|title=Generic Series|airing=4}}
As of January 1, 2016, 50 episodes of Generic Series have aired, currently in its fourth season.
Concluded season
{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4}}
As of January 1, 2016, 50 episodes of Generic Series have aired, concluding the fourth season.
Partial season (half)
{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|finished_half=y}}
As of January 1, 2016, 50 episodes of Generic Series have aired, concluding the first half of the fourth season.
Partial season (parts)
{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|finished_part=2}}
As of January 1, 2016, 50 episodes of Generic Series have aired, concluding the second part of the fourth season.
Parts instead of seasons
{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|part=y}}
As of January 1, 2016, 50 episodes of Generic Series have aired, concluding the fourth part.
British English
{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|uk=y}}
As of 1 January 2016, 50 episodes of Generic Series have aired, concluding the fourth series.
Concluded series
{{Aired episodes|num=50|title=Generic Series|finished=all|seasons=4}}
During the course of the series, 50 episodes of Generic Series aired over four seasons.
Concluded series with dates
{{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4}}
During the course of the series, 50 episodes of Generic Series aired over four seasons, between December 31, 2014, and January 1, 2016.
{{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4|uk=y}}
During the course of the programme, 50 episodes of Generic Series aired over four series, between 31 December 2014 and 1 January 2016.
Released
{{Aired episodes|2016|1|1|num=50|title=Generic Series|released=y}}
As of January 1, 2016, 50 episodes of Generic Series have been released.
Specials
{{Aired episodes|2016|1|1|num=50|title=Generic Series|specials=2}}
As of January 1, 2016, 50 episodes of Generic Series have aired, including two specials.
Show page
{{Aired episodes|2016|1|1|showpage=Lucifer (TV series)}}
As of January 1, 2016, 93 episodes of Lucifer have aired.
Show page (showpage = title)
{{Aired episodes|2016|1|1|title=Game of Thrones}}
As of January 1, 2016, 73 episodes of Game of Thrones have aired.

Parameters

[edit]
Parameter Description Type Status
Date (most recent or premiere) 1–3 The year (1), month (2) and day (3) of the series' most recently aired episode or premiere date.
Format: YYYY/MM/DD
Number Optional/Required
Required for airing series (ignored when date set), Optional when "finished" equals "all" (inclusion will list date as a premiere date)
Date (finale) 4–6 The year (4), month (5) and day (6) of the series' finale date.
Format: YYYY/MM/DD
Number Optional/Required
Not required for airing series, Optional when "finished" equals "all" but required if 1–3 parameters are set (inclusion will list date as a finale date)
Number num The number of episodes that have been aired up until the most recent, as a number, string or transclusion.
Format: 9 / nine
Number/String Optional/Required
Date date The date when entered manually; the first three numbered parameters will be ignored when this is used.
Format: June 23, 2018
String Optional
Show's parent article showpage The unlinked parent article of the series, for usage with {{Template parameter value}} instead of using |num= (see explanation in syntax). |title= does not need to be used when |showpage= is used, as the template will automatically derive the series name from this parameter using {{PAGENAMEBASE}}.
Format: Lucifer (TV series)
String Optional
Series title The un-italicized title of the series. |title= does not need to be used when |showpage= is used, as the template will automatically derive the series name from this parameter using {{PAGENAMEBASE}}. Using |title= without |showpage= will set |showpage= (i.e. the show's parent article) to the value of |title=.
Format: Game of Thrones
String Required
Released released Whether the season in question has been released online, rather than aired.
Format: y
String Optional
Airing airing Whether the season in question is currently airing.
Format: 5
Number Optional
Finished finished Whether the season in question has been concluded.
Use "all" for the conclusion of the series.
Format: 5 or all
Number / String Optional
Finished (halfed season) finished_half Whether the season in question has paused at its halfway break, for seasons in two distinct halves. Set to "y".
Format: y
String Optional
Finished (parted season) finished_part If the season in question has paused after a distinct part, this value is the number of that concluded part.
Format: 2
Number Optional
Seasons seasons The number of seasons that a concluded series aired over. Converted to word for less than 10 seasons.
Format: 3
Number Optional
UK Format uk Whether the series in question follows the British format of titling and dating. Use |df=y to change the date format to DMY but not change the terminology.
Format: Text / <blank>
String Optional
Part part Use the term "part" as opposed to "season", especially for Netflix series that are released specifically in parts.
Format: Text / <blank>
String Optional
Specials specials How many specials have been aired throughout the series.
Format: 1 or one
Number / String Optional

TemplateData

[edit]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Aired episodes in articles based on its TemplateData.

TemplateData for Aired episodes

The purpose of the {{Aired episodes}} template is to add a formatted string to List of ... episodes pages for television series, displaying the date of the last episode, the number of episodes that have aired in the series, and whether a season has recently finished.

Template parameters

ParameterDescriptionTypeStatus
Year1

The year of the series' most recently aired episode.

Numberoptional
Month2

The month of the series' most recently aired episode.

Numberoptional
Day3

The day of the series' most recently aired episode.

Numberoptional
Numbernum

The number of episodes that have been aired up until the most recent, as a number, string or transclusion.

Numberoptional
Datedate

The date when entered manually; the first three numbered parameters will be ignored when this is used.

Lineoptional
Show's parent articleshowpage

The unlinked parent article of the series, for usage with {{Template parameter value}} instead of using |num=.

Page nameoptional
Seriestitle

The un-italicized title of the series.

Linerequired
Releasedreleased

Whether the season in question has been released online, rather than aired.

Example
y
Lineoptional
Finishedfinished

Whether the season in question has been concluded. Add ".5" for conclusions of split seasons. Use "all" for the conclusion of the series.

Lineoptional
Finished (halfed season)finished_half

Whether the season in question has paused at its halfway break, for seasons in two distinct halves. Set to "y".

Lineoptional
Finished (parted season)finished_part

If the season in question has paused after a distinct part, this value is the number of that concluded part.

Numberoptional
Seasonsseasons

The number of seasons that a concluded series aired over. Converted to word for less than 10 seasons.

Numberoptional
UK Formatuk

Whether the series in question follows the British format of titling and dating.

Example
y
Lineoptional
Specialsspecials

How many specials have been aired throughout the series.

Numberoptional

Tracking categories

[edit]

See also

[edit]

{{Television franchise episode count}} – for franchises