View source for Template:Aired episodes/doc

{{Documentation subpage}}
{{Lua|Module:Aired episodes}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

==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.

===Syntax===
: <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>

* 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.
* 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>.
* 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.

====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"
! colspan="2" | 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.<br />''Format:'' YYYY/MM/DD
| 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)
|-
! Date (finale)
| 4–6
| The year (4), month (5) and day (6) of the series' finale date.<br />''Format:'' YYYY/MM/DD
| 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)
|-
! Number
| num
| 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
| 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
| 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
| String
| 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
| 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
| 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
|-
! UK Format
| uk
| 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
| 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
|}

==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|Template:Aired episodes using equal showpage and title parameters}}
* {{Category link with count|Template:Aired episodes using both showpage and title parameters}}<section end=Tracking/>

== See also ==
{{tl|Franchise total episodes}} – for franchises

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