Jump to content

Template:Infobox television season/doc

From Wikipedia, the free encyclopedia

Infobox television season is used to create an infobox which summarizes the main information of a particular television season.

Usage

[edit]
no
Alt text for image
caption
Showrunnershowrunner
Starringstarring
No. of episodesnum_episodes
Release
Original networknetwork
Original releasefirst_aired –
last aired


{{Infobox television season
| bg_colour      = <!-- Colours used must meet the contrast requirements of WP:COLOR. -->
| image          = 
| image_alt      = 
| caption        = 
| showrunner     = 
| starring       = 
| 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   = 
}}


Maintenance

[edit]

If you encounter a usage of the template which you want to quickly restore to the above standard, use {{subst:Infobox television season/subst}}.

Parameters

[edit]

Link people only if they have articles. For most of the fields below, if there are multiple entries, separate them using {{Plainlist}} or {{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.

Infobox television season parameters and basic guidelines
Parameter Explanation
italic_title Set to |italic_title=no if the title should not be italicized.
  • bg_color
  • bg_colour
A Six-digit hex code used to colour 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.
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.
  • season_number
  • series_number
The season number (The Xth 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.
image A suitable image relevant to the season. The image does not need to be wikilinked and should exclude "File:" e.g. Example.png Typically the image will be the series' title card, although this is not mandated. Free content should be used where available.
image_size Width of the image in pixels, excluding "px". If not specified the image width defaults to the value explained in |image_upright=. The size should not be set greater than 300px.
image_upright 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 (which is 1 × 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 Alt text, as required by MOS:ALT. It may include wikilinks.
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.
native_name Insert the native title using the {{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: {{Infobox name module|ta|பாசமலர்}} will display the Tamil native name in the infobox – "ta" is the ISO 639 code for Tamil.
showrunner The season's showrunner or showrunners. Only to be used when a reliable source can verify that this position is used on a particular series or season.
starring The season's starring cast. Separate multiple entries using {{Plainlist}} or {{Unbulleted list}}. Cast are listed in original credit order followed by order in which new cast joined the season.
module1 A module used to insert a nested infobox.
num_stories The number of stories released. Relevant for Doctor Who seasons.
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.
network The original network on which the season has appeared. Do not add foreign broadcasters here. Use links if articles are available.
  • first_aired
  • released
The date the season first aired on its original network (|first_aired=), or was released on streaming media sites such as Netflix (|released=). Only insert the date after it has happened. Use {{Start date}} (e.g. {{Start date|1981|2|26}}) so that the date is included the template's hCalendar microformat, and is properly formatted according to a reader's Wikipedia date and time preferences. Add |df=y if the article uses the dmy date format. For separate date ranges, use the additional parameters |first_aired2= and |first_aired3= (or |released2= and |released3=).
last_aired The date the season finished airing, using {{End date}}. e.g. {{End date|2012|5|17}} or {{End date|2012|5|17|df=y}}. While the season is airing, {{End date|present}} should be used. For separate date ranges, use the additional parameters |last_aired2= and |last_aired3=.
  • 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 |season_number= parameter (e.g. Road Rules: South Pacific).
  • 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 |season_number= parameter (e.g. Road Rules: South Pacific).
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 |episode_list=List of NCIS episodes will result in List of NCIS episodes.
The following fields are not for general use. Data will appear underneath a header titled "Additional information".
module A module used to insert a nested infobox.
film_start The date filming of the season commenced, using {{Start date}}. e.g. {{Start date|2011|1|5}}. Should include a reference if the date is not referenced in the article's prose.
film_end The date filming of the season ended, using {{End date}}. e.g. {{End date|2011|3|31}}. Should include a reference if the date is not referenced in the article's prose. If |film_start= does not exist, |film_end= will not display.

Controlling line-breaking in embedded bulletless lists

[edit]

Template {{nbsp}} may be used with {{wbr}} and {{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.

Calculating "image_upright"

[edit]

The |image_upright= parameter, and |image2_upright= and |logo_upright= where applicable, are provided so as to facilitate the use of scalable images in this infobox, in accordance with the instructions at WP:IMAGESIZE, which advises against the use of "px" (for example: thumb|300px), as this forces a fixed image width.

Scalable images respect the user's base preference, which may have been selected for that user's particular devices. Module:InfoboxImage, which is used in this infobox, accommodates the use of scaling. However, setting the appropriate scale is slightly more complex than setting a raw "px" value. This guide provides a quick conversion table to make the process of setting a scale easier. It is based on a default thumbnail setting of 220px.

  • 170pxupright=0.75
  • 180pxupright=0.8
  • 190pxupright=0.85
  • 200pxupright=0.9
  • 210pxupright=0.95
  • 220pxupright=1
  • 230pxupright=1.05
  • 240pxupright=1.1
  • 250pxupright=1.15
  • 260pxupright=1.2
  • 270pxupright=1.23
  • 280pxupright=1.25
  • 290pxupright=1.3
  • 300pxupright=1.35

TemplateData

[edit]
TemplateData documentation used by VisualEditor and other tools
See a monthly parameter usage report for Template:Infobox television season in articles based on its TemplateData.

TemplateData for Infobox television season

Infobox used on articles about television seasons.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Italic titleitalic_title

Set to no if the title should not be italicized.

Stringoptional
Background colorbg_colour bg_color bgcolour bgcolor

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.

Stringoptional
Season nameseason_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.

Stringoptional
Season numberseason_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.

Numberoptional
Imageimage

An image relevant to the season.

Fileoptional
Image sizeimage_size

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.

Numberoptional
Image uprightimage_upright

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 (which is 1 × 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.

Numberoptional
Image altimage_alt alt

Alt text, as required by MOS:ALT. It may include wikilinks.

Stringoptional
Captioncaption

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.

Stringoptional
Native namenative_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.

Stringoptional
Showrunnershowrunner

The season's showrunner or showrunners.

Stringoptional
Starringstarring

The season's starring cast.

Stringoptional
Module 1module1

A module used to insert a nested infobox.

Stringoptional
Number of storiesnum_stories

The number of stories released. Relevant for Doctor Who seasons.

Numberoptional
Number of episodesnum_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.

Numberoptional
Networknetwork

The original network on which the season appeared or appears.

Stringoptional
Releasedreleased

Date the season was released on streaming media sites such as Netflix.

Dateoptional
First aired datefirst_aired

Date the season first aired on its original network.

Dateoptional
Last aired datelast_aired

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.

Dateoptional
Modulemodule

A module used to insert a nested infobox.

Stringoptional
Film start datefilm_start

The date filming of the season commenced, using {{tl|Start date}}.

Dateoptional
Film end datefilm_end

The date filming of the season ended, using {{tl|End date}}.

Dateoptional
Previous season articleprev_season prev_series

The article of the previous season in the series. Leave blank if the season article cannot be automatically generated by the template.

Page nameoptional
Next season articlenext_season next_series

The article of the next season in the series. Leave blank if the season article cannot be automatically generated by the template.

Page nameoptional
List of episodes articleepisode_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.

Page nameoptional

All parameters (not for general use)

[edit]
{{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    = 
| showrunner     = 
| starring       = 
| module1        = 
| 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}} -->
| prev_season    = <!-- or |prev_series  = -->
| next_season    = <!-- or |next_series  = -->
| episode_list   = 
}}

Example

[edit]

For use on The Office (American TV series) season 2:


The Office
Season 2
DVD cover
ShowrunnerGreg Daniels
Starring
No. of episodes22
Release
Original networkNBC
Original releaseSeptember 20, 2005 (2005-09-20) –
May 11, 2006 (2006-05-11)
Season chronology
← Previous
Season 1
Next →
Season 3
List of episodes
{{Infobox television season
| bg_color       = #cae2f2
| image          = Example-serious.jpg
| image_alt      = 
| caption        = DVD cover
| showrunner     = [[Greg Daniels]]
| 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]]
}}
| 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
}}
[edit]

Microformat

[edit]

The HTML mark-up produced by this template includes an hCalendar microformat that makes event details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.

Classes used

The HTML classes of this microformat include:

  • attendee
  • contact
  • description
  • dtend
  • dtstart
  • location
  • organiser
  • summary
  • url
  • vevent
Please do not rename or remove these classes
nor collapse nested elements which use them.

Tracking categories

[edit]

Supporting templates

[edit]

See also

[edit]