Template:Infobox Olympic games/doc

{{Infobox Olympic games}} is an {{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 {{#if:}}, eighteen {{#ifeq:}}, four {{#ifexpr:}}, three {{#expr:}}, and two {{#ifexist:}} parser functions, along with a hCalendar microformat.

Syntax

[[File:{{{image}}}|{{{image_size}}}|alt={{{alt}}}]] {{{caption}}}
Host city	{{{host_city}}}
Motto	{{{motto}}}
Nations	{{{nations}}}
Events	{{{events}}}
Opening	{{{opening}}}
Closing	{{{closing}}}
Opened by	{{{opened_by}}}
Cauldron	{{{cauldron}}}
Stadium	{{{stadium}}}
← {{{prev}}} {{{next}}} →

{{Infobox Olympic games| 1 | 2 | 3 |
| image       = 
| image_size  = 
| alt         = 
| caption     = 
| host_city   = 
| motto       = 
| nations     = 
| athletes    = 
| events      = 
| opening     = 
| closing     = 
| opened_by   = 
| cauldron    = 
| stadium     = 
| summer_prev = 
| summer_next = 
| winter_prev = 
| winter_next = 
| prev        = 
| next        = 
}}

Parameters

Header and image

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.

{{Infobox Olympic games}} uses three blank parameters at the beginning of the template's syntax, 1, 2, 3. 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, 1 should be set to "1998", 2 should be set to "Winter", and 3 should be set to "Olympics". In the heading, {{#ifexpr:}} and {{#expr:}} are used to convert the inputs of these two parameters into the official name of the games. For example, if 1, 2, and 3 are set to values representing the 2000 Summer Paralympics, "2000", "Summer", and "Paralympics", it will be converted into "XI Paralympic Games". Four parameters are used in the {{Infobox}} syntax in this template. They are image, which displays an image when a filename is inputted, omitting the "File:" prefix, image_size, an optional template that allows editors to set a custom size for the image, alt, another optional parameter that can be used to implement an explicitly descriptive alt caption that appears when images don't load, and caption, 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 {{#switch:}} 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 {{Infobox Olympic games/image size}}, which in turn uses {{#ifexpr:}} to check if the 1 parameter is set to a year past 1997. If not, this setup is cancelled out and the default frameless size applies. An optional caption parameter also exists than enables users to write a descriptive caption for an image featured in the image parameter.

Cells

Cell	Parameter(s)	Description
Host city	host_city	This parameter is used to input the city that is hosing the games and its sovereign state. It should be presented in the format of [city], [country], with the country not being wikilinked per manual of style guidelines. For example, if the parameters are set to the values representing the 2006 Winter Olympics, "2006" and "Winter", the data for this cell will appear as "Turin, Italy"
Motto	motto	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 typewriter apostrophes ('') 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 {{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: {{Plainlist| * ''Welcome home'' * ([[Greek language|Greek]]: Καλώς ήλθατε σπίτι, Kalós ílthate spíti) }}
Nations	nations	This parameter is used to input the number of National Olympic Committees (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 "57".
Athletes	athletes	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 "10,320 (6,797 men, 3,523 women)".
Events	events	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 "[number of events] in [number of sports] sports ([number of disciplines] disciplines)". For example, if the parameters are set to the values representing the 1956 Winter Olympics, "1956" and "Winter", the data for this cell will appear as "24 in 4 sports (8 disciplines)".
Opening	opening	These parameters are used to present the date of the games' opening and closing ceremonies in a simple "[day] [month]" format, such as "27 July" and "12 August" for the 2012 Summer Olympics, when the two parameters are set to "2012" and "Summer". Two {{#ifexist:}} 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	closing
Opened by	opened_by	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 knighted then-Governor-General of Australia William Deane, should be presented in this parameter as "Governor-General Sir William Deane".
Cauldron	cauldron	This parameter is used to input the common name of the person or people who, at the opening ceremony, lit the Olympic cauldron. Any special citizenship titles, such as the 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 {{Plainlist}} format is highly encouraged.
Stadium	stadium	This parameter is used to display the stadium that hosted the opening ceremony of the games. 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 1 and 2 parameters set to "2010" and "Winter", will display "BC Place" in this cell.

Succession

The succession links at the bottom of the {{Infobox}} template use an intricate, complex series of parser functions designed to present succession for the Summer Olympic Games and Winter Olympic Games according to which season is set to the 2 parameter. For example, if the 2 parameter is set to Summer, the succession links for the Summer games will appear above the succession links for the Winter games. If it's set to Winter, the reverse will be true. This is true thanks to an arrangement of {{#if:}} and {{#ifeq:}} parser functions that all check the 2 parameter. Four main parameters exist in this section, summer_prev for the preceding Summer games, summer-next for the succeeding Summer games, winter_prev for the preceding Winter games, and winter_next 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 "Rome 1960" and the 2014 Winter Olympics should be presented as "Sochi 2014". Two additional parameters, prev and next, also exist to allow for situations in which the four main parameters do not apply, such as the 1906 Intercalated Games.

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 on English Wikipedia.

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.