Template:GamesSport/doc

This is a documentation subpage for Template:GamesSport.
It may contain usage information, categories and other content that is not part of the original template page.

The GamesSport template is for usage on main multi-sport event articles only. The purpose of this template is to radically simplify the listing of sports on multi-sport event articles.

Typically, such articles will have a list of the sports held at the event and each listing comprises three or four parts:

a link to the main article of that sport
a link to the detailed summary or results of that sport at that event.
a figure denoting the total number of events held within that sport during the games

The GamesSport template allows you to render all these elements by simply entering the name of the sport. Its basic usage is:

{{GamesSport|SPORT}}

Note that the template uses International Olympic Committee naming conventions, so "football" directs to association football and "hockey" directs to field hockey.

Plain example (without GamesSport)

Previously, each of these elements would need to be written out separately like the example below for the 2010 South Asian Games:




{{div col|colwidth=22em}}

* [[Sport of athletics|Athletics]] ({{Details link|Athletics at the 2010 South Asian Games}})

* [[Cycle sport|Cycling]] ({{Details link|Cycling at the 2010 South Asian Games}})

* [[Association football|Football]] ({{Details link|Football at the 2010 South Asian Games}})

* [[Golf]] ({{Details link|Golf at the 2010 South Asian Games}})

* [[Field hockey|Hockey]] ({{Details link|Hockey at the 2010 South Asian Games}})

* [[Squash (sport)|Squash]] ({{Details link|Squash at the 2010 South Asian Games}})

{{div col end}}

With GamesSport

This information can be rendered much more easily with the GamesSport template as it removes the need to spend time finding the correct article for each sport and its corresponding pictogram. The link to the results works off the name of the article in which it is placed. Therefore, if you use the template here it links to "SPORT at the GamesSport/doc"; on the 2008 Summer Olympics article it would link to "SPORT at the 2008 Summer Olympics".




{{div col|colwidth=22em}}

* {{GamesSport|Athletics}}

* {{GamesSport|Cycling}}

* {{GamesSport|Football}}

* {{GamesSport|Golf}}

* {{GamesSport|Hockey}}

* {{GamesSport|Squash}}

{{div col end}}

Adding number of events

The number of events contested within each sport may be listed if desired. This can be done with using the "Event=<number of events>" parameter as follows:




{{div col|colwidth=22em}}

* {{GamesSport|Athletics|Events=25}}

* {{GamesSport|Cycling|Events=6}}

* {{GamesSport|Football|Events=1}}

* {{GamesSport|Golf|Events=1}}

* {{GamesSport|Hockey|Events=2}}

* {{GamesSport|Squash|Events=2}}

{{div col end}}

Would give you the following:

Removing pictogram

The pictogram may be removed if desired. This can be done with by setting |Image=no:




{{div col|colwidth=22em}}

* {{GamesSport|Athletics|Events=25|Image=No}}

* {{GamesSport|Cycling|Events=6|Image=No}}

* {{GamesSport|Football|Events=1|Image=No}}

* {{GamesSport|Golf|Events=1|Image=No}}

* {{GamesSport|Hockey|Events=2|Image=No}}

* {{GamesSport|Squash|Events=2|Image=No}}

{{div col end}}

Would give you the following:

Changing listing format

The listing format may be changed if desired. Displaying only single link to the main sport may be done with using the "Format=m" parameter as follows:




{{div col|colwidth=22em}}

* {{GamesSport|Athletics|Events=25|Format=m}}

* {{GamesSport|Cycling|Events=6|Format=m}}

* {{GamesSport|Football|Events=1|Format=m}}

* {{GamesSport|Golf|Events=1|Format=m}}

* {{GamesSport|Hockey|Events=2|Format=m}}

* {{GamesSport|Squash|Events=2|Format=m}}

{{div col end}}

Would give you the following:

Athletics (25)
Cycling (6)
Football (1)
Golf (1)
Hockey (2)
Squash (2)

Displaying only single link to the details of the sport results may be done with using the "Format=d" parameter as follows:




{{div col|colwidth=22em}}

* {{GamesSport|Athletics|Events=25|Format=d}}

* {{GamesSport|Cycling|Events=6|Format=d}}

* {{GamesSport|Football|Events=1|Format=d}}

* {{GamesSport|Golf|Events=1|Format=d}}

* {{GamesSport|Hockey|Events=2|Format=d}}

* {{GamesSport|Squash|Events=2|Format=d}}

{{div col end}}

Would give you the following:

Athletics (25)
Cycling (6)
Football (1)
Golf (1)
Hockey (2)
Squash (2)

Plain example (without GamesSport)

With GamesSport

Adding number of events

Removing pictogram

Changing listing format

See also