View source for Template:Infobox television season/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
{{High-use}}
{{Auto italic title|italic_title}}
{{Lua|Module:Infobox/dates|Module:InfoboxImage|Module:Infobox television season disambiguation check|Module:Infobox television season name|Module:Check for unknown parameters}}

'''Infobox television season''' is used to create an [[WP:Infobox|infobox]] which summarizes the main information of a particular television season.

== Usage ==
{{ {{PAGENAMETDOC}}
| italic_title         = no
| bg_colour            =
| image                = Example-serious.jpg
| image_alt            = Alt text for image
| caption              = ''caption''
| starring             = ''starring''
| country              = ''country''
| num_episodes         = ''num_episodes''
| network              = ''network''
| first_aired          = ''first_aired'' (''released'')
| last_aired           = ''last aired''
| episode_list         = episode_list
}}

<section begin=infobox /><pre style="overflow:auto;">
{{Infobox television season
| bg_colour            = <!-- Colours used must meet the contrast requirements of WP:COLOR. -->
| image                = 
| image_alt            = 
| caption              = 
| starring             = 
| country              = 
| num_episodes         = <!-- Value is incremented when new episodes air. See template documentation for more info. -->
| network              = 
| released             = <!-- {{Start date|yyyy|mm|dd|df=y}} - Only use this template once-->
| first_aired          = <!-- {{Start date|yyyy|mm|dd|df=y}} - Only use this template once -->
| last_aired           = <!-- {{End date|yyyy|mm|dd}} -->
| episode_list         = 
}}</pre><section end=infobox />

=== Parameters ===

Link people only if they have articles. For most of the fields below, if there are multiple entries, separate them using {{tl|Plainlist}} or {{tl|Unbulleted list}}. When adding data to fields, do not use small text as this reduces the size of the text to below 85% of the page font size. See [[Wikipedia:Manual of Style/Accessibility#Text]] for more information.

{| class="wikitable"
|+ Infobox television season parameters and basic guidelines
! scope="col" | Parameter
! scope="col" | Explanation
|-
! scope="row" | italic_title
| Set to {{para|italic_title|no}} if the title should not be italicized.
|-
! scope="row" | bg_colour
| A Six-digit hex code used to colour header rows. Must include a hash symbol (#) before the code. e.g. <code>#81a6e3</code>. The [[Wikipedia:Colour contrast|contrast between background and foreground colors]], if used, must meet the guidelines at [[WP:COLOR]].
|-
! scope="row" | season_name
| The name of the television season, defaults to the page name. Set this parameter to change the infobox title if it should not be the page name.
|-
! scope="row" | {{Unbulleted list|season_number|series_number}}
| The season number (The ''X''th season of this particular program), defaults to the page name. Set this parameter if the page name does not have the season number information. Typically, "series" is used for television series produced within the United Kingdom while "season" is used for American television series.
|-
! scope="row" | image
| [[Help:Files|A suitable image]] relevant to the season. The image does not need to be wikilinked and should exclude "File:" e.g. <code><nowiki>Example.png</nowiki></code> Typically the image will be the series' title card, although this is not mandated. Free content should be used where available.
|-
! scope="row" | image_size
| Width of the image in pixels, excluding "px". If not specified the image width defaults to the value explained in {{para|image_upright}}. The size should not be set greater than 300px.
|-
! scope="row" | image_upright
| Use of this parameter is preferred to using {{para|image_size}}, as it allows [[Wikipedia:Autosizing images|auto-sizing of images]] according to user preferences. By default the infobox image scales to upright=1.13 (which is 1.13 × 220 px if the default thumbnail size has not been changed at [[Special:Preferences]]). The size should not be set to a value that would result in an image width greater than 300px. See [[#Calculating "image_upright"|help below]] for guidance on determining the value to be used.
|-
! scope="row" | image_alt
| Alt text, as required by [[MOS:ALT]]. It may include wikilinks.
|-
! scope="row" | caption
| A caption explaining the image. An image of the title card including the title logo, or an image of the logo of the TV program does not need a caption.
|-
! scope="row" | native_name
| Insert the native title using the {{tl|Infobox name module}} template if it is different from the displayed title; please visit that template's page for full instructions. This parameter is for the native title only, i.e. it should not be used to add translated titles to the infobox. Example: {{nowrap|<nowiki>{{Infobox name module|ta|பாசமலர்}}</nowiki>}} will display the Tamil native name in the infobox – "ta" is the [[ISO 639|ISO 639 code]] for Tamil.
|-
! scope="row" | starring
| The season's starring cast. Separate multiple entries using {{tl|Plainlist}} or {{tl|Unbulleted list}}. Cast are listed in original credit order followed by order in which new cast joined the season.
|-
! scope="row" | module1
| A module used to insert a nested infobox.
|-
! scope="row" | country
| The TV program's country of origin. Do not use flag icons, as this places an unnecessary emphasis on nationality - see [[MOS:INFOBOXFLAG]] for a detailed rationale. Do not link to a country article, e.g., <nowiki>[[</nowiki>[[United States]]<nowiki>]]</nowiki>, per [[WP:OVERLINK]].
|-
! scope="row" | num_stories
| The number of stories released. Relevant for ''[[Doctor Who]]'' seasons.
|-
! scope="row" | num_episodes
| The number of episodes released in the season. This parameter should only be incremented when new episodes air. An inline citation is required if the total number of episodes produced is greater than the number aired, such as in the case of a TV program being cancelled.
|-
! scope="row" | network
| The original network on which the season has appeared. Do not add foreign broadcasters here. Use links if articles are available.
|-
! scope="row" | {{Unbulleted list|first_aired|released}}
| The date the season first aired on its original network ({{para|first_aired}}), or was released on [[streaming media]] sites such as [[Netflix]] ({{para|released}}). Only insert the date after it has happened. Use {{tl|Start date}} (e.g. <nowiki>{{Start date|1981|2|26}}</nowiki>) so that the date is included the template's [[hCalendar]] microformat, and is properly formatted according to a reader's Wikipedia date and time [[Special:Preferences|preferences]]. Add {{para|df|y}} if the article [[WP:DATERET|uses]] the dmy date format.
|-
! scope="row" | last_aired
| The date the season finished airing, using {{tl|End date}}. e.g. <code><nowiki>{{End date|2012|5|17}}</nowiki></code> or <code><nowiki>{{End date|2012|5|17|df=y}}</nowiki></code>. While the season is airing, <code><nowiki>{{End date|present}}</nowiki></code> should be used.
|-
! scope="row" | {{Unbulleted list|prev_season|prev_series}}
| If one exists, this field should include a wikilink to the previous season in the series. This field should be left blank if 1) no season article exists or 2) any redirect for the season does not link to a specific section regarding the season. ''Only required if the previous season link cannot be automatically generated by the template using the {{para|season_number}} parameter (e.g. [[Road Rules: South Pacific]]).''
|-
! scope="row" | {{Unbulleted list|next_season|next_series}}
| If one exists, this field should include a wikilink to the next season in the series. This field should be left blank if 1) no season article exists or 2) any redirect for the season does not link to a specific section regarding the season. ''Only required if the next season link cannot be automatically generated by the template using the {{para|season_number}} parameter (e.g. [[Road Rules: South Pacific]]).''
|-
! scope="row" | episode_list
| The name of the main episode list article for the series. If no article exists, this field should be left blank. Wikilinking is not required. The article name will be formatted and wikilinked automatically by the infobox. For example {{para|episode_list|List of NCIS episodes}} will result in [[List of NCIS episodes|List of ''NCIS'' episodes]].
|-
! scope="col" colspan="2" style="text-align:center;" | The following fields are not for general use. Data will appear underneath a header titled "Additional information".
|-
! scope="row" | module
| A module used to insert a nested infobox.
|-
! scope="row" | film_start
| The date filming of the season commenced, using {{tl|Start date}}. e.g. <code><nowiki>{{Start date|2011|1|5}}</nowiki></code>. Should include a reference if the date is not referenced in the article's prose.
|-
! scope="row" | film_end
| The date filming of the season ended, using {{tl|End date}}. e.g. <code><nowiki>{{End date|2011|3|31}}</nowiki></code>. Should include a reference if the date is not referenced in the article's prose. If {{para|film_start}} does not exist, {{para|film_end}} will not display.
|-
! scope="row" | website
| The season's relevant website link. Use {{URL|http://www.example.com}}, replacing "http://www.example.com" with the website's [[Uniform resource locator|url]].
|}

=== Controlling line-breaking in embedded bulletless lists ===
Template {{tlx|nbsp}} may be used with {{tlx|wbr}} and {{tlx|nowrap}} to control line-breaking in bulletless lists embedded in the infobox (e.g. cast and other credits lists), to prevent wrapped long entries from being confused with multiple entries. See [[Template:Wbr/doc#Controlling line-breaking in infoboxes]] for details.
{{#section:Template:Infobox Australian place/doc|image_upright}}

=== TemplateData ===
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"description": "Infobox used on articles about television seasons.",
	"params": {
		"italic_title": {
			"label": "Italic title",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Set to no if the title should not be italicized."
		},
		"bg_colour": {
			"label": "Background color",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "A Six-digit hex code used to color header rows. Must include a hash symbol (#) before the code. e.g. #81a6e3. The contrast between background and foreground colors, if used, must meet the guidelines at WP:COLOR.",
			"aliases": [
				"bg_color",
				"bgcolour",
				"bgcolor"
			]		
		},
		"season_name": {
			"label": "Season name",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The name of the television season, defaults to the page name. Set this parameter to change the infobox title if it should not be the page name."
		},
		"season_number": {
			"label": "Season number",
			"type": "number",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The season number (The ''X''th season of this particular program), defaults to the page name. Set this parameter if the page name does not have the season number information. Typically, \"series\" is used for television series produced within the United Kingdom while \"season\" is used for American television series.",
			"aliases": [
				"series_number"
			]	
		},
		"image": {
			"label": "Image",
			"type": "wiki-file-name",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "An image relevant to the season."
		},
		"image_size": {
			"label": "Image size",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Width of the image in pixels, excluding \"px\". If not specified the image width defaults to the value explained above in \"image_upright\". The size should not be set greater than 300px.",
			"aliases": [
				"imagesize"
			]
		},
		"image_upright": {
			"label": "Image upright",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Use of this parameter is preferred to using \"image_size\", as it allows auto-sizing of images according to user preferences. By default the infobox image scales to upright=1.13 (which is 1.13 × 220 px if the default thumbnail size has not been changed at Special:Preferences). The size should not be set to a value that would result in an image width greater than 300px. See help below for guidance on determining the value to be used."
		},
		"image_alt": {
			"label": "Image alt",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Alt text, as required by MOS:ALT. It may include wikilinks.",
			"aliases": [
				"alt"
			]
		},
		"caption": {
			"label": "Caption",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "A caption explaining the image. An image of the title card including the title logo, or an image of the logo of the TV program does not need a caption."
		},
        "native_name": {
			"label": "Native name",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Insert the native title using the {{tl|Infobox name module}} template if it is different from the displayed title; please visit that template's page for full instructions. This parameter is for the native title only, i.e. it should not be used to add translated titles to the infobox. Example: {{nowrap|<nowiki>{{Infobox name module|ta|பாசமலர்}}</nowiki>}} will display the Tamil native name in the infobox – \"ta\" is the [[ISO 639|ISO 639 code]] for Tamil."
		},
		"starring": {
			"label": "Starring",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The season's starring cast."
		},
		"module1": {
			"label": "Module 1",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "A module used to insert a nested infobox."
		},
		"country": {
			"label": "Country",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The TV program's country of origin."
		},
		"num_stories": {
			"label": "Number of stories",
			"type": "number",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The number of stories released. Relevant for Doctor Who seasons."
		},
		"num_episodes": {
			"label": "Number of episodes",
			"type": "number",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The number of episodes released in the season. This parameter should only be incremented when new episodes air. An inline citation is required if the total number of episodes produced is greater than the number aired, such as in the case of a TV program being cancelled."
		},
		"network": {
			"label": "Network",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The original network on which the season appeared or appears."
		},
		"released": {
			"label": "Released",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Date the season was released on streaming media sites such as Netflix."
		},
		"first_aired": {
			"label": "First aired date",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Date the season first aired on its original network."
		},
		"last_aired": {
			"label": "Last aired date",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The first air date of the season's last episode on its original network. Use \\\"present\\\" if the season is ongoing and {{End date}} if the season has ended."
		},
		"module": {
			"label": "Module",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "A module used to insert a nested infobox."
		},
		"film_start": {
			"label": "Film start date",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The date filming of the season commenced, using {{tl|Start date}}."
		},
		"film_end": {
			"label": "Film end date",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The date filming of the season ended, using {{tl|End date}}."
		},
		"website": {
			"label": "Website",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The season's relevant website link"
		},
		"prev_season": {
			"label": "Previous season article",
			"type": "wiki-page-name",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The article of the previous season in the series. Leave blank if the season article cannot be automatically generated by the template.",
			"aliases": [
				"prev_series"
			]
		},
		"next_season": {
			"label": "Next season article",
			"type": "wiki-page-name",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The article of the next season in the series. Leave blank if the season article cannot be automatically generated by the template.",
			"aliases": [
				"next_series"
			]
		},
		"episode_list": {
			"label": "List of episodes article",
			"type": "wiki-page-name",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The name of the main episode list article for the series. If no article exists, this field should be left blank. Wikilinking is not required. The article name will be formatted and wikilinked automatically by the infobox."
		}
	},
	"format": "{{_\n| ____________________ = _\n}}\n"
}
</templatedata>
{{Collapse bottom}}

=== All parameters (not for general use) ===
<pre>
{{Infobox television season
| italic_title         =
| bg_colour            = <!-- Colours used must meet the contrast requirements of WP:COLOR. -->
| season_name          = 
| season_number        = <!-- or |series_number  = -->
| image                = 
| image_size           = 
| image_upright        = 
| image_alt            = 
| caption              = 
| native_name          = 
| starring             = 
| module1              = 
| country              = 
| num_stories          = 
| num_episodes         = 
| network              = 
| released             = <!-- {{Start date|yyyy|mm|dd}} -->
| first_aired          = <!-- {{Start date|yyyy|mm|dd}} -->
| last_aired           = <!-- {{End date|yyyy|mm|dd}} -->
| module               = 
| film_start           = <!-- This field is only for use in certain articles. --><!-- {{Start date|yyyy|mm|dd}} -->
| film_end             = <!-- This field is only for use in certain articles. --><!-- {{End date|yyyy|mm|dd}} -->
| website              = <!-- {{URL|}} -->
| prev_season          = <!-- or |prev_series  = -->
| next_season          = <!-- or |next_series  = -->
| episode_list         = 
}}
</pre>

== Example ==
For use on [[The Office (American season 2)|''The Office'' (American season 2)]]:

{{Infobox television season
| italic_title     = no
| season_name      = ''The Office''
| bg_colour        = #cae2f2
| season_number    = 2
| image            = Example-serious.jpg
| image_alt        = 
| caption          = DVD cover
| starring         = {{Plainlist|
* [[Steve Carell]]
* [[Rainn Wilson]]
* [[John Krasinski]]
* [[Jenna Fischer]]
* [[B.J. Novak]]
* [[Melora Hardin]]
* [[David Denman]]
* [[Leslie David Baker]]
* [[Brian Baumgartner]]
* [[Kate Flannery]]
* [[Angela Kinsey]]
* [[Oscar Nunez]]
* [[Phyllis Smith]]
}}
| country          = United States
| num_episodes     = 22
| network          = [[NBC]]
| first_aired      = {{Start date|2005|9|20}}
| last_aired       = {{End date|2006|5|11}}
| prev_season      = [[The Office (American season 1)|Season 1]]
| next_season      = [[The Office (American season 3)|Season 3]]
| episode_list     = List of The Office (American  TV series) episodes
}}

<pre style="overflow:auto">
{{Infobox television season
| bg_colour        = #cae2f2
| image            = Example-serious.jpg
| image_alt        = 
| caption          = DVD cover
| starring         = {{Plainlist|
* [[Steve Carell]]
* [[Rainn Wilson]]
* [[John Krasinski]]
* [[Jenna Fischer]]
* [[B.J. Novak]]
* [[Melora Hardin]]
* [[David Denman]]
* [[Leslie David Baker]]
* [[Brian Baumgartner]]
* [[Kate Flannery]]
* [[Angela Kinsey]]
* [[Oscar Nunez]]
* [[Phyllis Smith]]
}}
| country          = United States
| num_episodes     = 22
| network          = [[NBC]]
| first_aired      = {{Start date|2005|9|20}}
| last_aired       = {{End date|2006|5|11}}
| episode_list     = List of The Office (American TV series) episodes
}}
</pre>
{{clear}}

== Related templates ==
* {{tl|Infobox reality competition season}} - uses a nested infobox in {{para|module1}}.

== Microformat ==
{{UF-hcal}}

== Tracking categories ==
<section begin=Tracking/>
* {{Category link with count|Pages using infobox television season with invalid colour combination}}&nbsp;– articles that use [[WP:COLOR]]-violating colour combinations (per [[Template talk:Infobox television season/Archive 3#Colour|this discussion]])
* {{Category link with count|Pages using infobox television season with unknown parameters}}&nbsp;– articles using unsupported infobox parameters
* {{Category link with count|Pages using infobox television season with the season_name parameter}}<section end=Tracking/>

== Supporting templates ==
* {{tl|Greater color contrast ratio}}
* {{tl|Ensure AAA contrast ratio}}

== See also ==
* [[Template:Episode list]] for creating an episode list.

{{Film- and television-related infobox templates}}

<includeonly>{{basepage subpage|
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Television infobox templates|Television season]]
[[Category:Infobox templates with module parameter|Television season]]
[[Category:Templates that add a tracking category]]
}}</includeonly>