Module:Series overview/doc

This is the documentation page for Module:Series overview

This is a documentation subpage for Module:Series overview.
It contains usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 5,200 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages. Consider discussing changes on the talk page before implementing them.

Transclusion count updated automatically (see documentation).

This module depends on the following other modules:

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

Basic example

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

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
	Chapter One	26	September 8, 2012 (2012-09-08)	June 15, 2013 (2013-06-15)
	Chapter Two	26	September 13, 2013 (2013-09-13)	June 21, 2014 (2014-06-21)
	Chapter Three^[1]	26	September 19, 2014 (2014-09-19)	June 26, 2015 (2015-06-26)

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

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
	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	38	13	September 19, 2014 (2014-09-19)	December 24, 2014 (2014-12-24)
			12	February 15, 2015 (2015-02-15)	June 26, 2015 (2015-06-26)
			13	November 4, 2015 (2015-11-04)	January 31, 2016 (2016-01-31)

And with the |episodes parameter set to "hide".

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	13	September 19, 2014 (2014-09-19)	December 24, 2014 (2014-12-24)
		12	February 15, 2015 (2015-02-15)	June 26, 2015 (2015-06-26)
		13	November 4, 2015 (2015-11-04)	January 31, 2016 (2016-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 and country-based header

Code

{{Series overview
| infoA      = Rank
| infoB      = Rating
| infoC      = Average viewership<br />(in millions)
| country    = U.S.

| 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 (U.S.)		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

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.

	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)

Multi-series franchise

Code

{{Series overview
| width       = 75%
| infoA       = [[Showrunner]]
| infoB       = Status
| multiseries = 
{{Series overview
| series      = ''Series A''
| infoA       = y
| infoB       = y

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

| 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}}
}}
{{Series overview
| series      = ''Series B''
| infoA       = y
| infoB       = y

| color1      = #7487E3
| link1       = #Season 1
| episodes1   = 26
| start1      = {{Start date|2015|9|21}}
| end1        = {{End date|2016|6|11}}
| infoA1      = Jane Doe
| infoB1      = Released

| color2      = #000040
| link2       = #Season 2
| episodes2   = 26
| start2      = {{Start date|2016|9|17}}
| end2        = {{End date|2017|6|30}}
| infoB2      = Airing
}}
}}

Series	Season		Episodes	Originally aired		Showrunner	Status
Series	Season		Episodes	First aired	Last aired	Showrunner	Status
Series A		1	26	September 8, 2012 (2012-09-08)	June 15, 2013 (2013-06-15)	John Smith	Released
		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)
Series B		1	26	September 21, 2015 (2015-09-21)	June 11, 2016 (2016-06-11)	Jane Doe	Released
Series B		2	26	September 17, 2016 (2016-09-17)	June 30, 2017 (2017-06-30)	Jane Doe	Airing

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}

Template parameters
Parameter			Description	Type	Status
Caption		caption	An appropriate caption for the table, normally something like "Series overview". Required for proper accessibility. 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	Required
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 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). When used in multi-series franchise overviews, set the value to the column titles in the initial declaration of the template, and set to "y" in each of the separate series overviews to still include the info cells. 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
	Country	country	Add a country to the "Originally aired/released" header cell. Format: U.S.	Text	Optional
	Network	network	The network that multiple seasons have aired under, if a series has aired on two or more networks. Only use as a header title in multi-series franchises, in the initial declaration of the template, not the season-specific networks and set to "y" in this case.	Text	Optional
	Transclusion display	*_transclude	Gives the option to toggle the display of certain columns (network and info columns are the only ones supported so far) when tranclcuding the overview. This parameter takes one of two values: 1) "onlyinclude", so the column is only included in the table when transcluded (i.e. not shown on the origin page), or 2) "noinclude", so the column is only included in the table on the origin page (i.e. not shown on the transcluding page). For the template to determine what the original article is, the original article title must be included as the first unnamed parameter (e.g. as `{{Series overview\|PAGE NAME}}` or `{{Series overview\|1=PAGE NAME}}`).	Text	Optional
Franchises	Multiple series	multiseries	The individual series overviews that make up a multi-series franchise table. Use in the first series overview that declares the headers. The parameter value should be the separate series overviews. Set to "y" when "dontclose" is declared.	Series overviews	Optional
	Series	series	The linked, italicized title of the series when used in a multi-series franchise. Use in each separate series overview.	Link	Required when multiseries is set
	Don't Close	dontclose	Set this parameter to "y" to be able to close the initial wikicode declaration of the multi-series franchise header overview, but to be able to continue displaying the separate series and rows after the header but outside of the initial declaration. Particularly useful for when the individual rows have to be transcluded outside of the article and thus must be outside of a template. To close the initial declaration, `</table>` must be used.	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. Set to "hide" for split seasons to hide the total episode count and use only the split episode counts. This is particular useful for when the episodes don't combine together; for example, a pilot episode then a full season. Setting to "hide" for regular seasons has no effect. Format: 22 Exclusion: `{{N/A\|TBA}}`	Number / Text	Optional
	Start date	start*	The start date of the season in question. This parameter is required for the row of the overview to appear; without a date but with the inclusion of any other parameter, the row will not display. To display a row without a start date, use `{{N/A\|TBA}}`. Format: `{{Start date\|2015\|3\|17}}` Exclusion: `{{N/A\|TBA}}`	Date	Required
	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) in regular series overviews. Information cells will automatically span over empty rows in multi-series franchise series overviews if set for a previous season but not included for the current season; they cannot, however, span between separate series-specific overviews, meaning information may be repeated (e.g. a "Released" status for multiple series that have been released). 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.

Module:Series overview/doc

Contents

Usage

Syntax and examples

Basic example

Alternate link text with caption and raw link text

Series/Season & "dd mmm yyyy" dates

Split season

Specials

Special first, followed by season one

Extra information and country-based header

Multiple networks

Auxiliary columns

Released

Multi-series franchise

Parameters

Navigation menu

Module:Series overview/doc

Usage

Syntax and examples

Basic example

Alternate link text with caption and raw link text

Series/Season & "dd mmm yyyy" dates

Split season

Specials

Special first, followed by season one

Extra information and country-based header

Multiple networks

Auxiliary columns

Released

Multi-series franchise

Parameters

Navigation menu

Search