Template:Infobox Olympic games/doc

This is a documentation subpage for Template:Infobox Olympic games.
It contains usage information, categories and other content that is not part of the original template page.

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

Usage

{{Infobox Olympic games|Year|Season| <!-- IMPORTANT: keep the pipe after "Season" on the same line for the template to work properly -->
| Logo                   =  <!-- internal link to the logo image file -->
| Alt                    =  <!-- alternative text for the logo image -->
| Size                   =  <!-- custom size for the logo image -->
| Optional caption       =  <!-- optional caption for the logo-->
| Motto                  =  <!-- the motto/slogan of the Games -->
| Nations participating  =  <!-- total number of participating National Olympic Committees (NOCs) -->
| Athletes participating =  <!-- total number of participating athletes -->
| Officially opened by   =  <!-- person who officially opened the Games -->
| Athlete's Oath         =  <!-- athlete who swore the Olympic Oath -->
| Judge's Oath           =  <!-- judge/official who swore the Olympic Oath -->
| Coach's Oath           =  <!-- coach who swore the Olympic Oath -->
| Olympic Torch          =  <!-- last torch bearer -->
}}

Some parameters are not customizable and display a default value according to mandatory parameters Year and Season:

Host city

Name of the city where the Games were hosted (values provided by sub-template {{Olympics infobox/Host city}})

Events

Total number of events and sports contested at the Games (values provided by sub-template {{Olympics infobox/Events}})

Opening ceremony

Date of the opening ceremony of the Games (values provided by sub-template {{Olympics infobox/Opening ceremony}})

Closing ceremony

Date of the closing ceremony of the Games (values provided by sub-template {{Olympics infobox/Closing ceremony}})

Example

Here is an example of the infobox displaying content about the 2000 Summer Olympics:

{{Infobox Olympic games|2000|Summer|
| Logo                   =  Example.svg
| Alt                    =  Example image
| Size                   =  250
| Optional caption       =  Official logo of the Sydney 2000 Olympic Games
| Motto                  =  Share the spirit
| Nations participating  =  199
| Athletes participating =  10,651<br/>(6,582 men, 4,069 women)
| Officially opened by   =  [[William Deane]]
| Athlete's Oath         =  [[Rechelle Hawkes]]
| Judge's Oath           =  [[Peter Kerr (water polo)|Peter Kerr]]
| Olympic Torch          =  [[Cathy Freeman]]
}}

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.