>CommonsDelinker: Replacing PyeongChang_2018_Winter_Olympics.svg with File:Pyeongchang_2018_Logo.svg (by CommonsDelinker because: File:PyeongChang_2018_Winter_Olympics.svg merged with File:Pyeongchang 2018 Logo.svg).

2025-02-06T17:54:19Z

Replacing PyeongChang_2018_Winter_Olympics.svg with File:Pyeongchang_2018_Logo.svg (by CommonsDelinker because: File:PyeongChang_2018_Winter_Olympics.svg merged with File:Pyeongchang 2018 Logo.svg).

New page

{{Documentation subpage}}

{{Intricate template}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}

'''{{tl|Infobox Olympic games}}''' is an {{tl|Infobox}}-based template designed to summarise the most important details of a specific running of a [[Summer Olympic Games]], [[Winter Olympic Games]], [[Summer Paralympic Games]], [[Winter Paralympic Games]], or [[Youth Olympic Games]]. It is largely designed to inform a casual reader somewhat knowledgeable in sports and the Olympic and Paralympic games in general of the games' locale, time, graphic design, and amount of athletes and events, along with the venue and names of notable people associated with the games. This infobox makes use of a four image parameters, twelve data cells, and six succession cells. The syntax of the infobox also makes use of 27 [[mw:Help:Extension:ParserFunctions##if|<code><nowiki>{{#if:}}</nowiki></code>]], eighteen [[mw:Help:Extension:ParserFunctions##ifeq|<code><nowiki>{{#ifeq:}}</nowiki></code>]], four [[mw:Help:Extension:ParserFunctions##ifexpr|<code><nowiki>{{#ifexpr:}}</nowiki></code>]], three [[mw:Help:Extension:ParserFunctions##expr|<code><nowiki>{{#expr:}}</nowiki></code>]], and two [[mw:Help:Extension:ParserFunctions##ifexist|<code><nowiki>{{#ifexist:}}</nowiki></code> parser functions]], along with a [[hCalendar]] microformat.

==Syntax==
{{Parameter names example | image | image_size | alt | caption | location | motto | nations | athletes | events | opening | closing | opened_by | closed_by | cauldron | stadium | venue | website | prev | next }}
<syntaxhighlight lang="wikitext" style="width:60%;">
{{Infobox Olympic games| 1 | 2 | 3 |
| image =
| image_size =
| alt =
| location =
| host_city =
| motto =
| nations =
| athletes =
| events =
| opening =
| closing =
| opened_by =
| closed_by =
| cauldron =
| stadium =
| venue =
| website =
| summer_prev =
| summer_next =
| winter_prev =
| winter_next =
| prev =
| next =
}}</syntaxhighlight>

==Parameters==
===Header and image===
[[File:Pyeongchang 2018 Logo.svg|thumb|222px|The [[2018 Winter Olympics]] logo is set to a width of 222 pixels, to ensure the Olympic rings at the bottom of the logo appears at 100px width.]]
{{tl|Infobox Olympic games}} uses three blank parameters at the beginning of the template's syntax, <code>1</code>, <code>2</code>, <code>3</code>. These are used to set the year, season, and games being detailed, in that specific order. For example, in the article for the [[1998 Winter Olympics]], <code>1</code> should be set to "<code>1998</code>", <code>2</code> should be set to "<code>Winter</code>", and <code>3</code> should be set to "<code>Olympics</code>". In the heading, [[mw:Help:Extension:ParserFunctions##ifexpr|<code><nowiki>{{#ifexpr:}}</nowiki></code>]] and [[mw:Help:Extension:ParserFunctions##expr|<code><nowiki>{{#expr:}}</nowiki></code>]] are used to convert the inputs of these two parameters into the official name of the games. For example, if <code>1</code>, <code>2</code>, and <code>3</code> are set to values representing the [[2000 Summer Paralympics]], "<code>2000</code>", "<code>Summer</code>", and "<code>Paralympics</code>", it will be converted into "'''XI Paralympic Games'''". Four parameters are used in the {{tl|Infobox}} syntax in this template. They are <code>image</code>, which displays an image when a filename is inputted, omitting the "<code>File:</code>" prefix, <code>image_size</code>, an optional template that allows editors to set a custom size for the image, <code>alt</code>, another optional parameter that can be used to implement an explicitly descriptive [[Wikipedia:Extended image syntax#Alt text and caption|alt caption]] that appears when images don't load, and <code>caption</code>, another optional parameter that allows users to set a custom caption for the image. The latter two parameters are mostly discouraged, and are in use only for special circumstances preferably resolved from a consensus on a particular issue. For the modern Olympic logo format used since the [[1998 Winter Olympics]] and [[2000 Summer Olympics]], a [[mw:Help:Extension:ParserFunctions##switch|<code><nowiki>{{#switch:}}</nowiki></code>]] template is used to fix image sizes so that the [[Olympic rings]] at the bottom of the modern logo design appear at exactly 100px width (''See image on right for example''). This is enabled using {{tl|Infobox Olympic games/image size}}, which in turn uses [[mw:Help:Extension:ParserFunctions##ifexpr|<code><nowiki>{{#ifexpr:}}</nowiki></code>]] to check if the <code>1</code> parameter is set to a year past 1997. If not, this setup is cancelled out and the default <code>frameless</code> size applies. An optional <code>caption</code> parameter also exists than enables users to write a descriptive caption for an image featured in the <code>image</code> parameter.

===Cells===
{| class="wikitable"
! style="width:8em;" | Cell
! Parameter(s)
! Description
|-
| '''Location'''
| <code>Location</code>
| This parameter is used to input the city that is hosting the games and its sovereign state. It should be presented in the format of {{xt|<nowiki>[city], [country]</nowiki>}}, with the country not being wikilinked per [[MOS:OL|manual of style guidelines]]. For example, if the parameters are set to the values representing the [[2006 Winter Olympics]], "<code>2006</code>" and "<code>Winter</code>", the data for this cell will appear as "{{xtd|[[Turin]], Italy}}"
|-
| '''Motto'''
| <code>motto</code>
| This parameter is used to input the official motto of the games. If there are multiple mottos for a particular games, a consensus should preferably be reached to use the most common and recognised one. The motto should be presented in ''italicised form'', using two [[Apostrophe|typewriter apostrophes]] (<code><nowiki>''</nowiki></code>) before and after the text. If the motto is not in English, an English translation must be presented first, above the motto in its original language in [[parentheses]] on a new line using {{tl|Plainlist}} formatting, and prefixed with the name of the language with a [[wikilink]] to the article on that language. For example, the motto of the [[2004 Summer Olympics]] should be written up as:<syntaxhighlight lang="wikitext" style="width:60%;">{{Plainlist|
* ''Welcome home''
* ([[Greek language|Greek]]: Καλώς ήλθατε σπίτι, Kalós ílthate spíti)
}}</syntaxhighlight>
|-
| '''Nations'''
| <code>nations</code>
| This parameter is used to input the number of [[National Olympic Committee]]s (NOCs) present at the games. A simple number input is highly encouraged here, regardless of any special event or occasion, such as the merging of two or more nations in a single team for a particular games, which can be detailed in the article body instead. For example, the input for this parameter in the [[1988 Winter Olympics]] article, where 57 NOCs competed, would simply be "{{xtd|57}}".
|-
| '''Athletes'''
| <code>athletes</code>
| This parameter is used to input the number of athletes that competed at the games. A total figure should be presented first in front of the number of men and women competing in [[parentheses]] following it. For example, the input for this parameter in the article for the [[1996 Summer Olympics]], where 6,797 men and 3,523 women competed, should be presented as "{{xtd|10,320 (6,797 men, 3,523 women)}}".
|-
| '''Events'''
| <code>events</code>
| This parameter is used to list the number of events that took place at the games, along with the number of sports and disciplines features. It is preferably presented in the "{{xt|<nowiki>[number of events] in [number of sports]</nowiki> [[Olympic sports|sports]] <nowiki>([number of disciplines] disciplines)</nowiki>}}". For example, if the parameters are set to the values representing the [[1956 Winter Olympics]], "<code>1956</code>" and "<code>Winter</code>", the data for this cell will appear as "{{xtd|24 in 4 [[Olympic sports|sports]] (8 disciplines)}}".
|-
| '''Opening'''
| <code>opening</code>
| rowspan="2"| These parameters are used to present the date of the games' opening and closing ceremonies in a simple "{{xt|<nowiki>[day] [month]</nowiki>}}" format, such as "{{xtd|27 July}}" and "{{xtd|12 August}}" for the [[2012 Summer Olympics]], when the two parameters are set to "<code>2012</code>" and "<code>Summer</code>". Two [[mw:Help:Extension:ParserFunctions##ifexist|<code><nowiki>{{#ifexist:}}</nowiki></code> parser functions]] are also used to check if wikipedia articles exist for the opening and/or closing ceremonies. If so, a wikilink to that article will be placed in the '''Opening''' and/or '''Closing''' cell headers.
|-
| '''Closing'''
| <code>closing</code>
|-
| '''[[List of people who have opened the Olympic Games|Opened by]]'''
| <code>opened_by</code>
| This parameter is used to input the name of the person who officially opened the games at the opening ceremony. Their formal shorthand [[title]], followed by their [[common name]] is highly encouraged. For example, in the article for the [[2000 Summer Olympics]], the name of the person who opened the games, the [[Order of the British Empire|knighted]] then-[[Governor-General of Australia]] [[William Deane]], should be presented in this parameter as "{{xtd|[[Governor-General of Australia|Governor-General]] [[William Deane|Sir William Deane]]}}".
|-
| '''[[List of people who have lit the Olympic cauldron|Cauldron]]'''
| <code>cauldron</code>
| This parameter is used to input the [[common name]] of the person or people who, at the opening ceremony, [[List of people who have lit the Olympic cauldron|lit the Olympic cauldron]]. Any special citizenship titles, such as the [[Order of the British Empire|knighthood]] of "Sir", may be appropriate, but only if they held those titles at the time of the opening ceremony. If multiple people were involved with lighting the cauldron, a {{tl|Plainlist}} format is highly encouraged.
|-
| '''[[Olympic Stadium|Stadium]]''' / '''Venue'''
| <code>stadium</code>
| This parameter is used to display the stadium that hosted the opening ceremony of the games, or venue, if there is none. The common, non-sponsorship name of the venue is presented in this cell, with a [[wikilink]] to the article about the venue. For example, the article for the [[2010 Winter Olympics]], which will have the <code>1</code> and <code>2</code> parameters set to "<code>2010</code>" and "<code>Winter</code>", will display "{{xtd|[[BC Place]]}}" in this cell. The [[2024 Summer Olympics]] article uses <code><nowiki>venue=[[Jardins du Trocadéro]] and the [[Seine]] (opening ceremony)</nowiki></code>
|}

===Succession===
The succession links at the bottom of the {{tl|Infobox}} template use an intricate, complex series of [[mw:Help:Extension:ParserFunctions|parser functions]] designed to present succession for the [[Summer Olympic Games]] and [[Winter Olympic Games]] according to which season is set to the <code>2</code> parameter. For example, if the <code>2</code> parameter is set to <code>Summer</code>, the succession links for the Summer games will appear above the succession links for the Winter games. If it's set to <code>Winter</code>, the reverse will be true. This is true thanks to an arrangement of [[mw:Help:Extension:ParserFunctions##if|<code><nowiki>{{#if:}}</nowiki></code>]] and [[mw:Help:Extension:ParserFunctions##ifeq|<code><nowiki>{{#ifeq:}}</nowiki></code>]] parser functions that all check the <code>2</code> parameter. Four main parameters exist in this section, <code>summer_prev</code> for the preceding Summer games, <code>summer-next</code> for the succeeding Summer games, <code>winter_prev</code> for the preceding Winter games, and <code>winter_next</code> for the succeeding Winter games. It is highly encouraged that the [[wikilinks]] are formatted to present the name of the host city followed by the year. For example, the [[1960 Summer Olympics]] should be presented as "{{xtd|[[1960 Summer Olympics|Rome 1960]]}}" and the [[2014 Winter Olympics]] should be presented as "{{xtd|[[2014 Winter Olympics|Sochi 2014]]}}". Two additional parameters, <code>prev</code> and <code>next</code>, also exist to allow for situations in which the four main parameters do not apply, such as the [[1906 Intercalated Games]].

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

<includeonly>{{Sandbox other||

[[Category:Olympics infobox templates|Games]]
}}</includeonly>

Template:Infobox Olympic games/doc - Revision history

>CommonsDelinker: Replacing PyeongChang_2018_Winter_Olympics.svg with File:Pyeongchang_2018_Logo.svg (by CommonsDelinker because: File:PyeongChang_2018_Winter_Olympics.svg merged with File:Pyeongchang 2018 Logo.svg).