User:Chinissai/Tennis performance timeline/doc

This is a documentation subpage for User:Chinissai/Tennis performance timeline.
It may contain usage information, categories and other content that is not part of the original user template page.

This template produces a performance timeline table for articles on tennis players and their career statistics.

As of April 27, 2017, the template is under development and only works with male tennis players.

Usage

The template's syntax is as follows:

{{User:Chinissai/Tennis performance timeline
|types=<tournament levels>
|country=<code>

<season statistics>
<season statistics>
...
<season statistics>

|last=<tournament>
|prizemoney=...
}}

Named parameters have the following descriptions:

|types=: the tournament levels to be displayed in the performance timeline table. The <tournament levels> is a comma-separated list, e.g., GS,Career. A tournament level is a string in the order entry in tennis.orders within Module:Tennis performance timeline/data, or the string Career to display career win–loss and tournament counts. If |types= is omitted, all applicable tournament levels and career statistics will be included in the performance timeline table.
|country=: the ISO 3166-1 alpha-3 country code for the player's nationality. This optional parameter is only used in the statistics for player's national representation, such as in the Olympics, Davis Cup, and Fed Cup.
|last=: the last tournament whose statistics is included in the performance timeline table. The <tournament> is a string entry in Module:Tennis performance timeline/calendar, e.g., GS Roland Garros. Not only does this optional parameter serve as a note to editors, but it will also trigger the performance table to display an absence of the player from a tournament that has already concluded in the current year. Therefore, performance timeline tables should be updated only at the conclusion of a tournament. If |last= is unspecified, no absence in the current year will be displayed in the table.
|prizemoney=: the prize money the player has won. The value of this optional parameter is displayed boldface, but otherwise as is, in the lower-right cell of the performance timeline table.

Statistics for older seasons should appear before statistics for more recent ones.

Season statistics

The statistics for each season has the following syntax:

|year|<year>
<tournament statistics>
<tournament statistics>
...
<tournament statistics>
<court statistics>
<court statistics>
...
<court statistics>
|rank|<rank>

The specification for each season's statistics begins with the (mandatory) year of the season, e.g., |year|2017, and ends with the optional year-end ranking, e.g., |rank|1.

Tournament and court statistics can be intertwined, but this style is not recommended.

Tournament statistics

The statistics for each tournament has the following syntax:

|<tournament name>|<outcome>|<wins>|<losses>

<tournament name> is a table key in tennis.tournaments within Module:Tennis performance timeline/data, e.g., GS Wimbledon and 1000 Indian Wells. To add a new or missing tournament, please submit a request on the template's talk page.
<outcome> is the player's outcome of the tournament. This is a table key in tennis.rounds within Module:Tennis performance timeline/data, e.g., W and 4R, except for Davis Cup zones, where the zone number follows Z, as in Z1.
<wins> and <losses> are the official match wins and losses for the tournament. For instance, qualifying matches and walkovers are not counted and should not be included in the wins and losses.

Each tournament's statistics populates a cell within the performance timeline table. This cell might include a wikilink to the appropriate article for that tournament in the respective year. A red link indicates that the specifications of the tournament are incomplete; please report red links on the template's talk page.

Court statistics

The statistics for each court type has the following syntax:

|<environment>|<surface>|<tournament count>|<wins>|<losses>|<titles>|<runnerups>

<environment> is either outdoor or indoor
<surface> is a court surface, a table key in tennis.surfaces within Module:Tennis performance timeline/data. Currently, this is one of hard, clay, grass, and carpet.
<tournament count> is the number of tournaments played in this court type.
<wins> and <wins> are the official match wins and losses for this court type.
<titles> is the number of titles won in this court type.
<runnerups> is the number of final matches reached in this court type without winning a title.

Court types without an official match should be omitted.

Examples

Examples reflect Roger Federer's statistics from 2012 to 2013

Full display

This is the template's default behavior.

{{User:Chinissai/Tennis performance timeline
|country=SUI

|year|2012
|GS Australian Open|SF|4|1
|Davis Cup|1R|2|1
|1000 Indian Wells|W|6|0
|1000 Miami|3R|1|1
|1000 Madrid|W|5|0
|1000 Rome|SF|3|1
|GS Roland Garros|SF|5|1
|GS Wimbledon|W|7|0
|Summer Olympics|F-S|5|1
|1000 Cincinnati|W|5|0
|GS US Open|QF|3|1
|1000 Shanghai|SF|3|1
|World Tour Finals|F|3|2
|outdoor|hard|8|30|4|3|0
|outdoor|clay|3|15|2|1|0
|outdoor|grass|3|15|2|1|2
|indoor|hard|3|11|3|1|2
|indoor|clay|0|0|1|0|0
|rank|2

|year|2013
|GS Australian Open|SF|5|1
|1000 Indian Wells|QF|3|1
|1000 Madrid|3R|1|1
|1000 Rome|F|4|1
|GS Roland Garros|QF|4|1
|GS Wimbledon|2R|1|1
|1000 Cincinnati|QF|2|1
|GS US Open|4R|3|1
|1000 Shanghai|3R|1|1
|1000 Paris|SF|3|1
|World Tour Finals|SF|2|2
|outdoor|hard|6|17|6|0|0
|outdoor|clay|5|12|5|0|1
|outdoor|grass|2|5|1|1|0
|indoor|hard|4|11|5|0|1
|rank|6
}}

Tournament		2012	2013	SR	W–L	Win %
Tournament	Australian Open	SF	SF	0 / 2	9–2	81.82%
	French Open	SF	QF	0 / 2	9–2	81.82%
	Wimbledon	W	2R	1 / 2	8–1	88.89%
	US Open	QF	4R	0 / 2	6–2	75.00%
	Win–Loss	19–3	13–4	1 / 8	32–7	82.05%
Year-end championships	ATP World Tour Finals	F	SF	0 / 2	5–4	55.56%
Year-end championships	Win–Loss	3–2	2–2	0 / 2	5–4	55.56%
Masters 1000	Indian Wells Masters	W	QF	1 / 2	9–1	90.00%
	Miami Open	3R	A	0 / 1	1–1	50.00%
	Madrid Open	W	3R	1 / 2	6–1	85.71%
	Italian Open	SF	F	0 / 2	7–2	77.78%
	Cincinnati Masters	W	QF	1 / 2	7–1	87.50%
	Shanghai Masters	SF	3R	0 / 2	4–2	66.67%
	Paris Masters	A	SF	0 / 1	3–1	75.00%
	Win–Loss	23–3	14–6	3 / 12	37–9	80.43%
National representation	Summer Olympics	F-S	NH	0 / 1	5–1	83.33%
	Davis Cup	1R	A	0 / 1	2–1	66.67%
	Win–Loss	7–2	–	0 / 2	7–2	77.78%
Career	Hard Win–Loss	41–7	28–11	4 / 21	69–18	79.31%
	Clay Win–Loss	15–3	12–5	1 / 8	27–8	77.14%
	Grass Win–Loss	15–2	5–1	2 / 5	20–3	86.96%
	Outdoor Win–Loss	60–8	34–12	6 / 27	94–20	82.46%
	Indoor Win–Loss	11–4	11–5	1 / 7	22–9	70.97%
	Overall Win–Loss	71–12	45–17	7 / 34	116–29	80.00%
	Win %	85.5%	72.6%	7 / 34	116–29	80.00%
Tournaments played		17	17	34 total		20.6%
Finals reached		10	3	13 total		53.8%
Titles		6	1	7 total		53.8%
Year-end ranking		2	6

With specified types

A single type in |types= generates a short-form table.

{{User:Chinissai/Tennis performance timeline
|types=GS
|country=SUI

|year|2012
|GS Australian Open|SF|4|1
|Davis Cup|1R|2|1
|1000 Indian Wells|W|6|0
|1000 Miami|3R|1|1
|1000 Madrid|W|5|0
|1000 Rome|SF|3|1
|GS Roland Garros|SF|5|1
|GS Wimbledon|W|7|0
|Summer Olympics|F-S|5|1
|1000 Cincinnati|W|5|0
|GS US Open|QF|3|1
|1000 Shanghai|SF|3|1
|World Tour Finals|F|3|2
|outdoor|hard|8|30|4|3|0
|outdoor|clay|3|15|2|1|0
|outdoor|grass|3|15|2|1|2
|indoor|hard|3|11|3|1|2
|indoor|clay|0|0|1|0|0
|rank|2

|year|2013
|GS Australian Open|SF|5|1
|1000 Indian Wells|QF|3|1
|1000 Madrid|3R|1|1
|1000 Rome|F|4|1
|GS Roland Garros|QF|4|1
|GS Wimbledon|2R|1|1
|1000 Cincinnati|QF|2|1
|GS US Open|4R|3|1
|1000 Shanghai|3R|1|1
|1000 Paris|SF|3|1
|World Tour Finals|SF|2|2
|outdoor|hard|6|17|6|0|0
|outdoor|clay|5|12|5|0|1
|outdoor|grass|2|5|1|1|0
|indoor|hard|4|11|5|0|1
|rank|6
}}

Tournament	2012	2013	SR	W–L	Win %
Australian Open	SF	SF	0 / 2	9–2	81.82%
French Open	SF	QF	0 / 2	9–2	81.82%
Wimbledon	W	2R	1 / 2	8–1	88.89%
US Open	QF	4R	0 / 2	6–2	75.00%
Win–Loss	19–3	13–4	1 / 8	32–7	82.05%

The |types= parameter can be a list of comma-separated values. The career summary is unaffected by specified types.

{{User:Chinissai/Tennis performance timeline
|types=ATP1000,Career
|country=SUI

|year|2012
|GS Australian Open|SF|4|1
|Davis Cup|1R|2|1
|1000 Indian Wells|W|6|0
|1000 Miami|3R|1|1
|1000 Madrid|W|5|0
|1000 Rome|SF|3|1
|GS Roland Garros|SF|5|1
|GS Wimbledon|W|7|0
|Summer Olympics|F-S|5|1
|1000 Cincinnati|W|5|0
|GS US Open|QF|3|1
|1000 Shanghai|SF|3|1
|World Tour Finals|F|3|2
|outdoor|hard|8|30|4|3|0
|outdoor|clay|3|15|2|1|0
|outdoor|grass|3|15|2|1|2
|indoor|hard|3|11|3|1|2
|indoor|clay|0|0|1|0|0
|rank|2

|year|2013
|GS Australian Open|SF|5|1
|1000 Indian Wells|QF|3|1
|1000 Madrid|3R|1|1
|1000 Rome|F|4|1
|GS Roland Garros|QF|4|1
|GS Wimbledon|2R|1|1
|1000 Cincinnati|QF|2|1
|GS US Open|4R|3|1
|1000 Shanghai|3R|1|1
|1000 Paris|SF|3|1
|World Tour Finals|SF|2|2
|outdoor|hard|6|17|6|0|0
|outdoor|clay|5|12|5|0|1
|outdoor|grass|2|5|1|1|0
|indoor|hard|4|11|5|0|1
|rank|6
}}

Tournament		2012	2013	SR	W–L	Win %
Masters 1000	Indian Wells Masters	W	QF	1 / 2	9–1	90.00%
	Miami Open	3R	A	0 / 1	1–1	50.00%
	Madrid Open	W	3R	1 / 2	6–1	85.71%
	Italian Open	SF	F	0 / 2	7–2	77.78%
	Cincinnati Masters	W	QF	1 / 2	7–1	87.50%
	Shanghai Masters	SF	3R	0 / 2	4–2	66.67%
	Paris Masters	A	SF	0 / 1	3–1	75.00%
	Win–Loss	23–3	14–6	3 / 12	37–9	80.43%
Career	Hard Win–Loss	41–7	28–11	4 / 21	69–18	79.31%
	Clay Win–Loss	15–3	12–5	1 / 8	27–8	77.14%
	Grass Win–Loss	15–2	5–1	2 / 5	20–3	86.96%
	Outdoor Win–Loss	60–8	34–12	6 / 27	94–20	82.46%
	Indoor Win–Loss	11–4	11–5	1 / 7	22–9	70.97%
	Overall Win–Loss	71–12	45–17	7 / 34	116–29	80.00%
	Win %	85.5%	72.6%	7 / 34	116–29	80.00%
Tournaments played		17	17	34 total		20.6%
Finals reached		10	3	13 total		53.8%
Titles		6	1	7 total		53.8%
Year-end ranking		2	6

More examples can be found in subpages of this template.