Template:Series overview/doc

This is a documentation subpage for Template:Series overview.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:Series overview

Usage

The purpose of this template is to easily add a series overview table (as per WP:TVOVERVIEW) for television series' that require it, in either a simple format (i.e. just episodes and dates) or with extra information (e.g. networks, ratings, etc).

Syntax

Main overview

{{Series overview
| seasonT          = TEXT
| caption          = TEXT
| infoheader       = TEXT
| info{A-Z}        = TEXT

| color*           = COLOR
| link*            = TEXT
| linkT*           = TEXT
| linkR*           = TEXT
| aux{A-Z}*        = TEXT
| episodes*        = NUMBER
| start*           = DATE
| end*             = DATE
| network*         = TEXT
| info{A-Z}*       = TEXT
}}

Specials

Singular

{{Series overview
| color*S          = COLOR
| link*S           = TEXT
| linkT*S          = TEXT
| linkR*S          = TEXT
| aux{A-Z}*S       = TEXT
| episodes*S       = NUMBER
| start*S          = DATE
| end*S            = DATE
| network*S        = TEXT
| info{A-Z}*S      = TEXT
}}

Multiple

{{Series overview
| color*S{A-Z}     = COLOR
| link*S{A-Z}      = TEXT
| linkT*S{A-Z}     = TEXT
| linkR*S{A-Z}     = TEXT
| aux{A-Z}*S{A-Z}  = TEXT
| episodes*S{A-Z}  = NUMBER
| start*S{A-Z}     = DATE
| end*S{A-Z}       = DATE
| network*S{A-Z}   = TEXT
| info{A-Z}*S{A-Z} = TEXT
}}

Split season

{{Series overview
| color*           = COLOR
| link*            = TEXT
| linkT*           = TEXT
| linkR*           = TEXT
| aux{A-Z}*        = TEXT
| episodes*        = NUMBER
| network*         = TEXT
| info{A-Z}*       = TEXT

| color*{A-Z}      = COLOR
| aux{A-Z}*{A-Z}   = TEXT
| episodes*{A-Z}   = NUMBER
| start*{A-Z}      = DATE
| end*{A-Z}        = DATE
| network*{A-Z}    = TEXT
| info{A-Z}*{A-Z}  = TEXT
}}

* indicates any number that is a positive integer, starting from one for regular/split seasons, and zero for specials.

Examples

Basic example( The Garfield Show In 1989)

Code

{{Series overview
| color1     = #74E387
| link1      = #Season 1
| episodes1  = 26
| start1     = {{Start date|2012|9|8}}
| end1       = {{End date|2013|6|15}}

| color2     = #004000
| link2      = #Season 2
| episodes2  = 26
| start2     = {{Start date|2013|9|13}}
| end2       = {{End date|2014|6|21}}

| color3     = #000000
| link3      = #Season 3
| episodes3  = 26
| start3     = {{Start date|2014|9|19}}
| end3       = {{End date|2015|6|26}}
}}

Season	Episodes	Originally aired
Season	Episodes	First aired	Last aired
1	13	November 2, 1989 (1989-11-02)	March 12, 1990 (1990-03-12)
2	13	March 20, 1990 (1990-03-20)	January 1, 1991 (1991-01-01)
3	13	January 19, 1992 (1992-01-19)	April 20, 1993 (1993-04-20)
4	13	January 17, 1993 (1993-01-17)	February 2, 1995 (1995-02-02)
5^{[Cartoon Network]}	12	June 21, 1996 (1996-06-21)	February 10, 1997 (1997-02-10)
6^[Boomerang]	12	January 21, 1996 (1996-01-21)	October 24, 1996 (1996-10-24)
S	7	October 6, 1995 (1995-10-06)	August 15, 1996 (1996-08-15)

Alternate link text with caption and raw link text

Code

{{Series overview
| caption    = Series overview

| color1     = #74E387
| link1      = #Season 1
| linkT1     = Chapter One
| episodes1  = 26
| start1     = {{Start date|2012|9|8}}
| end1       = {{End date|2013|6|15}}

| color2     = #004000
| link2      = #Season 2
| linkT2     = Chapter Two
| episodes2  = 26
| start2     = {{Start date|2013|9|13}}
| end2       = {{End date|2014|6|21}}

| color3     = #000000
| link3      = #Season 3
| linkT3     = Chapter Three
| linkR3     = {{dummy ref|1}}
| episodes3  = 26
| start3     = {{Start date|2014|9|19}}
| end3       = {{End date|2015|6|26}}
}}

Series overview
Season	Episodes	Originally aired
Season	Episodes	First aired	Last aired
Pilot	1	August 21, 1992 (1992-08-21)
He’s Here!, The Blue Hedgehog	13	September 24, 1993 (1993-09-24)	June 21, 1994 (1994-06-21)
2nd Season of Speed	13	March 9, 1994 (1994-03-09)	January 7, 2000 (2000-01-07)
And Knuckles^[1]	13	June 30, 1995 (1995-06-30)	February 13, 2009 (2009-02-13)
#The Final Season^[2]	13	July 3, 1996 (1996-07-03)	February 25, 1997 (1997-02-25)
#The Bonus Season	13	June 12, 1997 (1997-06-12)	October 20, 2012 (2012-10-20)

Series/Season & "dd mmm yyyy" dates

The top-left cell displays either Series or Season, determined if the |df= parameter of the first {{Start date}} template is set. If it is included (|df=y), the cell will display Series, otherwise the cell will display Season. This can be overridden by setting either |seriesT= or |seasonT= to custom text.

Code

{{Series overview
| color1     = #74E387
| link1      = #Season 1
| episodes1  = 26
| start1     = {{Start date|2012|9|8|df=y}}
| end1       = {{End date|2013|6|15|df=y}}

| color2     = #004000
| link2      = #Season 2
| episodes2  = 26
| start2     = {{Start date|2013|9|13|df=y}}
| end2       = {{End date|2014|6|21|df=y}}

| color3     = #000000
| link3      = #Season 3
| episodes3  = 26
| start3     = {{Start date|2014|9|19|df=y}}
| end3       = {{End date|2015|6|26|df=y}}
}}

Series	Episodes	Originally aired
Series	Episodes	First aired	Last aired
1	26	8 September 2012 (2012-09-08)	15 June 2013 (2013-06-15)
2	26	13 September 2013 (2013-09-13)	21 June 2014 (2014-06-21)
3	26	19 September 2014 (2014-09-19)	26 June 2015 (2015-06-26)

Split season FT: ggks SPONGEBOB

Code

{{Series overview
| color1     = #74E387
| link1      = #Season 1
| episodes1  = 26
| start1     = {{Start date|2012|9|8}}
| end1       = {{End date|2013|6|15}}

| color2     = #004000
| link2      = #Season 2
| episodes2  = 26
| start2     = {{Start date|2013|9|13}}
| end2       = {{End date|2014|6|21}}

| link3      = #Season 3
| episodes3  = 38
| color3A    = #000000
| episodes3A = 13
| start3A    = {{Start date|2014|9|19}}
| end3A      = {{End date|2014|12|24}}
| color3B    = #00004A
| episodes3B = 12
| start3B    = {{Start date|2015|2|15}}
| end3B      = {{End date|2015|6|26}}
| color3C    = #00008A
| episodes3C = 13
| start3C    = {{Start date|2015|11|4}}
| end3C      = {{End date|2016|1|31}}
}}

Season	Episodes		Originally aired
Season	Episodes		First aired	Last aired
0	13		July 30, 1999 (1999-07-30)	August 12, 2000 (2000-08-12)
1	20		January 31, 2001 (2001-01-31)	March 15, 2002 (2002-03-15)
2	20		September 10, 2002 (2002-09-10)	April 26, 2004 (2004-04-26)
3	20		September 19, 2004 (2004-09-19)	April 26, 2006 (2006-04-26)
4	20		April 29, 2006 (2006-04-29)	February 17, 2009 (2009-02-17)
5	20		March 19, 2009 (2009-03-19)	August 26, 2010 (2010-08-26)
6	30	10	September 19, 2010 (2010-09-19)	December 24, 2010 (2010-12-24)
		10	February 15, 2011 (2011-02-15)	June 26, 2011 (2011-06-26)
		10	November 4, 2011 (2011-11-04)	January 31, 2012 (2012-01-31)
7	25		March 19, 2011 (2011-03-19)	August 26, 2012 (2012-08-26)
8	26^[25]		September 5, 2012 (2012-09-05)	December 5, 2015 (2015-12-05)
9	50		July 15, 2013 (2013-07-15)	February 20, 2016 (2016-02-20)
10	16		March 15, 2016 (2016-03-15)	January 17, 2018 (2018-01-17)
11	26^[25]		January 24, 2018 (2018-01-24)	November 25, 2018 (2018-11-25)
12	31	11	December 19, 2018 (2018-12-19)	February 24, 2019 (2019-02-24)
		10	March 31, 2019 (2019-03-31)	June 26, 2019 (2019-06-26)
		10	November 4, 2019 (2019-11-04)	January 31, 2020 (2020-01-31)

Specials

Code

{{Series overview
| color1     = #74E387
| link1      = #Season 1
| episodes1  = 26
| start1     = {{Start date|2012|9|8}}
| end1       = {{End date|2013|6|15}}

| color2     = #004000
| link2      = #Season 2
| episodes2  = 26
| start2     = {{Start date|2013|9|13}}
| end2       = {{End date|2014|6|21}}

| color3     = #000000
| link3      = #Season 3
| episodes3  = 26
| start3     = {{Start date|2014|9|19}}
| end3       = {{End date|2015|6|26}}

| color3S    = #00004A
| link3S     = #Special
| linkT3S    = S
| episodes3S = 1
| start3S    = {{Start date|2015|10|21}}
}}

Season	Episodes	Originally aired
Season	Episodes	First aired	Last aired
1	26	September 8, 2012 (2012-09-08)	June 15, 2013 (2013-06-15)
2	26	September 13, 2013 (2013-09-13)	June 21, 2014 (2014-06-21)
3	26	September 19, 2014 (2014-09-19)	June 26, 2015 (2015-06-26)
S	1	October 21, 2015 (2015-10-21)

And with the |episodes parameter removed and the link text changed.

Season	Episodes	Originally aired
Season	Episodes	First aired	Last aired
1	26	September 8, 2012 (2012-09-08)	June 15, 2013 (2013-06-15)
2	26	September 13, 2013 (2013-09-13)	June 21, 2014 (2014-06-21)
3	26	September 19, 2014 (2014-09-19)	June 26, 2015 (2015-06-26)
Special		October 21, 2015 (2015-10-21)

Special first, followed by season one

Code

{{Series overview
| color0S    = #00004A
| link0S     = #Special
| linkT0S    = S
| episodes0S = 1
| start0S    = {{Start date|2011|10|21}}

| color1     = #74E387
| link1      = #Season 1
| episodes1  = 26
| start1     = {{Start date|2012|9|8}}
| end1       = {{End date|2013|6|15}}

| color2     = #004000
| link2      = #Season 2
| episodes2  = 26
| start2     = {{Start date|2013|9|13}}
| end2       = {{End date|2014|6|21}}

| color3     = #000000
| link3      = #Season 3
| episodes3  = 26
| start3     = {{Start date|2014|9|19}}
| end3       = {{End date|2015|6|26}}
}}

Season	Episodes	Originally aired
Season	Episodes	First aired	Last aired
S	1	October 21, 2011 (2011-10-21)
1	26	September 8, 2012 (2012-09-08)	June 15, 2013 (2013-06-15)
2	26	September 13, 2013 (2013-09-13)	June 21, 2014 (2014-06-21)
3	26	September 19, 2014 (2014-09-19)	June 26, 2015 (2015-06-26)

Extra information

Code

{{Series overview
| infoheader = [[Nielsen ratings]]
| infoA      = Rank
| infoB      = Rating
| infoC      = Average viewership<br />(in millions)

| color1     = #74E387
| link1      = #Season 1
| episodes1  = 26
| start1     = {{Start date|2012|9|8}}
| end1       = {{End date|2013|6|15}}
| infoA1     = 55
| infoB1     = 11.8
| infoC1     = 3.2

| color2     = #004000
| link2      = #Season 2
| episodes2  = 26
| start2     = {{Start date|2013|9|13}}
| end2       = {{End date|2014|6|21}}
| infoA2     = 65
| infoB2     = 9.2

| color3     = #000000
| link3      = #Season 3
| episodes3  = 26
| start3     = {{Start date|2014|9|19}}
| end3       = {{End date|2015|6|26}}
| infoA3     = 63
}}

Season	Episodes	Originally aired		Rank	Rating	Average viewership (in millions)
Season	Episodes	First aired	Last aired	Rank	Rating	Average viewership (in millions)
1	26	September 8, 2012 (2012-09-08)	June 15, 2013 (2013-06-15)	55	11.8	3.2
2	26	September 13, 2013 (2013-09-13)	June 21, 2014 (2014-06-21)	65	9.2	TBA
3	26	September 19, 2014 (2014-09-19)	June 26, 2015 (2015-06-26)	63	TBA	TBA

Single column with only the |infoheader parameter.

Season	Episodes	Originally aired
Season	Episodes	First aired	Last aired
1	26	September 8, 2012 (2012-09-08)	June 15, 2013 (2013-06-15)
2	26	September 13, 2013 (2013-09-13)	June 21, 2014 (2014-06-21)
3	26	September 19, 2014 (2014-09-19)	June 26, 2015 (2015-06-26)

Multiple networks

Code

{{Series overview
| color1     = #74E387
| link1      = #Season 1
| episodes1  = 26
| start1     = {{Start date|2012|9|8}}
| end1       = {{End date|2013|6|15}}
| network1   = [[The WB]]

| color2     = #004000
| link2      = #Season 2
| episodes2  = 26
| start2     = {{Start date|2013|9|13}}
| end2       = {{End date|2014|6|21}}

| color3     = #000000
| link3      = #Season 3
| episodes3  = 26
| start3     = {{Start date|2014|9|19}}
| end3       = {{End date|2015|6|26}}
| network3   = [[The CW]]
}}

Season	Episodes	Originally aired
Season	Episodes	First aired	Last aired	Network
1	26	September 8, 2012 (2012-09-08)	June 15, 2013 (2013-06-15)	The WB
2	26	September 13, 2013 (2013-09-13)	June 21, 2014 (2014-06-21)	The WB
3	26	September 19, 2014 (2014-09-19)	June 26, 2015 (2015-06-26)	The CW

Auxiliary columns

Code

{{Series overview
| auxA       = Title
| auxB       = Stories

| color1     = #74E387
| link1      = #Season 1
| auxA1      = ''First''
| auxB1      = 13
| episodes1  = 26
| start1     = {{Start date|2012|9|8}}
| end1       = {{End date|2013|6|15}}

| color2     = #004000
| link2      = #Season 2
| auxA2      = ''Second''
| auxB2      = 14
| episodes2  = 26
| start2     = {{Start date|2013|9|13}}
| end2       = {{End date|2014|6|21}}

| color3     = #000000
| link3      = #Season 3
| auxA3      = ''Third''
| auxB3      = 15
| episodes3  = 26
| start3     = {{Start date|2014|9|19}}
| end3       = {{End date|2015|6|26}}
}}

Season	Title	Stories	Episodes	Originally aired
Season	Title	Stories	Episodes	First aired	Last aired
1	First	13	26	September 8, 2012 (2012-09-08)	June 15, 2013 (2013-06-15)
2	Second	14	26	September 13, 2013 (2013-09-13)	June 21, 2014 (2014-06-21)
3	Third	15	26	September 19, 2014 (2014-09-19)	June 26, 2015 (2015-06-26)

Released

Code

{{Series overview
| released   = y

| color1     = #74E387
| link1      = #Season 1
| episodes1  = 26
| start1     = {{Start date|2012|9|8}}
| end1       = start

| color2     = #004000
| link2      = #Season 2
| episodes2  = 26
| start2     = {{Start date|2013|9|13}}
| end2       = {{End date|2014|6|21}}

| color3     = #000000
| link3      = #Season 3
| episodes3  = 26
| start3     = {{Start date|2014|9|19}}
| end3       = start
}}

Season	Episodes	Originally released
Season	Episodes	First released	Last released
1	26	September 8, 2012 (2012-09-08)
2	26	September 13, 2013 (2013-09-13)	June 21, 2014 (2014-06-21)
3	26	September 19, 2014 (2014-09-19)

End dates omitted with the |allreleased parameter set.

Season	Episodes	Originally released
1	26	September 8, 2012 (2012-09-08)
2	26	September 13, 2013 (2013-09-13)
3	26	September 19, 2014 (2014-09-19)

Parameters

Key for alternate rows:

= Parameter available for split seasons as {parameter}* and {parameter}*{A-Z}

= Parameter available for split seasons only as {parameter}*{A-Z}

= Parameter available for specials as {parameter}*S or {parameter}*S{A-Z}

Parameter			Description	Type	Status
Caption		caption	An appropriate caption for the table, normally something like "Series overview". Required if the table is not the first or only item in the section. When a caption is not required on the page where the table is located, but is on a page where the table is transcluded, the caption may be wrapped in <includeonly> and </includeonly>.	Text	Optional
Header titles	Season/Series	seasonT	Set to change custom text in the cell where Series/Season is typically displayed. Format: Series Alternate: seriesT	Text	Optional
	Info header	infoheader	The header of the extra information (e.g. Nielsen ratings) for the series in question. If there is only one extra column of extra info, use this parameter. Format: Nielsen ratings	Text	Optional
	Info sub-headers	info{A-Z}	The sub-headers of the extra information (e.g. Viewers (in millions)) for the series in question. 26 columns are available for extra information (labelled infoA ... infoZ). Format: Viewers (in millions)	Text	Optional
	Auxiliary	aux{A-Z}	The titles of the auxiliary columns. 26 columns are available for auxiliary columns (labelled auxA ... auxZ). Format: Title	Text	Optional
Season specifics	Color	color*	The color of the season table for the season in question. Format: black / #000000	Color	Required
	Link	link*	The link to the season in question. Transclusion format: <includeonly>List of iZombie episodes</includeonly>#Season 1 (2015) Non-transclusion format: #Season 1 (2015)	Text	Required
	Link Text	linkT*	Alternate text to display in the season link rather than the season number. Format: Special	Text	Optional
	Raw Link Text	linkR*	Additional text to display next to the season link, outside of the link itself. Good for references or notes. Format: {{efn}}	Text	Optional
	Auxiliary	aux{A-Z}*	Auxiliary columns for season titles, etc. This column spans rows when succeeding auxiliary parameters are not set. Format: Coven	Text	Optional
	Episodes	episodes*	The number of episodes in the season in question. Format: 22 Exclusion: `{{N/A\|TBA}}`	Number	Optional
	Start date	start*	The start date of the season in question. Format: `{{Start date\|2015\|3\|17}}` Exclusion: `{{N/A\|TBA}}`	Date	Optional
	End date	end*	The end date of the season in question. If equal to start (i.e. the season was aired/released on the same day), the date spans over two columns. Not included if the "allreleased" parameter is set. Format: `{{End date\|2015\|6\|9}}` Exclusion: `{{N/A\|TBA}}`	Date/Text	Optional
	Network	network*	The network that multiple seasons have aired under, if a series has aired on two or more networks. The span of the network column is calculated automatically. Format: ABC	Text	Optional
	Info	info{A-Z}*	The values of the extra information (e.g. Ratings) for the season in question. Note: Information cell parameters will be automatically set to `{{N/A\|TBA}}` if set for a previous season (e.g. info1A) but not included for the current season (e.g. info2A). Format: 28	Text	Optional
Release	Released	released	Determines whether the television series in question was released online or aired. Changes "Originally/First/Last aired" to "Originally/First/Last released". Format: y	Text	Optional
Release	All Released	allreleased	Determines whether the television series has all episodes in every season released on the same day (e.g. Orange Is the New Black). Format: y	Text	Optional

* indicates any number that is a positive integer, starting from one for regular/split seasons, and zero for specials.