Difference between revisions of "Template:AchievementTable/doc"
blackwiki>Sillyfolkboy (refine cat) |
blackwiki>Sillyfolkboy (update doc) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
The '''AchievementTable''' template is a simple way to start a table to list [[track and field]] or [[athletics (sport)|athletics]] achievements on an athlete's article. For an in-use example, see [[James Kwalia]]. | The '''AchievementTable''' template is a simple way to start a table to list [[track and field]] or [[athletics (sport)|athletics]] achievements on an athlete's article. For an in-use example, see [[James Kwalia]]. | ||
| + | |||
| + | ==Parameters== | ||
| + | The template has four parameters, all of them optional. | ||
| + | <pre>{{AchievementTable|width=|nation=|Event=|NotesOff=}}</pre> | ||
| + | *'''width''' This amends the overall width of the achievement table in percent of the page width. This defaults to 71, which is the optimal width for usage alongside the {{tl|MedalTableTop}} series of templates | ||
| + | *'''nation''' This allows for a caption showing the nation that the athlete represented at the competition. This should only be used when an athlete has represented multiple nations. Note that where different nations are represented as separate table with a new caption should be used as this [[Wikipedia:Manual of Style/Accessibility/Data tables tutorial|helps accessibility]] for screen readers. This option defaults to no caption. | ||
| + | *'''Event''' This adds an additional "Event" column before the final "Notes" column, which should be used to denote the athletic discipline that the result relates to (e.g. [[100 metres]]). The default is that this column is not shown. | ||
| + | *'''NotesOff''' This removes the final notes column from the table – useful when no notes are available or required. The default is that the Notes column is shown. | ||
==Usage== | ==Usage== | ||
In order to use the template, simply open a table and add the template as follows: | In order to use the template, simply open a table and add the template as follows: | ||
| − | < | + | <pre>{| {{AchievementTable}}</pre> |
'''Using this template can help you write tables like the one below''' | '''Using this template can help you write tables like the one below''' | ||
| Line 12: | Line 20: | ||
|2001 | |2001 | ||
|[[2001 IAAF World Youth Championships|World Youth Championships]] | |[[2001 IAAF World Youth Championships|World Youth Championships]] | ||
| − | |[[Debrecen]], | + | |[[Debrecen]], Hungary |
| − | |bgcolor="#cc9966 | + | |bgcolor="#cc9966" | 3rd |
|3000 m | |3000 m | ||
| | | | ||
| Line 19: | Line 27: | ||
|2003 | |2003 | ||
|[[2003 IAAF World Athletics Final|World Athletics Final]] | |[[2003 IAAF World Athletics Final|World Athletics Final]] | ||
| − | |[[Monte Carlo]], | + | |[[Monte Carlo]], Monaco |
| − | + | | 5th | |
|3000 m | |3000 m | ||
| | | | ||
| Line 26: | Line 34: | ||
|2004 | |2004 | ||
|[[2004 IAAF World Athletics Final|World Athletics Final]] | |[[2004 IAAF World Athletics Final|World Athletics Final]] | ||
| − | |[[Monte Carlo]], | + | |[[Monte Carlo]], Monaco |
| − | |bgcolor="silver | + | |bgcolor="silver"| 2nd |
|3000 m | |3000 m | ||
| | | | ||
| Line 33: | Line 41: | ||
|rowspan=4|2005 | |rowspan=4|2005 | ||
|[[2005 IAAF World Cross Country Championships|World Cross Country Championships]] | |[[2005 IAAF World Cross Country Championships|World Cross Country Championships]] | ||
| − | |[[St Etienne]], | + | |[[St Etienne]], France |
| − | + | | 15th | |
|Short race | |Short race | ||
| | | | ||
|- | |- | ||
|[[2005 World Championships in Athletics|World Championships]] | |[[2005 World Championships in Athletics|World Championships]] | ||
| − | |[[Helsinki]], | + | |[[Helsinki]], Finland |
| − | + | | 13th | |
|[[2005 World Championships in Athletics – Men's 5000 metres|5000 m]] | |[[2005 World Championships in Athletics – Men's 5000 metres|5000 m]] | ||
| | | | ||
|- | |- | ||
|[[2005 IAAF World Athletics Final|World Athletics Final]] | |[[2005 IAAF World Athletics Final|World Athletics Final]] | ||
| − | |[[Monte Carlo]], | + | |[[Monte Carlo]], Monaco |
| − | + | | 6th | |
|5000 m | |5000 m | ||
| | | | ||
|- | |- | ||
|[[2005 Asian Athletics Championships|Asian Athletics Championships]] | |[[2005 Asian Athletics Championships|Asian Athletics Championships]] | ||
| − | |[[Incheon]], | + | |[[Incheon]], South Korea |
| − | |bgcolor="gold | + | |bgcolor="gold"| 1st |
|5000 m | |5000 m | ||
| | | | ||
| Line 60: | Line 68: | ||
You can start to add the details immediately after using the AchievementTable template. For example, the following code: | You can start to add the details immediately after using the AchievementTable template. For example, the following code: | ||
| − | < | + | <pre>{| {{AchievementTable|nation=ESP}} |
| − | + | |- | |
|2004 | |2004 | ||
| − | |||
|2004 Summer Olympics | |2004 Summer Olympics | ||
| − | |||
|Athens, Greece | |Athens, Greece | ||
| − | |||
|4th | |4th | ||
| − | |||
|10.04 seconds | |10.04 seconds | ||
| − | |||
|- | |- | ||
| − | |||
|2008 | |2008 | ||
| − | |||
|2008 Summer Olympics | |2008 Summer Olympics | ||
| − | |||
|Beijing, China | |Beijing, China | ||
| − | |||
|5th | |5th | ||
| − | |||
|10.08 seconds | |10.08 seconds | ||
| − | + | |}</pre> | |
| − | |}</ | ||
'''Would give you the following table:''' | '''Would give you the following table:''' | ||
| − | {|{{AchievementTable}} | + | {|{{AchievementTable|nation=ESP}} |
|2004 | |2004 | ||
|2004 Summer Olympics | |2004 Summer Olympics | ||
| Line 105: | Line 102: | ||
Many athletes compete in more than one event, sometimes within the same competition – [[Usain Bolt]] in the 100 and 200 metres at the 2008 Olympics for instance. If you need to note the specific event which the athlete was competing in, then you can activate the "Event" column. | Many athletes compete in more than one event, sometimes within the same competition – [[Usain Bolt]] in the 100 and 200 metres at the 2008 Olympics for instance. If you need to note the specific event which the athlete was competing in, then you can activate the "Event" column. | ||
| − | < | + | <pre>{|{{AchievementTable|Event=yes|nation=ESP}} |
| − | + | |- | |
|2004 | |2004 | ||
| − | |||
|2004 Summer Olympics | |2004 Summer Olympics | ||
| − | |||
|Athens, Greece | |Athens, Greece | ||
| − | |||
|4th | |4th | ||
| − | |||
|100 metres | |100 metres | ||
| − | |||
|10.04 seconds | |10.04 seconds | ||
| − | |||
|- | |- | ||
| − | |||
|2004 | |2004 | ||
| − | |||
|2004 Summer Olympics | |2004 Summer Olympics | ||
| − | |||
|Athens, Greece | |Athens, Greece | ||
| − | |||
|8th | |8th | ||
| − | |||
|200 metres | |200 metres | ||
| − | |||
|20.45 seconds | |20.45 seconds | ||
| − | |||
|- | |- | ||
| − | |||
|2008 | |2008 | ||
| − | |||
|2008 Summer Olympics | |2008 Summer Olympics | ||
| − | |||
|Beijing, China | |Beijing, China | ||
| − | |||
|5th | |5th | ||
| − | |||
|100 metres | |100 metres | ||
| − | |||
|10.08 seconds | |10.08 seconds | ||
| − | |||
|- | |- | ||
| − | |||
|2008 | |2008 | ||
| − | |||
|2008 Summer Olympics | |2008 Summer Olympics | ||
| − | |||
|Beijing, China | |Beijing, China | ||
| − | |||
|7th | |7th | ||
| − | |||
|200 metres | |200 metres | ||
| − | |||
|20.31 seconds | |20.31 seconds | ||
| − | + | |}</pre> | |
| − | |}</ | ||
'''Would give you the following table:''' | '''Would give you the following table:''' | ||
| − | {|{{AchievementTable|Event=yes}} | + | {|{{AchievementTable|Event=yes|nation=ESP}} |
|2004 | |2004 | ||
|2004 Summer Olympics | |2004 Summer Olympics | ||
| Line 198: | Line 168: | ||
To turn off the notes column in the table simply add "NotesOff=yes" into the template. | To turn off the notes column in the table simply add "NotesOff=yes" into the template. | ||
| − | < | + | <pre>{|{{AchievementTable|Event=yes|NotesOff=yes|nation=ESP}} |
| − | + | |- | |
|2004 | |2004 | ||
| − | |||
|2004 Summer Olympics | |2004 Summer Olympics | ||
| − | |||
|Athens, Greece | |Athens, Greece | ||
| − | |||
|4th | |4th | ||
| − | |||
|100 metres | |100 metres | ||
| − | |||
|- | |- | ||
| − | |||
|2004 | |2004 | ||
| − | |||
|2004 Summer Olympics | |2004 Summer Olympics | ||
| − | |||
|Athens, Greece | |Athens, Greece | ||
| − | |||
|8th | |8th | ||
| − | |||
|200 metres | |200 metres | ||
| − | + | |}</pre> | |
| − | |}</ | ||
'''Would give you the following table:''' | '''Would give you the following table:''' | ||
| − | + | {|{{AchievementTable|Event=yes|NotesOff=yes|nation=ESP}} | |
| − | {|{{AchievementTable|Event=yes|NotesOff=yes}} | ||
|2004 | |2004 | ||
|2004 Summer Olympics | |2004 Summer Olympics | ||
| Line 239: | Line 197: | ||
|200 metres | |200 metres | ||
|} | |} | ||
| − | |||
''Note that the [[Vertical bar]]'' ( | ) ''character can be written by holding shift and pressing the'' " \ " ''key.'' | ''Note that the [[Vertical bar]]'' ( | ) ''character can be written by holding shift and pressing the'' " \ " ''key.'' | ||
Revision as of 19:27, 17 November 2014
| This is a documentation subpage for Template:AchievementTable. It contains usage information, categories and other content that is not part of the original template page. |
The AchievementTable template is a simple way to start a table to list track and field or athletics achievements on an athlete's article. For an in-use example, see James Kwalia.
Parameters
The template has four parameters, all of them optional.
{{AchievementTable|width=|nation=|Event=|NotesOff=}}
- width This amends the overall width of the achievement table in percent of the page width. This defaults to 71, which is the optimal width for usage alongside the {{MedalTableTop}} series of templates
- nation This allows for a caption showing the nation that the athlete represented at the competition. This should only be used when an athlete has represented multiple nations. Note that where different nations are represented as separate table with a new caption should be used as this helps accessibility for screen readers. This option defaults to no caption.
- Event This adds an additional "Event" column before the final "Notes" column, which should be used to denote the athletic discipline that the result relates to (e.g. 100 metres). The default is that this column is not shown.
- NotesOff This removes the final notes column from the table – useful when no notes are available or required. The default is that the Notes column is shown.
Usage
In order to use the template, simply open a table and add the template as follows:
{| {{AchievementTable}}
Using this template can help you write tables like the one below
| Year | Competition | Venue | Position | Event | Notes |
|---|---|---|---|---|---|
| 2001 | World Youth Championships | Debrecen, Hungary | 3rd | 3000 m | |
| 2003 | World Athletics Final | Monte Carlo, Monaco | 5th | 3000 m | |
| 2004 | World Athletics Final | Monte Carlo, Monaco | 2nd | 3000 m | |
| 2005 | World Cross Country Championships | St Etienne, France | 15th | Short race | |
| World Championships | Helsinki, Finland | 13th | 5000 m | ||
| World Athletics Final | Monte Carlo, Monaco | 6th | 5000 m | ||
| Asian Athletics Championships | Incheon, South Korea | 1st | 5000 m |
Basic examples
You can start to add the details immediately after using the AchievementTable template. For example, the following code:
{| {{AchievementTable|nation=ESP}}
|-
|2004
|2004 Summer Olympics
|Athens, Greece
|4th
|10.04 seconds
|-
|2008
|2008 Summer Olympics
|Beijing, China
|5th
|10.08 seconds
|}
Would give you the following table:
| Year | Competition | Venue | Position | Notes |
|---|---|---|---|---|
| 2004 | 2004 Summer Olympics | Athens, Greece | 4th | 10.04 seconds |
| 2008 | 2008 Summer Olympics | Beijing, China | 5th | 10.08 seconds |
Event feature
Many athletes compete in more than one event, sometimes within the same competition – Usain Bolt in the 100 and 200 metres at the 2008 Olympics for instance. If you need to note the specific event which the athlete was competing in, then you can activate the "Event" column.
{|{{AchievementTable|Event=yes|nation=ESP}}
|-
|2004
|2004 Summer Olympics
|Athens, Greece
|4th
|100 metres
|10.04 seconds
|-
|2004
|2004 Summer Olympics
|Athens, Greece
|8th
|200 metres
|20.45 seconds
|-
|2008
|2008 Summer Olympics
|Beijing, China
|5th
|100 metres
|10.08 seconds
|-
|2008
|2008 Summer Olympics
|Beijing, China
|7th
|200 metres
|20.31 seconds
|}
Would give you the following table:
| Year | Competition | Venue | Position | Event | Notes |
|---|---|---|---|---|---|
| 2004 | 2004 Summer Olympics | Athens, Greece | 4th | 100 metres | 10.04 seconds |
| 2004 | 2004 Summer Olympics | Athens, Greece | 8th | 200 metres | 20.45 seconds |
| 2008 | 2008 Summer Olympics | Beijing, China | 5th | 100 metres | 10.08 seconds |
| 2008 | 2008 Summer Olympics | Beijing, China | 7th | 200 metres | 20.31 seconds |
NotesOff feature
To turn off the notes column in the table simply add "NotesOff=yes" into the template.
{|{{AchievementTable|Event=yes|NotesOff=yes|nation=ESP}}
|-
|2004
|2004 Summer Olympics
|Athens, Greece
|4th
|100 metres
|-
|2004
|2004 Summer Olympics
|Athens, Greece
|8th
|200 metres
|}
Would give you the following table:
| Year | Competition | Venue | Position | Event |
|---|---|---|---|---|
| 2004 | 2004 Summer Olympics | Athens, Greece | 4th | 100 metres |
| 2004 | 2004 Summer Olympics | Athens, Greece | 8th | 200 metres |
Note that the Vertical bar ( | ) character can be written by holding shift and pressing the " \ " key.
See also