Module:Sports table/doc
This is the documentation page for Module:Sports table
This Lua-based module is meant to build group and league tables for football and possibly other sports as well. 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 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:Football table|main
|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6
|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_EEE={{fb|GIB}}
}}
|
| What it looks like | Script error: No such module "Football table". |
The main command is the {{#invoke:Football table|main}} 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.
In template
| What you type | {{#invoke:Football table|main
|showteam={{{showteam}}}
|template_name=Example
|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6
|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_EEE={{fb|GIB}}
}}
|
| What it looks like | Script error: No such module "Football table". |
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 |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:Football table|main
|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0 |startpoints_FDT=1.5
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6 |startpoints_EEE=-1.5
|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_EEE={{fb|GIB}}
|winpoints=2
|drawpoints=1
|losspoints=-0.1
}}
|
| What it looks like | Script error: No such module "Football table". |
As a default a win is worth 3 points, a draw 2 points 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 |startpoints_TTT= for that specific team.
Footer options
| What you type | {{#invoke:Football table|main
|update=complete
}}
|
| What it looks like | Script error: No such module "Football table". |
| What you type | {{#invoke:Football table|main
|update=1 January 1900
|source=[https://en.wikipedia.org/wiki/Main_Page Wikipedia]
|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6
|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_EEE={{fb|GIB}}
|class_rules=1) points; 2) goal difference; 3) number of goals scored.
}}
|
| What it looks like | Script error: No such module "Football table". |
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=, when this is |update=complete it is not shown (this option can be used after all the matches are played). 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.
Appearance
| What you type | {{#invoke:Football table|main
|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6
|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_EEE={{fb|GIB}}
|only_pld_pts=yes
}}
|
| What it looks like | Script error: No such module "Football table". |
| What you type | {{#invoke:Football table|main
|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2 |pos_BBB=2nd
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3 |pos_CCC==
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4 |pos_DDD=DQ
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6 |pos_EEE=
|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_EEE={{fb|GIB}}
|split2=yes
|split3=
|split5=1
|teamwidth=250
|postitle={{abbr|Exam.|Example}}
}}
|
| What it looks like | Script error: No such module "Football table". |
Only the position, team, games and points columns can be displayed by defining |only_pld_pts=. 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.
Team highlighting and partial table
| What you type | {{#invoke:Football table|main
|showteam=DDD
|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6
|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_EEE={{fb|GIB}}
|show_limit=3
}}
|
| What it looks like | Script error: No such module "Football table". |
When using a table on a team (season) page, you might want to highlight the team (and possibly only show part of the table), especially after a template call to a long league table. Team TTT is highlighted by |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).
Results and status
Indicating results
| What you type | {{#invoke:Football table|main
|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|result1=WC |result2=PO |result4=RPO |result5=rel
|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0
|win_BBB=3 |draw_BBB=1 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6
|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_EEE={{fb|GIB}}
|res_col_header=QR
|col_WC=green1 |text_WC=[[1974 FIFA World Cup]]
|col_PO=blue1 |text_PO=Play-offs
|col_RPO=red2 |text_RPO=Relegation play-offs
|col_rel=red1 |text_rel=Relegation
}}
|
| What it looks like | Script error: No such module "Football table". |
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, champions league, 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 (e.g. pre-1999 European football with European Cup [green], Cup Winners Cup [blue], UEFA Cup [yellow]). 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.
Indicating status
| What you type | {{#invoke:Football table|main
|team1=AAA
|result1=RRR
|win_AAA=3 |draw_AAA=2 |loss_AAA=1 |gf_AAA=20 |ga_AAA=1 |status_AAA=ACDEHOPQRT
|name_AAA=Team 1
|res_col_header=PQR
|col_RRR= |text_RRR=Plain text
}}
|
| What it looks like | Script error: No such module "Football table". |
The promotion/qualification/relegation status of a team can be indicated by |status_TTT= with the letters indicated above. 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 games 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)
Notes
| What you type | {{#invoke:Football table|main
|team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE
|result1=WC |result2=PO |result3=PO |result4=RPO |result5=rel
|win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0 |note_FDT=Team note
|win_BBB=3 |draw_BBB=0 |loss_BBB=1 |gf_BBB= 3 |ga_BBB=2 |note_BBB=FDT |hth_BBB=Team 2 wins head-to-head against team 3
|win_CCC=3 |loss_CCC=2 |gf_CCC= 3 |ga_CCC=3 |hth_CCC=BBB
|win_DDD=1 |draw_DDD=1 |loss_DDD=3 |gf_DDD= 1 |ga_DDD=4 |note_DDD=EEE
|win_EEE=0 |loss_EEE=5 |gf_EEE= 0 |ga_EEE=6
|name_FDT=[[FIFA World Cup Dream Team]]
|name_BBB=Team 2
|name_CCC=Team 3
|name_EEE={{fb|GIB}}
|res_col_header=QR |note_header_res=Header note
|col_WC=green1 |text_WC=[[1974 FIFA World Cup]] |note_res_WC=Result note
|col_PO=blue1 |text_PO=Play-offs
|col_RPO=red2 |text_RPO=Relegation play-offs
|col_rel=red1 |text_rel=Relegation
}}
|
| What it looks like | Script error: No such module "Football table". |
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.