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, eighteen  , four  , three  , and two   parser functions, along with a hCalendar microformat.

Syntax


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

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  parameter. For example, if the  parameter is set to , the succession links for the Summer games will appear above the succession links for the Winter games. If it's set to, the reverse will be true. This is true thanks to an arrangement of  and   parser functions that all check the   parameter. Four main parameters exist in this section,  for the preceding Summer games,   for the succeeding Summer games,   for the preceding Winter games, and   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. If the games are in the future, italicised formatting, using two typewriter apostrophes before and after the text is also highly encouraged. 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,  and , also exist to allow for situations in which the four main parameters do not apply, such as the 1906 Intercalated Games.