Module:Sports table/Custom/doc

Template:Module rating 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	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

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 Template:Para 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 Template:Para and Template:Para 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 Template:Para, Template:Para, 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 Template:Para, Template:Para, Template:Para and Template:Para 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 Template:Para. 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 Template:Para 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	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

The Template:Para 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 Template:Para. 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	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

Note that in this table, even though Template:Para 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 Template:Para 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 Template:Para plus Template:Para plus Template:Para, each of whose default values are 0. The column header is Pld, but may be changed using Template:Para.

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 Template:Para 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 Template:Para or 0 if no such value is given. The column header is D. For backwards compatibility with the WDL style, if Template:Para is set to yes, then the header is T, and in either case, the header may be changed using Template:Para

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 Template:Para 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 Template:Para or 0 if no such value is given. The column header is RW, but may be changed using Template:Para.

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 Template:Para, Template:Para, Template:Para and Template:Para. 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 Template:Para, 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.

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 Template:Para determines whether a plus sign is shown on differences that are positive. By default this value is set to Template:Para.

other

Any other column style will not set a default value, and so the default cell value set by Template:Para 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 Template:Para in addition to the usual Template:Para. 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 Template:Para parameter.

What you type	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

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

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	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

You can set all entries of column number N to be bolded by using Template:Para. 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	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

You can choose the text alignment of column number N by using Template:Para. Note that the column header is always centered.

Header options

What you type	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

The wording of the Team column can be adjusted using Template:Para. Similarly, the wording of any given custom column number N can be adjusted by Template:Para 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 Template:Para, see below for details. If no source is given a citation-needed tag is shown, Template:Para can provide an actual link. The classification results can be shown with Template:Para, either directly or as a wikilink to a tie-breaker rules section. Using Template:Para 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 Template:Para for any other term.

Active season

What you type	{{#invoke:Sports table|main|style=Custom |update=1 January 1900 }}
What it looks like

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 Template:Para.

Completed season

What you type	{{#invoke:Sports table|main|style=Custom |update=complete }}
What it looks like

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

Future season

What you type	{{#invoke:Sports table|main|style=Custom |update=future |start_date=1 January 2121 }}
What it looks like

Before any games are played, the date of the first game should be indicated by using Template:Para and setting the start date by Template:Para.

Stacking

Using Template:Para makes the table smaller, which may lead to undesired width and linebreaks in the footer that can be fixed with parameter Template:Para. By setting Template:Para (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

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

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

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

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

Only the position, team, matches and points columns can be displayed by defining Template:Para (or y, t, true or 1 or upper case variant of those); Template:Para 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 Template:Para 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 Template:Para, 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 Template:Para and the position labels by Template:Para for each team.

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

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

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 Template:Para. A limited part of the table is shown by Template:Para, 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 Template:Para 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

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 Template:Para 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 Template:Para 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 Template:Para. 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 Template:Para, 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:

• Football colour 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

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

The promotion/qualification/relegation status of a team can be indicated by Template:Para 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 Template:Para to indicate a non-standard status.

Most styles allow for these letter to be placed after the team name or before, set Template:Para or Template:Para 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

When notes are present, they are automatically added to the footer. The following notes are available for teams with Template:Para 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 Template:Para and the result header can have a note with Template:Para. Head-to-head result tiebreakers are listed in the points column and can be inserted with Template:Para, 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

The match list can be added by displayed by defining Template:Para (or y, t, true or 1 or upper case variant of those). The column headers for the match results are defined by Template:Para for team TTT. The results for the game TTT vs. SSS can now be input by Template:Para. 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 Template:Para, this note can be shared with team TTT note by setting Template:Para when Template:Para is set. The width of the match columns can be customized by setting Template:Para to the desired width.

Template:When pagename is