Template:Infobox television season/doc
 | This is a documentation subpage for Template:Infobox television season. It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 6,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please 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
| Infobox television season/doc | |
|---|---|
 caption | |
| Starring | starring |
| Country of origin | country |
| No. of episodes | num_episodes |
| Release | |
| Original network | network |
| Original release | first_aired (released) – last aired |
<section begin=infobox />
{{Infobox television season
| bgcolour = <!-- Colours used must meet the contrast requirements of WP:COLOR. -->
| season_number =
| 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 =
}}<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 {{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.
|
| season_name | Set this parameter to change the infobox title if it is not to be the page name. This defaults to the page name. |
| bgcolour | 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_number | The season number. The Xth season of this particular show. In the example: The Apprentice (American season 2), |season_number=2 should be used.
|
| image | A suitable image relevant to the show. 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 the logo only, of the show does not need a caption. |
| 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 show'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 show 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 | If one exists, this field should include 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.
{{#section:Template:Infobox Australian place/doc|image_upright}}
TemplateData
TemplateData documentation used by VisualEditor and other tools
|
|---|
|
See the monthly parameter usage report for this template.
TemplateData for Infobox television season <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."
},
"bgcolour": {
"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": [
"bgcolor",
"headercolour",
"headercolor"
]
},
"season_number": {
"label": "Season number",
"type": "number",
"required": false,
"suggested": false,
"deprecated": false,
"description": "The season number. The Xth season of this particular show. In the example: The Apprentice (American season 2), |
All parameters (not for general use)
{{Infobox television season
| italic_title =
| bgcolour = <!-- Colours used must meet the contrast requirements of WP:COLOR. -->
| season_name =
| season_number =
| image =
| image_size =
| image_upright =
| image_alt =
| caption =
| 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
| Infobox television season/doc | |
|---|---|
DVD cover | |
| Starring | |
| Country of origin | United States |
| No. of episodes | 22 |
| Release | |
| Original network | NBC |
| Original release | September 20, 2005 – May 11, 2006 |
{{Infobox television season
| bgcolour = #cae2f2
| season_number = 2
| image = Example-serious.jpg
| 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, which makes the event details parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to a calendar or diary application. For more information about the use of microformats on Wikipedia, please see the microformat project on English Wikipedia.
Sub-templates
Dates will only be included if you use {{Start date}} or {{End date}} (use the former for single dates; but do not use any of these if the date is before 1583 CE).
URLs will only be included if you use {{URL}}.
Please do not remove instances of these sub-templates.
Classes
hCalendar uses HTML classes including:
- 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
- Category:Television season articles that use custom fields (0) – articles that use custom fields
- Category:Articles using Template: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 (2) – articles using unsupported infobox parameters
- Category:Infobox television season articles that use the season_name parameter (2)
Supporting templates
See also
- Template:Episode list for creating an episode list.