Template:Aired episodes/sandbox

This is the template sandbox page for Template:Aired episodes (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template uses Lua:

Module:Aired episodes

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

{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4.5}}

As of January 1, 2016, 50 episodes of Generic Series have aired, concluding the first half 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. Add ".5" for conclusions of split seasons. Use "all" for the conclusion of the series. Format: 5 or 5.5 or all	Number / String	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[Edit template data]
Parameter		Description	Type	Status
Year	`1`	The year of the series' most recently aired episode.	Number	optional
Month	`2`	The month of the series' most recently aired episode.	Number	optional
Day	`3`	The day of the series' most recently aired episode.	Number	optional
Number	`num`	The number of episodes that have been aired up until the most recent, as a number, string or transclusion.	Number	optional
Date	`date`	The date when entered manually; the first three numbered parameters will be ignored when this is used.	Line	optional
Show's parent article	`showpage`	The unlinked parent article of the series, for usage with {{Template parameter value}} instead of using \|num=.	Page name	optional
Series	`title`	The un-italicized title of the series.	Line	required
Released	`released`	Whether the season in question has been released online, rather than aired. Example y	Line	optional
Finished	`finished`	Whether the season in question has been concluded. Add ".5" for conclusions of split seasons. Use "all" for the conclusion of the series.	Line	optional
Seasons	`seasons`	The number of seasons that a concluded series aired over. Converted to word for less than 10 seasons.	Number	optional
UK Format	`uk`	Whether the series in question follows the British format of titling and dating. Example y	Line	optional
Specials	`specials`	How many specials have been aired throughout the series.	Number	optional