Module:Sports table/styledoc

Footer options
The footer information can be customized (although notes and status will be inserted automatically if they are called; see XXX and YYY). The update date is set by update, see below for details. If no source is given a citation-needed tag is shown, source can provide an actual link. The classification results can be shown with class_rules, either directly or as a wikilink to a tie-breaker rules section. Using no_hide_class_rules suppresses the classification rules (this should only be used in template calls when multiple groups are summarized on a page and the rules are listed elsewhere on that page).

Dating
The default description is match(es), this can be changed by calling matches_text for any other term. When the season is active, the footer should include the date of the last match played that is included in the table. This can be achieved by setting date.
 * Active season


 * Completed season

When all matches have been played, the season is completed and the update line can be removed by setting complete.

Before any games are played, the date of the first game should be indicated by using future and setting the start date by start_date.
 * Future season

Stacking
Using only_pld_pts makes the table smaller, which may lead to undesired width and linebreaks in the footer that can be fixed with parameter stack_footer. By setting yes (or y, t, true or 1 or upper case variant of those) every new information, such as "source" and statuses, is displayed on a new row.
 * Without stack_footer


 * With stack_footer

Appearance
Only the position, team, matches and points columns can be displayed by defining yes (or y, t, true or 1 or upper case variant of those); no_hide_class_rules suppresses the classification rules only (this should only be used in template calls when multiple groups are summarized on a page and the rules are listed elsewhere on that page).

A line can be added between section of the table (if desired) by adding splitN with N the position below which the bar should be shown. (Note that this bar will not be shown for the bottom position in the table).

A custom width of the team column can be set by teamwidth, for example when multiple groups exist within one tournament and you want to force the same width on all groups.

The position column header can be customized by postitle and the position labels by pos_TTT for each team.

When multiple a table compares teams from multiple groups, the group can also be listed by setting yes (or y, t, true or 1 or upper case variant of those) and using group_TTT to indicate what teams comes from what group. The group column header can be customized by group_header, for example Lge.

Team highlighting and partial table
When using a table on a team (season) page, you might want to highlight the team (and possibly only show part of the table), especially after a template call to a long league table. Team TTT is highlighted by TTT. A limited part of the table is shown by show_limit, with the number indicating the number of position to show (if this is an even number, and it is in the middle of the table, then this number will be rounded up to the next odd number to show symmetry above and below).

A table can also start at position N, by using N in the module call.

Indicating results
The result of the table rankings can be indicated by a colored bar and text indicating the result. The header of this column is defined by res_col_header with predefined values of Q, QR, P, PQR, PR and R (indicating various combinations of promotion, qualification and relegation), any other entry than these exact codes will print as that entry in the column header. With N the position resultN declares the codes (or words if you want that instead) for the results column. Now when RRR is the results column, the colors are defined by col_RRR. The colors green1, green2, green3, green4, blue1, blue2, blue3, blue4, yellow1, yellow2, yellow3, yellow4, red1, red2, red3, red4, black1, black2, black3 and black4 are predefined and should be used preferentially per consensus on WT:FOOTY (you can use either html colors, or RGB color codes instead if you must [this is not recommended though, because it might violate WP:COLOR]). The text in the results column is now give by text_RRR, which can (and should) link to the relevant competition articles.

Consensus is also to use the colors in the following way: Green should be used for the top-level positive event (promotion, qualification, advancing to next round), blue for the second-level positive events (promotion play-offs when direct promotion exists, play-offs when direct qualification exist, secondary continental tornament), red for bottom-level negative events (relegation) and yellow for other level events. In addition, lower level colors should be used when teams qualify for different rounds (with lower levels corresponding to entry in lower rounds [green1 first, then green2, etc].) Black should be used when teams do not play a full season and their results are expunged or void. This consensus exists to have a uniform table appearance across Wikipedia. In addition, some wikiprojects have more detailed guidelines:
 * Football color guidelines

Indicating status
The promotion/qualification/relegation status of a team can be indicated by status_TTT with the letters indicated above (although only the ones in use for this style are shown below the table). The letters will appear next to the team in the order given. Whichever letters are called out in the table will automatically be explained alphabetically in the footer.

These letters can be used for all scenarios as exemplified by the following group phase example with 4 teams that play 3 matches where the first advances directly, the second team will go to play-offs and the remaining two teams are eliminated:
 * Teams start out without status letter
 * Teams that get eliminated get status (E)
 * Teams that can still finish worse than second (and might be eliminated) will remain without status
 * Teams that will finish at least second will get status (T)
 * Teams that will finish for sure second will get status (Q)
 * Teams that will finish for sure first will get status (A)

If these scenarios are not sufficient, some style have wild letters L (marked with a question mark in the overview). They should be accompanied by status_text_L to indicate a non-standard status.

Most styles allow for these letter to be placed after the team name or before, set after or before respectively, the default value can differ and its use differs between sports or regions.

Matches
The match list can be added by displayed by defining yes (or y, t, true or 1 or upper case variant of those). The column headers for the match results are defined by short_TTT for team TTT. The results for the game TTT vs. SSS can now be input by match_TTT_SSS. Future games can be listed with their date (possibly between small tags) or they can be left blank. (Note that this calls Module:Sports results to build the match table.) A note can be added to a result using match_TTT_SSS_note, this note can be shared with team TTT note by setting TTT when note_TTT is set. The width of the match columns can be customized by setting match_col_width to the desired width.