User:Chinissai/Tennis performance timeline/doc

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=
 * country= is a comma-separated list, e.g.,  .  A tournament level is a string in the   entry in   within Module:Tennis performance timeline/data, or the string   to display career win–loss and tournament counts.  If {{para|types}} is omitted, all applicable tournament levels and career statistics will be included in the performance timeline table.
 * {{para|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.
 * {{para|last}}: the last tournament whose statistics is included in the performance timeline table. The   is a string entry in Module:Tennis performance timeline/calendar, e.g.,  .  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 {{para|last}} is unspecified, no absence in the current year will be displayed in the table.
 * {{para|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|
 * rank|

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

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

Tournament statistics
The statistics for each tournament has the following syntax:
 * is a table key in  within Module:Tennis performance timeline/data, e.g.,   and  .  To add a new or missing tournament, please submit a request on the template's talk page.
 * is the player's outcome of the tournament. This is a table key in   within Module:Tennis performance timeline/data, e.g.,   and , except for Davis Cup zones, where the zone number follows  , as in.
 * and  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:
 * is either  or
 * is a court surface, a table key in  within Module:Tennis performance timeline/data.  Currently, this is one of ,  ,  , and.
 * is the number of tournaments played in this court type.
 * and  are the official match wins and losses for this court type.
 * is the number of titles won in this court type.
 * 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.

With specified types
A single type in types generates a short-form table.

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

More examples can be found in subpages of this template.