| File:Green check.svg | This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
This style for Lua-based Module:Sports table is meant to build group and league tables for competitions with a win-draw-loss format. Note that this module is used extensively, so test potential changes rigorously in the sandbox and please ensure consensus exists before implementing major changes. The rest of this documentation explains how to use this module with the WDL style in an article or template, check the table of contents for specific items.
Usage[]
Basic usage[]
In it's simplest form only several parameters need to be used to build a table
In article[]
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
The main command is the {{#invoke:Sports table|main|style=WDL}} statement which basically calls the module and enables you to set everything up. Then 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, goals for and goals against by using |win_TTT=, |draw_TTT=, |loss_TTT=, |gf_TTT= and |ga_TTT= respectively (with TTT replaced by the team code). If you do not define these numbers, it is automatically assumed to be 0. 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.
In template[]
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
The markup is effectively the same, you only add two lines. The line |showteam={{{showteam}}}, is needed to forward the showteam parameter from a template call (see #Team highlighting and partial table); the |only_pld_pts={{{only_pld_pts}}} is needed to forward truncated tables, (see #Appearance); the |show_matches={{{show_matches}}} is needed to forward match result visibility, see #Matches. The |template_name= with the actual name of the Template-page, creates the V, T and E buttons that link to the template page (so you can easily reach it from any article it is included in).
Customization[]
Several things can be customized in these tables
Points[]
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
As a default a win is worth 3 points, a draw 1 point and a loss 0 points, these values can be overwritten to what you need by |winpoints=, |drawpoints= and |losspoints=. Teams can also start the season with bonus or penalty points, this can be included by using |adjust_points_TTT= for that specific team.
Header options (points for/against and custom other headers)[]
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
For sports with points for and against rather than goals, setting |for_against_style=points switches the for, against and difference columns to using points instead. The wording of the D (draw) column can be adjusted using |draw_header= and the wording of the Team column can be adjusted using |team_header=.
Order of losses and draws[]
| What you type | {{#invoke:Sports table|main|style=WDL|loss_before_draw=true
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
As a default losses are listed before draws. To list losses first, use |loss_before_draw=true.
Goal ratio/goal average[]
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
Using |use_goal_ratio=yes use goal ratio (goal average) instead of goal differential.
Goal percentage[]
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
Using |use_goal_percentage=yes use goal percentage instead of goal differential.
[]
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
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=WDL
| ||||||||||
| What it looks like |
Updated to match(es) played on 1 January 1900. Source: Script error: No such module "Unsubst".
|
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=WDL
| ||||||||||
| What it looks like |
Source: Script error: No such module "Unsubst".
|
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=WDL
| ||||||||||
| What it looks like |
First match(es) will be played on 1 January 2121. Source: Script error: No such module "Unsubst".
|
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 |status_footer=. By setting |status_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 status_footer
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
(D) Disqualified; (E) Eliminated; (O) Play-off winner; (P) Promoted; (R) Relegated; (T) Qualified, but not yet to the particular phase indicated. |
- With status_footer
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||
| What it looks like |
Updated to match(es) played on unknown.
Source: Script error: No such module "Unsubst". (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=WDL
| ||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
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.
Team highlighting and partial table[]
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
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=WDL
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
|
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:
Indicating status[]
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
(A) Advances 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; (X) ?; (Y) ?; (Z) ?. |
| What you type | {{#invoke:Sports table|main|style=WDL
| ||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
a – Advances 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; x – ?; y – ?; z – ?. |
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 it's use differs between sports or regions.
Notes[]
| What you type | {{#invoke:Sports table|main|style=WDL
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst".
Notes: |
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=WDL
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
Updated to match(es) played on unknown. Source: Script error: No such module "Unsubst". Notes:
|
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.
Example usage[]
The module parameters can be arranged in different orders depending on the editor and article but below is an example use that can be copied when creating a module table.
| What you type | {{#invoke:Sports table|main|style=WDL
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| What it looks like |
First match(es) will be played on Unknown. Source: Unknown
Rules for classification: 1) Points; 2) Goal difference; 3) Number of goals scored; (A) Advances to a further round; (C) Champion; (Q) Qualified to the phase indicated; (R) Relegated; (T) Qualified, but not yet to the particular phase indicated. |
-- Style for football tables
local pp = {}
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
-- Pre stuff
local team_width = Args['teamwidth'] or '190'
local sort_text = ''
local sort_table_val = Args['sortable_table'] or 'no'
if yesno(sort_table_val) then sort_text = 'sortable' end
table.insert(t,'{|class="wikitable '..sort_text..'" style="text-align:center;"\n') -- Open table
-- Custom header options
local draw_head_text = Args['draw_header'] or '<abbr title="Drawn">D</abbr>'
local team_head_text = Args['team_header'] or 'Team'
local loss_first = Args['loss_before_draw'] or false
-- Use points instead of goals for/against
local for_against_style = Args['for_against_style'] or 'goals'
local fa_letter, fa_word_sing, fa_word_plur
-- First convert to lower case if it is a string
for_against_style = string.lower(for_against_style)
if for_against_style=='g' or for_against_style=='goal' or for_against_style=='goals' then
fa_letter = 'G'
fa_word_sing = 'Goal'
fa_word_plur = 'Goals'
elseif for_against_style=='p' or for_against_style=='point' or for_against_style=='points' then
fa_letter = 'P'
fa_word_sing = 'Point'
fa_word_plur = 'Points'
else
fa_letter = 'G'
fa_word_sing = 'Goal'
fa_word_plur = 'Goals'
end
-- Whether to use goal ratio (goal average) instead
local use_ratio_val = Args['use_goal_ratio'] or 'no'
local do_ratio = false
-- True if exist, false otherwise
if yesno(use_ratio_val) then do_ratio = true end
-- Whether to use goal percentage instead
local use_percentage_val = Args['use_goal_percentage'] or 'no'
local do_percentage = false
-- True if exist, false otherwise
if yesno(use_percentage_val) then do_percentage = true end
-- Initialize
local tt = {}
tt.count = 0 -- Up by one after every call
tt.tab_text = t -- Actual text
-- Actual headers
tt = p_sub.colhead(tt,28,pos_label) -- Position col
-- Add group header
if full_table and group_col then
tt = p_sub.colhead(tt,28,'<abbr title="Group">Grp</abbr>') -- Group col
end
tt = p_sub.colhead(tt,team_width,team_head_text..VTE_text) -- Team col
tt = p_sub.colhead(tt,28,'<abbr title="Played">Pld</abbr>') -- Matches played col
if full_table then
tt = p_sub.colhead(tt,28,'<abbr title="Won">W</abbr>') -- Win col
if loss_first then
tt = p_sub.colhead(tt,28,'<abbr title="Lost">L</abbr>') -- Loss col
tt = p_sub.colhead(tt,28,draw_head_text) -- Draw col
else
tt = p_sub.colhead(tt,28,draw_head_text) -- Draw col
tt = p_sub.colhead(tt,28,'<abbr title="Lost">L</abbr>') -- Loss col
end
tt = p_sub.colhead(tt,28,'<abbr title="'..fa_word_plur..' for">'..fa_letter..'F</abbr>') -- For col
tt = p_sub.colhead(tt,28,'<abbr title="'..fa_word_plur..' against">'..fa_letter..'A</abbr>') -- Against col
if do_ratio then
tt = p_sub.colhead(tt,28,'<abbr title="'..fa_word_sing..' ratio">'..fa_letter..'R</abbr>') -- Ratio col
elseif do_percentage then
tt = p_sub.colhead(tt,28,'<abbr title="'..fa_word_sing..' percentage">%</abbr>') -- Percentage col
else
tt = p_sub.colhead(tt,28,'<abbr title="'..fa_word_sing..' difference">'..fa_letter..'D</abbr>') -- Difference col
end
end
tt = p_sub.colhead(tt,28,'<abbr title="Points">Pts</abbr>') -- Points col
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 win_points = tonumber(Args['winpoints']) or 3
local draw_points = tonumber(Args['drawpoints']) or 1
local loss_points = tonumber(Args['losspoints']) or 0
-- Order of draws and losses --
local loss_first = Args['loss_before_draw'] or false
-- 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 gfor = tonumber(Args['gf_'..team_code_ii]) or tonumber(Args['pf_'..team_code_ii]) or 0
local gaig = tonumber(Args['ga_'..team_code_ii]) or tonumber(Args['pa_'..team_code_ii]) or 0
local s_pts = tonumber(Args['adjust_points_'..team_code_ii]) or tonumber(Args['startpoints_'..team_code_ii]) or 0
local hth_local = Args['hth_'..team_code_ii] or nil
-- Then calculate some values
local matches = wins + draws + losses
local points = win_points*wins + draw_points*draws + loss_points*losses + s_pts
-- Comparison of for against
local gcomp
-- Whether to use goal ratio (goal average) or goal percentage instead
local use_ratio_val = Args['use_goal_ratio'] or 'no'
local use_percentage_val = Args['use_goal_percentage'] or 'no'
local skip_sign
if yesno(use_ratio_val) then
-- Now it is the goal ratio/goal average
if gaig == 0 then
gcomp = '—'
else
gcomp = mm._precision_format(gfor / gaig, 3)
end
elseif yesno(use_percentage_val) then
-- Now it is the percentage
if gaig == 0 then
gcomp = '—'
else
gcomp = mm._precision_format(100 * gfor / gaig , 1)
end
else
-- It's goal difference
gcomp = gfor - gaig
-- Formatting with signs
if gcomp>0 then
gcomp='+'..gcomp
elseif gcomp < 0 then
gcomp='−'..-gcomp
end
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
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..matches..'\n') -- Played
if full_table then
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..wins..'\n') -- Won
if loss_first then
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..losses..'\n') -- Lost
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..draws..'\n') -- Drawn
else
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..draws..'\n') -- Drawn
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..losses..'\n') -- Lost
end
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..gfor..'\n') -- GF
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..gaig..'\n') -- GA
table.insert(t,'| style="'..ii_fw..bg_col..'" |'..gcomp..'\n') -- Goal comparison
end
-- Add − for negative point totals
table.insert(t,'| style="font-weight: bold;'..bg_col..'" | ')
if points<0 then
table.insert(t,'−'..-points..hth_string)
else
table.insert(t,points..hth_string)
end
table.insert(t,'\n')
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='Advances 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',
X='?', Y='?', Z='?'}
status_called = { A=false, C=false, D=false, E=false, G=false, H=false, O=false, P=false,
Q=false, R=false, T=false, X=false, Y=false, Z=false}
local status_letters = 'ACDEGHOPQRTXYZ'
-- Status position (before or after read and default)
local stat_pos_val = Args['status_pos'] or ''
local status_position = 'after' -- Default location
stat_pos_val = string.lower(stat_pos_val)
if stat_pos_val=='before' then
status_position = 'before'
elseif stat_pos_val=='after' then
status_position = 'after'
end
-- Read in custom status options
if Args['status_text_X'] then status_code.X = Args['status_text_X'] end
if Args['status_text_Y'] then status_code.Y = Args['status_text_Y'] end
if Args['status_text_Z'] then status_code.Z = Args['status_text_Z'] end
return {code=status_code, called=status_called, letters=status_letters, position=status_position}
end
return pp