Module:Sports table/doc

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:Sports table|main|style=football |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

The main command is the {{#invoke:Sports table|main|style=football}} 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=football |showteam={{{showteam}}} |only_pld_pts={{{only_pld_pts}}} |show_matches={{{show_matches}}} |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

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=football |team1=FDT |team2=BBB |team3=CCC |team4=DDD |team5=EEE |win_FDT=5 |loss_FDT=0 |gf_FDT=10 |ga_FDT=0 |adjust_points_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 |adjust_points_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

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.