imported>Primefac: update /doc to clear up some confusion

2022-08-22T20:11:34Z

update /doc to clear up some confusion

New page

{{Documentation subpage}}

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

== Usage ==
{{Infobox games
| name = {{{name}}}
| logo = {{{logo}}}
| size = {{{size}}}
| caption = {{{caption}}}
| host city = {{{host city}}}
| country = {{{country}}}
| motto = {{{motto}}}
| organizer = {{{organizer}}}  {{smaller|or}}  {{{organiser}}}
| edition = {{{edition}}}
| nations participating = {{{nations participating}}}
| teams participating = {{{teams participating}}}
| debuting countries = {{{debuting countries}}}
| athletes participating = {{{athletes participating}}}
| sports = {{{sports}}}
| events = {{{events}}}
| dates = {{{dates}}}
| opening ceremony = {{{opening ceremony}}} 
| closing ceremony = {{{closing ceremony}}} 
| officially opened by = {{{officially opened by}}}
| athlete's oath = {{{athlete's oath}}}
| judge's oath = {{{judge's oath}}}
| torch lighter = {{{torch lighter}}}
| Paralympic torch = {{{Paralympic torch}}}
| Queen's Baton = {{{Queen's Baton}}} 
| stadium = {{{stadium}}}
| Paralympic stadium = {{{Paralympic stadium}}}
| length = {{{length}}}
| indprize = {{{indprize}}}
| tmprize = {{{tmprize}}}
| website = {{{website}}}
| previous = {{{previous}}}
| next = {{{next}}}
| SpreviousS = {{{SpreviousS}}}
| SnextS = {{{SnextS}}}
| Sprevious = {{{Sprevious}}}
| Snext = {{{Snext}}}
}}
<pre style="overflow:auto">
{{Infobox games
| name =
| logo =
| size =
| caption =
| host city = 
| country =
| motto =
| organizer = 
| edition =
| nations participating =
| teams participating =
| debuting countries =
| athletes participating =
| sports =
| events =
| dates =
| opening ceremony = 
| closing ceremony = 
| officially opened by =
| athlete's oath =
| judge's oath =
| torch lighter =
| Paralympic torch =
| Queen's Baton = 
| stadium =
| Paralympic stadium =
| length =
| indprize =
| tmprize =
| website = 
| previous =
| next =
| SpreviousS =
| SnextS =
| Sprevious =
| Snext =
}}
</pre>

== Parameters ==

* name = Name of the games
* logo = Internal URL to image file
* size = Custom size for the provided logo
* caption = For a brief description of the provided logo
* host city = Name of host city, labelled "Host city"
* host = Alternate option for the host labelled as just "Host"
* country = Name of host country
* motto = Motto/Slogan of the games
* organizer/organiser = Body responsible for organising the games
* edition = Number within the series (e.g. 16th, XVI)
* nations participating = Total number of participating nations
* teams participating = Total number of participating teams
* debuting countries = Countries debuting at the games
* athletes participating = Total number of participating athletes
* events = Number of events
* opening ceremony = Date of opening ceremony. Use {{Tl|Start date}}.
* closing ceremony = Date of closing ceremony. Use {{Tl|End date}}.
* officially opened by = Name of person who officially opened the Games
* athlete's oath = Name of athlete who swore the athletes' oath
* judge's oath = Name of judge/official who swore the oath
* torch lighter = Name of last torch bearer
* Paralympic torch = Name of last paralympic torch bearer, if different
* stadium = Name of the main stadium
* Paralympic stadium = Name of the paralympic stadium, if different
* length = Race length
* indprize = Individual Prize Money (US$)
* tmprize = Team Prize Money (US$)
* Sprevious = Summer articles only: The previous Paralympic Winter Games
* Snext = Summer articles only: The next Paralympic Winter Games
* SpreviousS = Summer articles only: The previous Paralympic Summer Games
* SnextS = Summer articles only: The next Paralympic Summer Games
* Wprevious = Winter articles only: The previous Paralympic Winter Games
* Wnext = Winter articles only: The next Paralympic Winter Games
* WpreviousS = Winter articles only: The previous Paralympic Summer Games
* WnextS = Winter articles only: The next Paralympic Summer Games
* previous = For events with no Summer/Winter: The previous Games
* next = For events with no Summer/Winter: The next Games
* website = Website; use {{Tl|URL}}

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

== Tracking category ==
* {{clc|Pages using infobox games with unknown parameters}}

== See also ==
* [[Template:Infobox sports competition event]]
* [[Template:Infobox tournament]]

{{When on basepage|

[[Category:Commonwealth Games navigational boxes]]
[[Category:Multi-sport events infobox templates|Games]]
[[Category:Infobox templates with module parameter|Games]]
[[Category:Templates that add a tracking category]]
}}

Template:Infobox games/doc - Revision history

imported>Primefac: update /doc to clear up some confusion