Template:AthResult/doc
 | This is a documentation subpage for Template:AthResult. It may contain usage information, categories and other content that is not part of the original template page. |
The AthResult template is for usage on athletics and track and field athlete biographies. It must be used in conjunction with the AchievementTable template to work properly.
AthResult is a semi-automated, non-intrusive method of quickly inserting a particular athlete's performance at a major competition. It must always be substituted to allow for easy future reading and editing, and to reduce template recall overheads.
Usage
[edit]- See Template:AchievementTable for basic usage of that template
The basic usage of the template is as follows: {{subst:AthResult|YEAR|COMPETITION|LOCATION|RESULT|GENDER|EVENT}}
The information appears in the template in roughly the same order as it appears when placed on a page. Once the substituted template is saved on to a page, the resulting entry will automatically become plain text, matching entries done in the usual manual style.
Parameters
[edit]Year
[edit]- The first parameter is the year of the competition you want to add (e.g. 2012).
Competition
[edit]- The second parameter denotes the competition. There are limited number of specific codes which correspond to the competitions which may be added:
Location
[edit]The third parameter denotes the location of the competition. Typical usage is to link the host city followed by its country unlinked (e.g. [[Berlin]], Germany).
Result
[edit]The fourth parameter corresponds to the finishing position of the athlete at that event (e.g. 1st, 2nd, 9th). Medal colours are automatically added. Qualifying statements may also be added if desired, for example, "20th (heats)".
Gender
[edit]The fifth parameter denotes the gender of the competition in which the athlete is competing: either Men or Women. This parameter is used to generate links to event result articles when they are present.
Event
[edit]The sixth parameter denotes the specific athletic event in which the athlete is competing (e.g. 100 metres, shot put, decathlon, marathon). This should not be linked.
Example
[edit]The code listed below will produce the following table. The first entry demonstrates how to insert notes alongside the template. The Olympic and European entries demonstrate how event result articles are automatically linked. The Asian Games entry links to the larger "Athletics Results" page.
{| {{AchievementTable|Event=yes}}
|-
{{subst:AthResult|2003|MWG|[[Catania]], Italy|1st|Women|10,000 metres}}
|33:42.10
|-
{{subst:AthResult|2004|OG|[[Athens]], Greece|2nd|Men|Discus throw}}
|-
{{subst:AthResult|2006|IBC|[[Ponce, Puerto Rico]]|3rd|Women|100 metres}}
|-
{{subst:AthResult|2010|AG|[[Beijing]], China|4th|Men|Javelin throw}}
|-
{{subst:AthResult|2011|EIC|[[Paris]], France|5th|Women|3000 metres}}
|}
| Year | Competition | Venue | Position | Event | Notes |
|---|---|---|---|---|---|
| 2003 | Military World Games | Catania, Italy | 1st | 10,000 metres | 33:42.10 |
| 2004 | Olympic Games | Athens, Greece | 2nd | Discus throw | |
| 2006 | Ibero-American Championships | Ponce, Puerto Rico | 3rd | 100 metres | |
| 2010 | Asian Games | Beijing, China | 4th | Javelin throw | |
| 2011 | European Indoor Championships | Paris, France | 5th | 3000 metres |
Fixing rowspan issues
[edit]If several entries refer to the same year then the rowspan parameter can be used. If omitted this defaults to 1 and will enter the year for a single line as normal. For example, the following code produces the following result:
{| {{AchievementTable}}
|-
{{subst:AthResult|2000|OG|[[Sydney]], Australia|1st|Men|200 metres|rowspan=3}}
|-
{{subst:AthResult|2000|OG|[[Sydney]], Australia|1st|Men|400 metres|rowspan=0}}
|-
{{subst:AthResult|2000|OG|[[Sydney]], Australia|1st|Men|800 metres|rowspan=0}}
|-
{{subst:AthResult|2004|OG|[[Athens]], Greece|1st|Men|1500 metres}}
|}
| Year | Competition | Venue | Position | Notes |
|---|---|---|---|---|
| 2000 | Olympic Games | Sydney, Australia | 1st | 200 metres |
| Olympic Games | Sydney, Australia | 1st | 400 metres | |
| Olympic Games | Sydney, Australia | 1st | 800 metres | |
| 2004 | Olympic Games | Athens, Greece | 1st | 1500 metres |
Known issues
[edit]- Where a table has both "Event" and "Notes" columns, notes can be manually added by placing them after a vertical bar "|" on the line below the AthResult code.
- For athletes who compete in just one event specifically (high jumpers for instance), this template will still generate the event name for each and every entry.