Template:Infobox television season/doc
 | This is a documentation subpage for Template:Infobox television season. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 10,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This infobox should italicize the article title automatically. If this is not required, add |italic_title=no to the list of parameters. If this is required but the title is not being italicized, try |italic_title=force. |
 | This template uses Lua: |
Infobox television season is used to create an infobox which summarizes the main information of a particular television season.
Usage
| no | |
|---|---|
 caption | |
| Starring | starring |
| No. of episodes | num_episodes |
| Release | |
| Original network | network |
| Original release | first_aired (released) – last aired |
{{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 =
}}
Parameters
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.
| Parameter | Explanation |
|---|---|
| italic_title | Set to |italic_title=no if the title should not be italicized.
|
| 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. |
|
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.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 | 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. |
| 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. |
| 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., [[United States]], per WP:OVERLINK. |
| 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. |
|
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.
|
| 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.
|
|
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).
|
|
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.
|
| celebrity_winner | The celebrity winner of the competition of dance competition related programs. |
| professional_winner | The professional dancer winner of the competition of dance competition related programs. |
| website | The season's relevant website link. Use www |
Controlling line-breaking in embedded bulletless lists
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"
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.
170px→upright=0.75180px→upright=0.8190px→upright=0.85200px→upright=0.9210px→upright=0.95220px→upright=1230px→upright=1.05240px→upright=1.1250px→upright=1.15260px→upright=1.2270px→upright=1.23280px→upright=1.25290px→upright=1.3300px→upright=1.35
TemplateData
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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
All parameters (not for general use)
{{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}} -->
| celebrity_winner = <!-- This field is only for use in certain articles. -->
| professional_winner = <!-- This field is only for use in certain articles. -->
| website = <!-- {{URL|}} -->
| prev_season = <!-- or |prev_series = -->
| next_season = <!-- or |next_series = -->
| episode_list =
}}
Example
For use on The Office (American season 2):
| The Office | |
|---|---|
| Season 2 | |
DVD cover | |
| Starring | |
| No. of episodes | 22 |
| Release | |
| Original network | NBC |
| Original release | September 20, 2005 – May 11, 2006 |
| Season chronology | |
{{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
}}
Related templates
- {{Infobox reality competition season}} - uses a nested infobox in
|module1=.
Microformat
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
nor collapse nested elements which use them.
Tracking categories
- Category:Pages using infobox television season with custom fields (0) – articles that use custom fields
- Category:Pages using infobox television season with invalid colour combination (0) – articles that use WP:COLOR-violating colour combinations (per this discussion)
- Category:Pages using infobox television season with unknown parameters (0) – articles using unsupported infobox parameters
- Category:Pages using infobox television season with the season_name parameter (358)
Supporting templates
See also
- Template:Episode list for creating an episode list.