Module:Sports table/Custom

Jump to navigation Jump to search

This style for Lua-based Module:Sports table is meant to build group and league tables for competitions with various formats. Unlike other styles for the Sports table module, this style does not calculate values other than the number of games played and a simple calculation for points. If you need other calculations or if you are creating a table for a competition in a sport with a sport specific style, consider using another style. The purpose of the Custom style is to allow a custom configuration of any columns that you intend to use. This documentation explains how to use this module with the Custom style in an article or template, check the table of contents for specific items.

Usage

Basic usage

In its simplest form only several parameters need to be used to build a table.

What you type
{{#invoke:Sports table|main|style=Custom
|num_cols=6
|colstyle2=win
|col_header4={{Abbr|Ex|Example header}}
|default_value5=—

|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|win_FDT=5             |loss_FDT=0 |col6_FDT=10
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |col6_BBB= 3
|win_CCC=3             |loss_CCC=2 |col6_CCC= 3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |col6_DDD= 1
|win_EEE=0             |loss_EEE=5

|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}
What it looks like
Pos Team 1 W 3 Ex 5 6
1 FIFA World Cup Dream Team    5       10
2 Team 2    3       3
3 Team 3    3       3
4 Team 4    1       1
5  Gibraltar    0         
Updated to match(es) played on unknown. Source: [citation needed]

The main command is the {{#invoke:Sports table|main|style=Custom}} statement which basically calls the module and enables you to set everything up. You also need to set the |num_cols= parameter to determine how many columns will be displayed after the team column. If this is not set, then there will be one column after the team column. For each column you now define the column style and/or column header by using |colstyleN= and |col_headerN= respectively (with N replaced by the column number). For more information on column styles, see #Column styles. To set the order and number of rows, you list the positions of the teams as |team1=, |team2=, etc for however many teams you need in the table. You can use full team names there without spaces if you want, but using codes (as in the example) can make it easier. For each team you now define the wins, draws, losses, and values contained in column number N by using |win_TTT=, |draw_TTT=, |loss_TTT= and |colN_TTT= respectively (with TTT replaced by the team code). If you do not define these numbers, it is automatically assumed to be   , except for columns which use a column style or have defined |default_valueN=. It is good practice though to include them anyway and to align the columns using appropriate spaces (as in the example), so the code is easy to read. The last step now is to define the |name_TTT= parameters which determine what name is shown in the table, you can use wiki markup and templates in here as well. See #Dating to see how to change the update date.

Ranking column

One of the columns should always be a ranking column. This column may be chosen by a parameter.

What you type
{{#invoke:Sports table|main|style=Custom
|num_cols=6
|ranking_col=2
|colstyle2=win
|col_header4={{Abbr|Ex|Example header}}
|default_value5=—

|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|win_FDT=5             |loss_FDT=0 |col6_FDT=10
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |col6_BBB= 3
|win_CCC=3             |loss_CCC=2 |col6_CCC= 3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |col6_DDD= 1
|win_EEE=0             |loss_EEE=5

|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}
What it looks like
Pos Team 1 W 3 Ex 5 6
1 FIFA World Cup Dream Team    5       10
2 Team 2    3       3
3 Team 3    3       3
4 Team 4    1       1
5  Gibraltar    0         
Updated to match(es) played on unknown. Source: [citation needed]

The |ranking_col= parameter selects which parameter is the ranking column. This column will be bolded and any head-to-head notes will be applied to the content of cells in this column. See #Notes for more information on head-to-head notes. By default, the ranking column is the last column. If you do not want any column to be the ranking column, use |ranking_col=0. Note that in this case you should not define any head-to-head notes, because they will not be displayed.

Column styles

It is very useful to set column styles in these tables

What you type
{{#invoke:Sports table|main|style=Custom
|num_cols=8
|colstyle1=pld
|colstyle2=win
|colstyle3=draw
|default_value3=—
|colstyle4=loss
|colstyle5=points
|colstyle6=points
|colstyle7=ppg
|colstyle8=sum_ppg_col6

|winpoints=2
|drawpoints=1
|losspoints=-0.1

|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|win_FDT=5             |loss_FDT=0 |col6_FDT=10
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |col6_BBB= 3
|win_CCC=3             |loss_CCC=2 |col6_CCC= 3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |col6_DDD= 1
|win_EEE=0             |loss_EEE=5

|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}
What it looks like
Pos Team Pld W D L Pts Pts PPG 8
1 FIFA World Cup Dream Team 5 5 0 0 10 10 2.00 12.00
2 Team 2 5 3 1 1 6.9 3 1.38 4.38
3 Team 3 5 3 0 2 5.8 3 1.16 4.16
4 Team 4 5 1 1 3 2.7 1 0.54 1.54
5  Gibraltar 5 0 0 5 −0.5 −0.5 −0.10 −0.10
Updated to match(es) played on unknown. Source: [citation needed]

Note that in this table, even though |default_value3=— an Em-dash is not displayed when draw data is not given. This is because the default value set by the column style supersedes any manually entered default value. However column 6 shows that data entered manually via |col6_TTT= supersedes the column style data. This example shows multiple relevant column styles

pld, played, match, or matches

If the column style is set to one of these values, then the default value of a cell is calculated by adding up |win_TTT= plus |draw_TTT= plus |loss_TTT=, each of whose default values are 0. The column header is Pld, but may be changed using |pld_header=.

w, win, or wins

If the column style is set to one of these values, then the default value of a cell is the value of |win_TTT= or 0 if no such value is given. The column header is W.

d, draw, or draws

If the column style is set to one of these values, then the default value of a cell is the value of |draw_TTT= or 0 if no such value is given. The column header is D. For backwards compatibility with the WDL style, if |use_tie= is set to yes, then the header is T, and in either case, the header may be changed using |draw_header=

l, loss, or losses

If the column style is set to one of these values, then the default value of a cell is the value of |loss_TTT= or 0 if no such value is given. The column header is L.

rw

For backwards compatibility with the WDL style, there is an option for a rounds won column style. If the column style is set to this value, then the default value of a cell is the value of |rw_TTT= or 0 if no such value is given. The column header is RW, but may be changed using |rw_header=.

pts or points

If the column style is set to one of these values, then the default value of a cell is the number of points obtained by adding up the appropriate values for the wins, draws, losses, and rounds won. As a default a win is worth 3 points, a draw 1 point, a loss 0 points, and a round won 1 point. These values can be overwritten to what you need by |winpoints=, |drawpoints=, |losspoints= and |rwpoints=. The column header is Pts.

ppg

If the column style is set to this value, then the default value of a cell is the points as calculated above divided by the number of matches as calculated above. Even if these values have been overridden by |colN_TTT=, the calculated value is used and not the input value. The column header is PPG. A column with the ppg style will be slightly wider than the default column width.

ppga

It means "ppg average"; same as ppg but the value gives three decimal places.

sum_S_T or diff_S_T

If the column style is set to one of these values, with S and T replaced by non-mathematical column styles, then the value of a cell will be the mathematical result of the chosen operation on the values determined by the column styles specified by S and T. Note that if entries for S or T are not defined, then a default value of 0 is set, even if they are present in a column with a different default value. A mathematical style does not alter the column header from the default. The parameter |plus_sign_diffs= determines whether a plus sign is shown on differences that are positive. By default this value is set to |plus_sign_diffs=no.

other

Any other column style will not set a default value, and so the default cell value set by |default_valueN= will be used. If the column style is set to such a value other than those listed above which is at most 3 characters long, then the column header is a fully uppercase version of the column style. For example, if the column style is set to cs, then the column header is CS. However, if the column style is set to a value other than those listed above that is longer than 3 characters, no alteration to the header will be made. For example, if the 2nd column style is set to cscs, then the column header is 2. Additionally, if the column style is set to a value other than those listed above, then input may be taken from a parameter given by the column style underscore TTT. For example, if the column style is set to cs, then input may be taken via |cs_TTT= in addition to the usual |colN_TTT=. Currently, custom column styles should only contain alphanumeric characters. The results of anything else are undefined.

Default styles

If you wish to set the column style of multiple columns at once to imitate a different style of the Sports table module, then this may be done using the |default_style= parameter.

What you type
{{#invoke:Sports table|main|style=Custom
|default_style=WDLbasic
|num_cols=6
|colstyle3=W

|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|win_FDT=5             |loss_FDT=0 |col6_FDT=10
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |col6_BBB= 3
|win_CCC=3             |loss_CCC=2 |col6_CCC= 3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |col6_DDD= 1
|win_EEE=0             |loss_EEE=5

|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}
What it looks like
Pos Team Pld W W L Pts 6
1 FIFA World Cup Dream Team 5 5 5 0 15 10
2 Team 2 5 3 3 1 10 3
3 Team 3 5 3 3 2 9 3
4 Team 4 5 1 1 3 4 1
5  Gibraltar 5 0 0 5 0   
Updated to match(es) played on unknown. Source: [citation needed]

For backwards compatibility with the WDL style, there are many choices for |default_style= which produce similar columns to those in the WDL style. Valid choices for this parameter are shown below. If the parameter |num_cols= is set, this parameter will take precedence over the number of columns given by the default style. If no |ranking_col= is defined, then the ranking column will be set equal to the pts column. Note that a column style set using |colstyleN= takes precedence over the column style set by |default_style=. For backwards compatibility with the WDL style, if using one of these default styles, then parameters |show_win=, |show_draw=, |show_loss=, and |hide_played= may be used to remove some of these columns, and alter the number of columns accordingly. Additionally, to list losses first, use |loss_before_draw=true or |loss_before_tie=true.

WDLbasic

Column styles are (in order): pld, win, draw, loss, pts

WLbasic

Column styles are (in order): pld, win, loss, pts

WDLgdiff

Column styles are (in order): pld, win, draw, loss, gf, ga, diff_gf_ga, pts

WLgdiff

Column styles are (in order): pld, win, loss, gf, ga, diff_gf_ga, pts

Customization

Several things can be customized in these tables

Bolded columns

Normally, only the ranking column has bolded entries. This may be customized.

What you type
{{#invoke:Sports table|main|style=Custom
|default_style=WDLbasic
|num_cols=6
|bold_col2=yes

|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|win_FDT=5             |loss_FDT=0 |col6_FDT=10
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |col6_BBB= 3
|win_CCC=3             |loss_CCC=2 |col6_CCC= 3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |col6_DDD= 1
|win_EEE=0             |loss_EEE=5

|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}
What it looks like
Pos Team Pld W D L Pts 6
1 FIFA World Cup Dream Team 5 5 0 0 15 10
2 Team 2 5 3 1 1 10 3
3 Team 3 5 3 0 2 9 3
4 Team 4 5 1 1 3 4 1
5  Gibraltar 5 0 0 5 0   
Updated to match(es) played on unknown. Source: [citation needed]

You can set all entries of column number N to be bolded by using |bold_colN=yes. Note that if a column style sets a column to be bolded, then there is no way to set that column to a normal font weight.

Column alignment

Normally the data in any column (other than the team name column) is placed in the center of the column. This may be customized.

What you type
{{#invoke:Sports table|main|style=Custom
|default_style=WDLbasic
|num_cols=6
|aligncol6=r

|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|win_FDT=5             |loss_FDT=0 |col6_FDT=10
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |col6_BBB= 3
|win_CCC=3             |loss_CCC=2 |col6_CCC= 3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |col6_DDD= 1
|win_EEE=0             |loss_EEE=5

|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_DDD=Team 4
|name_EEE={{fb|GIB}}
}}
What it looks like
Pos Team Pld W D L Pts 6
1 FIFA World Cup Dream Team 5 5 0 0 15 10
2 Team 2 5 3 1 1 10 3
3 Team 3 5 3 0 2 9 3
4 Team 4 5 1 1 3 4 1
5  Gibraltar 5 0 0 5 0   
Updated to match(es) played on unknown. Source: [citation needed]

You can choose the text alignment of column number N by using |aligncolN=. Note that the column header is always centered.

Header options

What you type
{{#invoke:Sports table|main|style=Custom
|num_cols=2
|colstyle1=w
|col_header2=<abbr title="Won after extra time or penalties">W+</abbr>
|team_header=Player
}}
What it looks like
Pos Player W W+
Updated to match(es) played on unknown. Source: [citation needed]

The wording of the Team column can be adjusted using |team_header=. Similarly, the wording of any given custom column number N can be adjusted by |col_headerN= and this wording is used instead of any wording set by a column style.

Footer options

What you type
{{#invoke:Sports table|main|style=Custom
|update=1 January 1900
|source=[https://en.wikipedia.org/wiki/Main_Page Wikipedia]

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|name_AAA=Team A
|name_BBB=Team B
|name_CCC=Team C
|name_DDD=Team D
|name_EEE=Team E

|class_rules=1) points; 2) goal difference; 3) number of goals scored.
}}
What it looks like
Pos Team 1
1 Team A   
2 Team B   
3 Team C   
4 Team D   
5 Team E   
Updated to match(es) played on 1 January 1900. Source: Wikipedia
Rules for classification: 1) points; 2) goal difference; 3) number of goals scored.

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 |only_pld_pts=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.

Active season
What you type
{{#invoke:Sports table|main|style=Custom
|update=1 January 1900
}}
What it looks like
Pos Team 1
Updated to match(es) played on 1 January 1900. Source: [citation needed]

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 |update=date.

Completed season
What you type
{{#invoke:Sports table|main|style=Custom
|update=complete
}}
What it looks like
Pos Team 1
Source: [citation needed]

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

Future season
What you type
{{#invoke:Sports table|main|style=Custom
|update=future |start_date=1 January 2121
}}
What it looks like
Pos Team 1
First match(es) will be played on 1 January 2121. Source: [citation needed]

Before any games are played, the date of the first game should be indicated by using |update=future and setting the start date by |start_date=.

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 |stack_footer=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
What you type
{{#invoke:Sports table|main|style=Custom
|only_pld_pts=yes 

|team1=AAA |name_AAA=The A Team
|result1=RRR

|status_AAA=DEOPRT

|res_col_header=PQR
|col_RRR= |text_RRR=Plain text
}}
What it looks like
Pos Team 1
1 The A Team (D, E, O, P, R, T)   
Updated to match(es) played on unknown. Source: [citation needed]
(D) Disqualified; (E) Eliminated; (O) Play-off winner; (P) Promoted; (R) Relegated; (T) Qualified, but not yet to the particular phase indicated
With stack_footer
What you type
{{#invoke:Sports table|main|style=Custom
|only_pld_pts=yes 
|stack_footer=yes 

|team1=AAA |name_AAA=The A Team
|result1=RRR

|status_AAA=DEOPRT

|res_col_header=PQR
|col_RRR= |text_RRR=Plain text
}}
What it looks like
Pos Team 1
1 The A Team (D, E, O, P, R, T)   
Updated to match(es) played on unknown.
Source: [citation needed]
(D) Disqualified;
(E) Eliminated;
(O) Play-off winner;
(P) Promoted;
(R) Relegated;
(T) Qualified, but not yet to the particular phase indicated

Appearance

What you type
{{#invoke:Sports table|main|style=Custom

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|name_AAA=Team A
|name_BBB=Team B
|name_CCC=Team C
|name_DDD=Team D
|name_EEE=Team E

|only_pld_pts=yes
}}
What it looks like
Pos Team 1
1 Team A   
2 Team B   
3 Team C   
4 Team D   
5 Team E   
Updated to match(es) played on unknown. Source: [citation needed]
What you type
{{#invoke:Sports table|main|style=Custom

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|name_AAA=Team A
|name_BBB=Team B
|name_CCC=Team C
|name_DDD=Team D
|name_EEE=Team E

|split2=yes
|split3=
|split5=1
|teamwidth=250
|postitle={{abbr|Exam.|Example}}
}}
What it looks like
Exam. Team 1
1 Team A   
2 Team B   
3 Team C   
4 Team D   
5 Team E   
Updated to match(es) played on unknown. Source: [citation needed]
What you type
{{#invoke:Sports table|main|style=Custom

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|name_AAA=Team A
|name_BBB=Team B
|name_CCC=Team C
|name_DDD=Team D
|name_EEE=Team E

|show_groups=yes
|group_AAA=A
|group_BBB=A
|group_CCC=B
|group_DDD=B
|group_EEE=C
}}
What it looks like
Pos Grp Team 1
1 A Team A   
2 A Team B   
3 B Team C   
4 B Team D   
5 C Team E   
Updated to match(es) played on unknown. Source: [citation needed]

Only the position, team, matches and points columns can be displayed by defining |only_pld_pts=yes (or y, t, true or 1 or upper case variant of those); |only_pld_pts=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 |show_groups=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 |group_header=<abbr title="League">Lge</abbr>.

Team highlighting and partial table

What you type
{{#invoke:Sports table|main|style=Custom
|showteam=DDD

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|name_AAA=Team A
|name_BBB=Team B
|name_CCC=Team C
|name_DDD=Team D
|name_EEE=Team E

|show_limit=3
}}
What it looks like
Pos Team 1
3 Team C   
4 Team D   
5 Team E   
Updated to match(es) played on unknown. Source: [citation needed]

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 |showteam=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 |highest_pos=N in the module call.

Results and status

Indicating results

What you type
{{#invoke:Sports table|main|style=Custom

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|result1=WC |result2=PO |result3=PO |result4=RPO |result5=rel

|name_AAA=Team A
|name_BBB=Team B
|name_CCC=Team C
|name_DDD=Team D
|name_EEE=Team E

|res_col_header=QR
|col_WC=green1 |text_WC=Qualification to [[World Cup]]
|col_PO=blue1  |text_PO=Qualification to play-offs
|col_RPO=red2  |text_RPO=Qualification to relegation play-offs
|col_rel=red1  |text_rel=Relegation to lower division
}}
What it looks like
Pos Team 1 Qualification or relegation
1 Team A    Qualification to World Cup
2 Team B    Qualification to play-offs
3 Team C   
4 Team D    Qualification to relegation play-offs
5 Team E    Relegation to lower division
Updated to match(es) played on unknown. Source: [citation needed]

The result of the table rankings can be indicated by a coloured 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 colours are defined by |col_RRR=. The colours 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 colours, or RGB colour 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 colours 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 tournament), red for bottom-level negative events (relegation) and yellow for other level events. In addition, lower level colours 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:

Colour options
Green green1 green2 green3 green4
Blue blue1 blue2 blue3 blue4
Yellow yellow1 yellow2 yellow3 yellow4
Red red1 red2 red3 red4
Black black1 black2 black3 black4
Orange orange1 orange2 White white1

Indicating status

What you type
{{#invoke:Sports table|main|style=Custom
|status_pos=after

|team1=AAA 
|result1=RRR

|status_AAA=ABCDEFGHIJKLMNOPQRSTUVWXYZ

|name_AAA=Team A

|res_col_header=PQR
|col_RRR= |text_RRR=Plain text

|status_text_X=Custom 1
|status_text_Y=Custom 2
|status_text_Z=Custom 3
}}
What it looks like
Pos Team 1 Promotion, qualification or relegation
1 Team A (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z)    Plain text
Updated to match(es) played on unknown. Source: [citation needed]
(A) Advance to a further round; (B) ?; (C) Champion; (D) Disqualified; (E) Eliminated; (F) ?; (G) Guest; (H) Host; (I) ?; (J) ?; (K) ?; (L) ?; (M) ?; (N) ?; (O) Play-off winner; (P) Promoted; (Q) Qualified to the phase indicated; (R) Relegated; (S) ?; (T) Qualified, but not yet to the particular phase indicated; (U) ?; (V) ?; (W) ?; (X) Custom 1; (Y) Custom 2; (Z) Custom 3
What you type
{{#invoke:Sports table|main|style=Custom
|status_pos=before

|team1=AAA 

|status_AAA=ABCDEFGHIJKLMNOPQRSTUVWXYZ

|name_AAA=Team A

|status_text_X=Custom 1
|status_text_Y=Custom 2
|status_text_Z=Custom 3
}}
What it looks like
Pos Team 1
1 a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z – Team A   
Updated to match(es) played on unknown. Source: [citation needed]
a – Advance to a further round; b – ?; c – Champion; d – Disqualified; e – Eliminated; f – ?; g – Guest; h – Host; i – ?; j – ?; k – ?; l – ?; m – ?; n – ?; o – Play-off winner; p – Promoted; q – Qualified to the phase indicated; r – Relegated; s – ?; t – Qualified, but not yet to the particular phase indicated; u – ?; v – ?; w – ?; x – Custom 1; y – Custom 2; z – Custom 3

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 |status_pos=after or |status_pos=before respectively, the default value can differ and its use differs between sports or regions.

Notes

What you type
{{#invoke:Sports table|main|style=Custom

|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|result1=WC |result2=PO |result3=PO |result4=RPO |result5=rel

|note_AAA=Team note
|note_BBB=AAA |hth_BBB=Team 2 wins head-to-head against team 3
              |hth_CCC=BBB
|note_DDD=EEE

|name_AAA=Team A
|name_BBB=Team B
|name_CCC=Team C
|name_DDD=Team D
|name_EEE=Team E

|res_col_header=QR |note_header_res=Header note
|col_WC=green1 |text_WC=Qualification to [[World Cup]] |note_res_WC=Result note
|col_PO=blue1  |text_PO=Qualification to play-offs
|col_RPO=red2  |text_RPO=Qualification to relegation play-offs   |note_res_RPO=WC
|col_rel=red1  |text_rel=Relegation to lower division
}}
What it looks like
Pos Team 1 Qualification or relegation[a]
1 Team A[b]    Qualification to World Cup[c]
2 Team B[b]   [d] Qualification to play-offs
3 Team C   [d]
4 Team D[e]    Qualification to relegation play-offs[c]
5 Team E    Relegation to lower division
Updated to match(es) played on unknown. Source: [citation needed]
Notes:
  1. Header note
  2. 2.0 2.1 Team note
  3. 3.0 3.1 Result note
  4. 4.0 4.1 Team 2 wins head-to-head against team 3
  5. EEE

When notes are present, they are automatically added to the footer. The following notes are available for teams with |note_TTT= for a note for a team, when this note is a team code with a defined notes, they will share the note. Results can have notes with |note_res_RRR= and the result header can have a note with |note_header_res=. Head-to-head result tiebreakers are listed in the points column and can be inserted with |hth_TTT=, which can be shared between teams as with all-purpose notes.

Matches

What you type
{{#invoke:Sports table|main|style=Custom
|show_matches=true
|team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE

|name_AAA=Team A  |short_AAA=AAA
|name_BBB=Team B  |short_BBB=BBB
|name_CCC=Team C  |short_CCC=CCC
|name_DDD=Team D  |short_DDD=DDD
|name_EEE=Team E  |short_EEE=EEE

|match_AAA_BBB=1–0
|match_AAA_CCC=0–1
|match_AAA_DDD=<small>16 Nov '14</small>
|match_AAA_EEE=<small>3 Sep '15</small>

|match_BBB_AAA=
|match_BBB_CCC=<small>3 Sep '15</small>
|match_BBB_DDD=B–D
|match_BBB_EEE=<small>3 Sep '15</small>

|match_CCC_AAA=<small>16 Nov '14</small>
|match_CCC_BBB=C–B
|match_CCC_DDD=<small>16 Nov '14</small>
|match_CCC_EEE=C–E

|match_DDD_AAA=D–A
|match_DDD_BBB=<small>3 Sep '15</small>
|match_DDD_CCC=D–C
|match_DDD_EEE=<small>3 Sep '15</small>

|match_EEE_AAA=
|match_EEE_BBB=9–5
|match_EEE_CCC=<small>16 Nov '14</small>
|match_EEE_DDD=E–D |match_EEE_DDD_note=Pitch was taken by [[Martian|Martians]], the match will be played in [[Iani Chaos]] instead.
}}
What it looks like
Pos Team 1 AAA BBB CCC DDD EEE
1 Team A    1–0 0–1 16 Nov '14 3 Sep '15
2 Team B    3 Sep '15 B–D 3 Sep '15
3 Team C    16 Nov '14 C–B 16 Nov '14 C–E
4 Team D    D–A 3 Sep '15 D–C 3 Sep '15
5 Team E    9–5 16 Nov '14 E–D[a]
Updated to match(es) played on unknown. Source: [citation needed]
Notes:
  1. Pitch was taken by Martians, the match will be played in Iani Chaos instead.

The match list can be added by displayed by defining |show_matches=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 |match_TTT_SSS_note=TTT when |note_TTT= is set. The width of the match columns can be customized by setting |match_col_width= to the desired width.


-- Style for sports tables with custom columns
local pp = {}

function pp.get_col_styles(Args)
	-- Load relevant modules
	local yesno = require('Module:Yesno')

	local col_style = {}
	local num_cols = 1
	-- Default styles
	local default_style = Args['default_style'] or ''
	if default_style:match('^([Ww][Dd]?[Ll])') then
		-- Backwards compatibility with WDL
		if not yesno(Args['hide_played'] or 'no') then
			col_style[num_cols] = 'pld'
			num_cols = num_cols +1
		end
		if yesno(Args['show_win'] or 'yes') then
			col_style[num_cols] = 'w'
			num_cols = num_cols +1
		end
		local loss_first = yesno(Args['loss_before_draw'] or Args['loss_before_tie'] or false)
		if loss_first and yesno(Args['show_loss'] or 'yes') then
			col_style[num_cols] = 'l'
			num_cols = num_cols +1
		end
		if yesno(Args['show_draw'] or default_style:match('^[Ww]([Dd])[Ll]')~=nil) then
			col_style[num_cols] = 'd'
			num_cols = num_cols +1
		end
		if (not loss_first) and yesno(Args['show_loss'] or 'yes') then
			col_style[num_cols] = 'l'
			num_cols = num_cols +1
		end
		local fa_letter = string.lower(Args['for_against_style'] or '')
		if fa_letter ~= '' then
			if fa_letter=='game' or fa_letter=='games' then
				fa_letter = 'game'
			elseif fa_letter == 'none' then
				fa_letter = nil
			else
				fa_letter = fa_letter:match('^(%a).*')
			end
		else
			fa_letter = default_style:match('^[Ww][Dd]?[Ll](%a)fa')
					or default_style:match('^[Ww][Dd]?[Ll](%a)diff')
		end
		if fa_letter ~= nil then
			local fa_word_sing, fa_word_plur
			if fa_letter == 'game' then
				fa_letter = 'g'
				fa_word_sing = 'Game'
				fa_word_plur = 'Games'
			elseif fa_letter == 'f' then
				fa_word_sing = 'Frame'
				fa_word_plur = 'Frames'
			elseif fa_letter == 'm' then
				fa_word_sing = 'Match'
				fa_word_plur = 'Matches'
			elseif fa_letter == 'p' then
				fa_word_sing = 'Point'
				fa_word_plur = 'Points'
			elseif fa_letter == 'r' then
				fa_word_sing = 'Run'
				fa_word_plur = 'Runs'
			elseif fa_letter == 's' then
				fa_word_sing = 'Set'
				fa_word_plur = 'Sets'
			else
				fa_letter = 'g'
				fa_word_sing = 'Goal'
				fa_word_plur = 'Goals'
			end
			col_style[num_cols] = fa_letter..'f'
			col_style[num_cols+1] = fa_letter..'a'
			col_style[num_cols+2] = 'diff_'..fa_letter..'f_'..fa_letter..'a'
			fa_letter = string.upper(fa_letter)
			Args['col_header'..num_cols] = Args['col_header'..num_cols] or
					'<abbr title="'..fa_word_plur..' for">'..fa_letter..'F</abbr>'
			num_cols = num_cols + 1
			Args['col_header'..num_cols] = Args['col_header'..num_cols] or
					'<abbr title="'..fa_word_plur..' against">'..fa_letter..'A</abbr>'
			num_cols = num_cols + 1
			Args['col_header'..num_cols] = Args['col_header'..num_cols] or
					'<abbr title="'..fa_word_sing..' difference">'..fa_letter..'D</abbr>'
			num_cols = num_cols + 1
		end
		col_style[num_cols] = 'pts'
		col_style['ranking_col'] = num_cols
	end
	-- Number of columns and custom column styles
	num_cols = tonumber(Args['num_cols']) or num_cols
	for cc=1,num_cols do
		col_style[cc] = Args['colstyle'..cc] or col_style[cc] or ''
		col_style[cc] = string.lower(col_style[cc])
	end
	-- Store num_cols so it may be returned
	col_style['num_cols'] = num_cols
	return col_style
end

function pp.header(t,Args,p_sub,pos_label,group_col,VTE_text,full_table,results_header_txt)
	-- Load relevant modules
	local yesno = require('Module:Yesno')

	-- Create table header
	local sort_text = yesno(Args['sortable_table'] or 'no') and ' sortable' or ''
	table.insert(t,'{| class="wikitable'..sort_text..'" style="text-align:center;"\n')            			-- Open table
	-- Table title
	if Args['title'] or Args['table_header'] then
		table.insert(t,'|+ ' .. (Args['title'] or Args['table_header']) .. '\n')
	end
	-- Pre stuff
	local team_width = Args['teamwidth'] or '190'
	local col_style = pp.get_col_styles(Args)
	local num_cols = col_style['num_cols']
	local ranking_col = tonumber(Args['ranking_col']) or col_style['ranking_col'] or num_cols
	-- Custom header options
	local group_head_text = Args['group_header'] or '<abbr title="Group">Grp</abbr>'
	local team_head_text = Args['team_header'] or 'Team'

	-- Initialize
	local tt = {}
	tt.count = 0 		-- Up by one after every call
	tt.tab_text = t		-- Actual text
	-- Actual headers
	if pos_label ~= nil then
		tt = p_sub.colhead(tt,28,pos_label)									-- Position col
	end
	-- Add group header
	if full_table and group_col then
		tt = p_sub.colhead(tt,28,group_head_text)							-- Group col
	end
	tt = p_sub.colhead(tt,team_width,team_head_text..VTE_text)				-- Team col
	for cc=1,num_cols do
		local stylecc = col_style[cc]
		local col_width = 28
		local always_show = (ranking_col == cc)
		local head_text = '<abbr title="Column '..cc..'">'..cc..'</abbr>'	-- Column cc default
		-- Column style head text
		if stylecc == 'pld' or stylecc == 'played' or stylecc == 'match' or stylecc == 'matches' then
			head_text = Args['pld_header'] or '<abbr title="Played">Pld</abbr>'
			always_show = true
		elseif stylecc == 'w' or stylecc == 'win' or stylecc == 'wins' then
			head_text = '<abbr title="Won">W</abbr>'
		elseif stylecc == 'd' or stylecc == 'draw' or stylecc == 'draws' then
			head_text = Args['draw_header'] or (yesno(Args['use_tie'] or 'no') and '<abbr title="Tied">T</abbr>') or '<abbr title="Drawn">D</abbr>'
		elseif stylecc == 'l' or stylecc == 'loss' or stylecc == 'losses' then
			head_text = '<abbr title="Lost">L</abbr>'
		elseif stylecc == 'rw' then
			head_text = Args['rw_header'] or '<abbr title="Rounds won">RW</abbr>'
		elseif stylecc == 'pts' or stylecc == 'points' then
			head_text = '<abbr title="Points">Pts</abbr>'
			always_show = true
		elseif stylecc == 'pct' or stylecc == 'percentage' then
			head_text = '<abbr title="Win percentage">PCT</abbr>'
			always_show = true
		elseif stylecc == 'ppg' then
			head_text = '<abbr title="Points per game">PPG</abbr>'
			always_show = true
		elseif stylecc == 'ppga' then
			head_text = '<abbr title="Points per game">PPG</abbr>'
			always_show = true
			col_width = 36
		elseif stylecc ~= '' and stylecc:len() <= 3 then
			head_text = string.upper(stylecc)
		end
		if full_table or always_show then
			head_text = Args['col_header'..cc] or head_text
			tt = p_sub.colhead(tt,col_width,head_text)
		end
	end
	if full_table then
		tt.count = tt.count+1
		table.insert(tt.tab_text,results_header_txt)
	end

	return tt
end

function pp.row(frame,t,Args,p_sub,notes_exist,hth_id_list,full_table,rand_val,team_list,team_code_ii,ii_start,ii_end,ii_fw,bg_col,N_teams,ii,ii_show)
	-- Build the inner parts of individual rows
	
	-- Sub-module usage
	local mm = require('Module:Math')
	local yesno = require('Module:Yesno')
	
	-- Get custom/default options for in table
	local col_style = pp.get_col_styles(Args)
	local num_cols = col_style['num_cols']
	local default_style = Args['default_style'] or ''
	local ranking_col = tonumber(Args['ranking_col']) or col_style['ranking_col'] or num_cols
	local win_points = tonumber(Args['winpoints'])			or 3
	local draw_points = tonumber(Args['drawpoints'])		or 1
	local loss_points = tonumber(Args['losspoints'])		or 0
	local rw_points = tonumber(Args['rwpoints'])			or 1
	
	-- Get some input
	local wins = tonumber(Args['win_'..team_code_ii])		or 0
	local draws = tonumber(Args['draw_'..team_code_ii])		or 0
	local losses = tonumber(Args['loss_'..team_code_ii])	or 0
	local rw = tonumber(Args['rw_'..team_code_ii])			or 0
	local hth_local = yesno(Args['show_hth'] or 'yes') and Args['hth_'..team_code_ii] or nil
	-- Then calculate some values
	local matches = wins + draws + losses
	local matches_text = matches
	if tonumber(Args['win_'..team_code_ii]) == nil or tonumber(Args['draw_'..team_code_ii]) == nil or tonumber(Args['loss_'..team_code_ii]) == nil then
		matches = tonumber(Args['matches_'..team_code_ii]) or matches
		matches_text = Args['matches_'..team_code_ii] or matches
	end
	local s_pts = (tonumber(Args['adjust_points_'..team_code_ii]) or 0) + (tonumber(Args['startpoints_'..team_code_ii]) or 0)
	local points = win_points*wins + draw_points*draws + loss_points*losses + rw_points*rw + s_pts
	local pct = '' 
	if matches == 0 then 
		-- Escape for zero matches
		pct = '&mdash;'
	else
		pct = mm._precision_format(wins / matches, 3)
	end
	local ppg = ''
	if matches == 0 then 
		-- Escape for zero matches
		ppg = '&mdash;'
	else
		ppg = mm._precision_format(points / matches, 2)
	end
	-- Use actual values if wins, draws, and losses are not numeric
	if (wins == 0 and draws == 0 and losses == 0) then
		local function numorval(s)
			return s and ((s == '' and 0) or tonumber(s) or s) or 0
		end
		wins = numorval(Args['win_'..team_code_ii])
		draws = numorval(Args['draw_'..team_code_ii])
		losses = numorval(Args['loss_'..team_code_ii])
	end
	local ppga = ''
	if matches == 0 then 
		-- Escape for zero matches
		ppga = '&mdash;'
	else
		ppga = mm._precision_format(points / matches, 3)
	end

	-- Some local vars	
	local hth_string
	local tt_return = p_sub.hth(frame,Args,full_table,hth_id_list,hth_local,notes_exist,team_list,team_code_ii,ii_start,ii_end,rand_val)
	hth_string = tt_return.str
	hth_id_list = tt_return.list
	notes_exist = tt_return.notes_exist

	-- Row building
	for cc=1,num_cols do
		local stylecc = col_style[cc]
		local col_fw = ii_fw
		local always_show = (ranking_col == cc)
		local cell_data = Args['default_value'..cc] or '&nbsp;&nbsp;'
		-- Get data by column style
		if stylecc == 'pld' or stylecc == 'played' or stylecc == 'match' or stylecc == 'matches' then
			cell_data = matches_text
			always_show = true
		elseif stylecc == 'w' or stylecc == 'win' or stylecc == 'wins' then
			cell_data = wins
		elseif stylecc == 'd' or stylecc == 'draw' or stylecc == 'draws' then
			cell_data = draws
		elseif stylecc == 'l' or stylecc == 'loss' or stylecc == 'losses' then
			cell_data = losses
		elseif stylecc == 'rw' then
			cell_data = rw
		elseif stylecc == 'pts' or stylecc == 'points' then
			if points<0 then
				cell_data = '&minus;'..-points
			else
				cell_data = points
			end
			always_show = true
		elseif stylecc == 'pct' or stylecc == 'percentage' then
			cell_data = pct
			always_show = true
		elseif stylecc == 'ppg' then
			cell_data = ppg
			always_show = true
		elseif stylecc == 'ppga' then
			cell_data = ppga
			always_show = true
		elseif default_style:match('^([Ww][Ll])')
			and (stylecc == 'perc' or stylecc == 'percentage' or stylecc == '%') then
				if matches == 0 then
					cell_data = '&mdash;'
				else
					cell_data = mm._precision_format(wins / matches, 3)
					if losses > 0 then
						-- Drop the leading zero (from the string)
						cell_data = string.sub(cell_data,2,string.len(cell_data))
					end
				end
		elseif stylecc:match('^(sum_[^_]*_[^_]*)')
			or stylecc:match('^(diff_[^_]*_[^_]*)')
			or stylecc:match('^(ratio_[^_]*_[^_]*)') then
			local op_str = stylecc:match('^([^_]*)_[^_]*_[^_]*')
			local operands = {}
			operands[1] = stylecc:match(op_str..'_([^_]*)_[^_]*')
			operands[2] = stylecc:match(op_str..'_[^_]*_([^_]*)')
			local flag_format = false
			for opn=1,2 do
				local opstyle = operands[opn]
				if opstyle == 'pld' or opstyle == 'played' or opstyle == 'match' or opstyle == 'matches' then
					operands[opn] = matches
				elseif opstyle == 'w' or opstyle == 'win' or opstyle == 'wins' then
					operands[opn] = wins
				elseif opstyle == 'd' or opstyle == 'draw' or opstyle == 'draws' then
					operands[opn] = draws
				elseif opstyle == 'l' or opstyle == 'loss' or opstyle == 'losses' then
					operands[opn] = losses
				elseif opstyle == 'rw' then
					operands[opn] = rw
				elseif opstyle == 'pts' or opstyle == 'points' then
					operands[opn] = points
				elseif opstyle == 'pct' or opstyle == 'percentage' then
					operands[opn] = pct
				elseif opstyle == 'ppg' then
					operands[opn] = points / matches
					flag_format = true
				elseif opstyle == 'ppga' then
					operands[opn] = points / matches
					flag_format = true
				else
					operands[opn] = tonumber(Args[opstyle..'_'..team_code_ii]) or 0
				end
			end
			if op_str == 'sum' then
				cell_data = operands[1] + operands[2]
			elseif op_str == 'ratio' then
				if operands[2] == 0 then
					cell_data = operands[1] == 0 and '&mdash;' or 'MAX'
				else
					cell_data = mm._precision_format(operands[1] / operands[2], 3)
				end
			else
				cell_data = operands[1] - operands[2]
				if not flag_format then
					if cell_data < 0 then
						cell_data = '&minus;'..-cell_data
					elseif cell_data > 0 and yesno(Args['plus_sign_diffs']) then
						cell_data = '&plus;'..cell_data
					end
				end
			end
			if flag_format then
				cell_data = mm._precision_format(cell_data, 2)
			end
		elseif stylecc ~= '' then
			cell_data = Args[stylecc..'_'..team_code_ii] or cell_data
		end
		cell_data = Args['col'..cc..'_'..team_code_ii] or cell_data
		if full_table or always_show then
			local align_col = Args['aligncol'..cc] or ''
			if ranking_col == cc then
				col_fw = 'font-weight: bold;'
				cell_data = cell_data .. hth_string
			elseif yesno(Args['bold_col'..cc]) then
				col_fw = 'font-weight: bold;'
			end
			-- sanitize the align_col input
			if align_col == 'l' or align_col == 'left' then
				align_col = 'text-align: left; '
			elseif align_col == 'r' or align_col == 'right' then
				align_col = 'text-align: right; '
			elseif align_col == 'c' or align_col == 'center' then
				align_col = 'text-align: center; '
			elseif align_col == 'justify' or align_col == 'initial' or align_col == 'inherit' then
				align_col = 'text-align: '..align_col..'; '
			else
				align_col = ''
			end
			table.insert(t,'| style="'..align_col..col_fw..bg_col..'" |'..cell_data..'\n')
		end
	end
	return {t=t, notes_exist=notes_exist, hth_id_list=hth_id_list}
end

function pp.status(Args)
	-- Declare status options
	-- ------------------------------------------------------------
	-- NOTE: If you add to status_code, also add to status_called and status_letters!!
	-- Or functionality will be compromised
	-- ------------------------------------------------------------
	local status_code, status_called = {}, {}
	status_code = {	A='Advance to a further round', C='Champion', D='Disqualified', 
		E='Eliminated', G='Guest', H='Host', O='Play-off winner', P='Promoted', Q='Qualified to the phase indicated',
		R='Relegated', T='Qualified, but not yet to the particular phase indicated'}
	local status_letters = (Args['status_order'] or '') .. 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
	
	-- Status position (before or after read and default)
	local stat_pos_val = string.lower(Args['status_pos'] or '')
	local status_position = 'after' 	-- Default location
	if stat_pos_val=='before' then
		status_position = 'before'
	elseif stat_pos_val=='after' then
		status_position = 'after'
	end
	-- Read in custom status options
	for l in mw.text.gsplit(status_letters, '') do
		status_called[l] = false
		status_code[l] = status_code[l] or '?'
		status_letters = mw.ustring.gsub(status_letters, '(' .. l ..'.-)' .. l, '%1')

		if Args['status_text_' .. l] then
			status_code[l] = Args['status_text_' .. l]
		end
	 end
	
	return {code=status_code, called=status_called, letters=status_letters, position=status_position}
end

return pp