Template:Infobox reality competition season/doc

< Template:Infobox reality competition season
Revision as of 08:40, 1 March 2021 by Vitosium (talk | contribs) (Created page with "{{Documentation subpage}} {{High-use}} {{Lua|Module:Check for unknown parameters}} '''Infobox reality competition season''' is an infobox module that is used as part of Tem...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Infobox reality competition season is an infobox module that is used as part of Template:Infobox television season. This will allow the addition of reality competition specific parameters for television programs such as Big Brother, I'm a Celebrity...Get Me Out of Here!, Survivor, dancing competitions (Dancing on Ice, Dancing with the Stars, etc.), singing competitions (Idols, The Voice, I Am a Singer), and talent competition (Got Talent) into the {{Infobox television season}} template, without the need to fork the templates or clutter {{Infobox television season}}. The additional parameters will be inserted between the |starring= and |country= parameters of {{Infobox television season}}.

Usage

<section begin=infobox />

{{Infobox television season
| bg_color             = <!-- Colours used must meet the contrast requirements of WP:COLOR. -->
| image                = 
| image_alt            = 
| caption              = 
| module1              = {{Infobox reality competition season
 | presenter           = <!-- or | host= -->
 | judges              = 
 | num_contestants     = <!-- or | num_housemates= or | num_houseguests= or | num_survivors=  or | num_teams= -->
 | winner              = <!-- or | winners= or | winning_team= -->
 | runner_up           = <!-- or | runner_ups= -->
 | location            = 
 | label1              = <!-- This field is only for use in certain articles. See template documentation for more info. -->
 | data1               = <!-- This field is only for use in certain articles. See template documentation for more info. -->
 | companion_show      = <!-- or | companion_shows=. This field is only for use in certain articles. See template documentation for more info. -->
}}
| country              = 
| num_episodes         = <!-- Value is incremented when new episodes air. See template documentation for more info. -->
| network              = 
| first_aired          = <!-- {{Start date|yyyy|mm|dd|df=y}} – Only use this template once -->
| last_aired           = <!-- {{End date|yyyy|mm|dd}} -->
| 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}} -->
| episode_list         = 
}}

<section end=infobox />

Parameters

The following fields are for use with reality competition related articles only. This module is not exclusive to Big Brother and I'm a Celebrity...Get Me Out of Here! programs and should be used for any relevant reality competition show. These fields will appear before the |country= field in Infobox television season. Do not link to an article more than once in the infobox.

Infobox reality competition season parameters and basic guidelines
Parameter Explanation
module1 This parameter with {{Infobox reality competition season is required in order for the custom module to work and for the information to display correctly. The closing curly braces }} need to be added after the last field used in this module.
  • presenter
  • host
The presenter or host for the season. Do not include presenters of the companion programs as they should be listed in their own article. If this is not known leave this field blank. Use either "presenter" or "host", but not both. If there was more than one presenter or host, separate multiple entries using {{Plainlist}}.
judges The judges for the season. Do not include judges of the companion programs as they should be listed in their own article. If this is not known leave this field blank. If there was more than one judge, separate multiple entries using {{Plainlist}}.
coaches The coaches for the season. Do not include coaches of the companion programs as they should be listed in their own article. If this is not known leave this field blank. If there was more than one coaches, separate multiple entries using {{Plainlist}}.
num_days The number of days the contestants were living inside the House. This starts from the first day the first contestant enters and ends when the winner exits the House. If this is not known leave this field blank.
num_tasks The number of tasks the contestants needed to complete. If this is not known leave this field blank.
  • num_contestants
  • num_housemates
  • num_houseguests
  • num_survivors
  • num_teams
The number of contestants competing for the grand prize or an auxiliary prize. Visitors who enter the reality program for a pre-determined short stay are excluded. The default usage for Big Brother articles should be |number_housemates= as most versions refer to contestants as Housemates. |number_houseguests= should only be used in versions where the contestants are known as HouseGuests like the American and English Canadian versions. For Survivor articles use |num_survivors=. For any other reality program |num_contestants= should be used. If the contestants are competing as a team, like in The Amazing Race, |num_teams= should be used.
  • winner
  • winners
  • winning_team
The winner of the season. If there was more than one winner, use |winners= and separate multiple entries using {{Plainlist}}.
celebrity_winner The celebrity winner of the of the season. This parameter is for dance competition related programs.
professional_winner The professional winner of the of the season. This parameter is for dance competition related programs.
  • winner_mentor
  • winner_coach
The mentor or coach of the season's winner. Use relevant parameter.
  • runner_up
  • runner_ups
The runner-up of the season. If there was more than one runner-up, use |runner_ups= and separate multiple entries using {{Plainlist}}. No more than two runner-ups should be listed for a single season without a consensus.
location The location of the season. Not to be confused with country of origin. This parameter is for location specific programs such as Survivor.
finals_venue The location of the grand finale if held outside the normal studio. This parameter is for programs such as American Idol.
num_legs Used for The Amazing Race seasons to denote the number of legs the season had.
  • miles_traveled
  • km_traveled
Used for The Amazing Race seasons to denote the number of miles or kilometers traveled that season. Add either miles or kilometers and the infobox will automatically convert the other.
label1 A custom field for any scenario not outlined here. This parameter creates a label for the custom field. For more information on how to use this field please see the description for |data1=.
data1 A custom field for any scenario not outlined here. This may be used for a special or a major prize outside of a winner or runner-up prize that is typically awarded during the live finale such as "America's Favorite HouseGuest" from Big Brother (American TV series), or for a season long task where the prize was close to the amount the runner-up would have received like "America's Player" from Big Brother 8 (American season). Use of this field is determined on a season by season bases through consensus on the corresponding season article. Do not use this custom parameter for the following scenarios:
  • To list any other contestants after the season has ended that were eliminated through the normal process and did not win a special prize or title a the end. This includes eliminated contestants that were eliminated through the normal format, quit the program on their own accord or were removed by production.
  • As a tracker during the season for status like up-for-elimination, immunity and special powers.
  • For eliminated contestants that form a jury to determine who wins the program.
  • To list contestants who won minor cash prizes or other prizes through tasks or competitions.
  • companion_show
  • companion_shows
The concurrent programs that are covering the season. Only list companion programs that have a corresponding English Wikipedia article or are included on a list (example List of Big Brother (Australian TV series) shows). One time specials, live premiere/launch, evictions and live finale episodes should not be listed in here as should be covered in the same article (see Big Brother (Australian season 6)). If none of the companion programs have a separate article or are covered in the same season article then leave this field blank. If there was more than one companion show, use |companion_shows= and separate multiple entries using {{Plainlist}}.

TemplateData

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

TemplateData for Infobox reality competition season

An infobox module that is used as part of Infobox television season which allows the addition of reality competition specific parameters.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Modulemodule1

This parameter with <code>{{Infobox reality competition season</code> is required in order for the custom module to work and for the information to display correctly. The closing curly braces <code>}}</code> need to be added after the last field used in this module.

Auto value
{{Infobox reality competition season
Stringrequired
Presenterpresenter

The presenter for the season. Do not include presenters of the companion programs as they should be listed in their own article. If this is not known leave this field blank. If there was more than one presenter, separate multiple entries using {{tl|Plainlist}}.

Stringoptional
Hosthost

The host for the season. Do not include hosts of the companion programs as they should be listed in their own article. If this is not known leave this field blank. If there was more than one host, separate multiple entries using {{tl|Plainlist}}.

Stringoptional
Judgesjudges

The judges for the season. Do not include judges of the companion programs as they should be listed in their own article. If this is not known leave this field blank. If there was more than one judge, separate multiple entries using {{tl|Plainlist}}.

Stringoptional
Judgescoaches

The coaches for the season. Do not include coaches of the companion programs as they should be listed in their own article. If this is not known leave this field blank. If there was more than one coaches, separate multiple entries using {{tl|Plainlist}}.

Stringoptional
Number of daysnum_days

The number of days the contestants were living inside the House. This starts from the first day the first contestant enters and ends when the winner exits the House. If this is not known leave this field blank.

Numberoptional
Number of tasksnum_tasks

The number of tasks the contestants needed to complete. If this is not known leave this field blank.

Numberoptional
Number of contestantsnum_contestants

The number of contestants competing for the grand prize or an auxiliary prize. Visitors who enter the reality program for a pre-determined short stay are excluded. This parameter should be used for any non-''Big Brother'' reality program.

Numberoptional
Number of housematesnum_housemates

The number of contestants competing for the grand prize or an auxiliary prize. Visitors who enter the reality program for a pre-determined short stay are excluded. The default usage for ''Big Brother'' should be {{para|number_housemates}} as most versions refer to contestants as ''Housemates''.

Numberoptional
Number of houseguestsnum_houseguests

The number of contestants competing for the grand prize or an auxiliary prize. Visitors who enter the reality program for a pre-determined short stay are excluded. {{para|number_houseguests}} should only be used in versions where the contestants are known as ''HouseGuests'' like the [[Big Brother (American TV series)|American]] and [[Big Brother Canada|English Canadian]] versions.

Numberoptional
Number of castawaysnum_survivors

The number of contestants competing for the grand prize or an auxiliary prize. Visitors who enter the reality program for a pre-determined short stay are excluded. This parameter should be used for ''Survivor'' articles.

Numberoptional
Number of teamsnum_teams

The number of teams competing for the grand prize or an auxiliary prize. This parameter should be used for ''[[The Amazing Race]]'' style reality programs.

Numberoptional
Winnerwinner winners winning_team

The winner of the season. If there was more than one winner, use {{para|winners}} and separate multiple entries using {{tl|Plainlist}}.

Stringoptional
Celebrity winnercelebrity_winner

The celebrity winner of the of the season. This parameter is for dance competition related programs.

Stringoptional
Professional winnerprofessional_winner

The professional winner of the of the season. This parameter is for dance competition related programs.

Stringoptional
Winner's coachwinner_coach

The coach the season's winner.

Stringoptional
Winner's mentorwinner_mentor

The mentor the season's winner.

Stringoptional
Runner-uprunner_up runner_ups

The runner-up of the season. If there was more than one runner-up, use {{para|runner_ups}} and separate multiple entries using {{tl|Plainlist}}. No more than two runner-ups should be listed for a single season without a consensus.

Stringoptional
Locationlocation

The location of the season. Not to be confused with country of origin. This parameter is for location specific programs such as ''Survivor''.

Example
[[Fiji]]
Page nameoptional
Finals venuefinals_venue

The location of the grand finale if held outside the normal studio. This parameter is for programs such as ''American Idol''.

Example
[[Dolby Theatre]]
Page nameoptional
Number of legsnum_legs

Used for ''[[The Amazing Race]]'' seasons to denote the number of legs the season had.

Numberoptional
Distance traveledmiles_traveled km_traveled

Used for ''[[The Amazing Race]]'' seasons to denote the number of miles or kilometers traveled that season. Add either miles or kilometers and the infobox will automatically convert the other.

Numberoptional
Label1label1

A custom field for any scenario not outlined here. This parameter creates a label for the custom field. For more information on how to use this field please see the description for {{para|data1}}.

Stringoptional
Data1data1

A custom field for any scenario not outlined here. This may be used for a special or a major prize outside of a winner or runner-up prize that is typically awarded during the live finale such as "America's Favorite HouseGuest" from [[Big Brother (American TV series)]], or for a season long task where the prize was close to the amount the runner-up would have received like "America's Player" from [[Big Brother 8 (American season)]]. Use of this field is determined on a season by season bases through consensus on the corresponding season article. '''Do not use''' this custom parameter for the following scenarios: To list any other contestants after the season has ended that were eliminated through the normal process and did not win a special prize or title a the end.; As a tracker during the season for status like up-for-elimination, immunity and special powers; For eliminated contestants that form a jury to determine who wins the program; To list contestants who won minor cash prizes or other prizes through tasks or competitions.

Stringoptional
Companion showcompanion_show companion_shows

The concurrent programs that are covering the season. Only list companion programs that have a corresponding English Wikipedia article or are included on a list (example [[List of Big Brother (Australian TV series) shows]]). One time specials, live premiere/launch, evictions and live finale episodes should not be listed in here as should be covered in the same article (see [[Big Brother (Australian season 6)]]). If none of the companion programs have a separate article or are covered in the same season article then leave this field blank. If there was more than one companion show, use {{para|companion_shows}} and separate multiple entries using {{tl|Plainlist}}.

Stringoptional

All parameters (not for general use)

{{Infobox television season
| bg_color             = <!-- Colours used must meet the contrast requirements of WP:COLOR. -->
| image                = 
| image_upright        = 
| image_size           = 
| image_alt            = 
| caption              = 
| module1              = {{Infobox reality competition season
 | presenter           = <!-- or | host= -->
 | judges              = 
 | coaches             =
 | num_days            = 
 | num_tasks           =
 | num_contestants     = <!-- or | num_housemates= or | num_houseguests= or | num_survivors=  or | num_teams= -->
 | winner              = <!-- or | winners= or | winning_team= -->
 | celebrity_winner    =
 | professional_winner =
 | winner_coach        = <!-- or | winner_mentor= -->
 | runner_up           = <!-- or | runner_ups= -->
 | location            = 
 | finals_venue        = 
 | num_legs            = 
 | miles_traveled      = <!-- or | km_traveled= -->
 | label1              = <!-- This field is only for use in certain articles. See template documentation for more info. -->
 | data1               = <!-- This field is only for use in certain articles. See template documentation for more info. -->
 | companion_show      = <!-- or | companion_shows=. This field is only for use in certain articles. See template documentation for more info. -->
}}
| country              = 
| num_episodes         = 
| network              = 
| first_aired          = <!-- {{Start date|yyyy|mm|dd}} -->
| last_aired           = <!-- {{End date|yyyy|mm|dd}} -->
| 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         = 
}}

Example

For use on Big Brother (Australian season 7):

Big Brother
Season 7
Example-serious.jpg
Season seven logo
Presented byGretel Killeen
No. of days100
No. of housemates24
WinnerAleisha Cowcher
Runner-upZach Douglas
Companion shows
Country of originAustralia
Release
Original networkNetwork Ten
Original release28 April (2007-04-28) –
21 July 2007 (2007-07-21)
Season chronology
← Previous
Season 6
Next →
Season 8
{{Infobox television season
| bg_color             = #81A6E3
| image                = Example-serious.jpg
| caption              = Season seven logo
| module1              = {{Infobox reality competition season
| presenter            = [[Gretel Killeen]]
| num_days             = 100
| num_housemates       = 24
| winner               = Aleisha Cowcher
| runner_up            = Zach Douglas
| companion_shows      = {{Plainlist|
* ''[[List of Big Brother (Australian TV series) shows#Big Brother Nominations|Big Brother Nominations]]''
* ''[[List of Big Brother (Australian TV series) shows#UpLate|Big Brother: UpLate]]''
* ''[[List of Big Brother (Australian TV series) shows#Friday Night Live|Friday Night Live]]''
}}
}}
| country              = Australia
| network              = [[Network Ten]]
| first_aired          = {{Start date|2007|04|28|df=y}}
| last_aired           = {{End date|2007|07|21|df=y}}
}}

Tracking categories