Module:Sports table/College/doc

This style for Lua-based Module:Sports table is meant to build group and league tables for competitions with a win-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 WL style in an article or template, check the table of contents for specific items.

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

In article
The main command is the 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, losses, goals for and goals against by using win_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 to see how to change the update date.

In template
The markup is effectively the same. The value for showteam, is automatically forwarded from the template call (see ); the only_pld_pts is automatically forward truncated tables, (see ); the show_matches is automatically forwarded for match result visibility, see.

Customization
Several things can be customized in these tables

Hiding played column
Setting yes hides the played column.

Points, wins or percentage
By default teams are ranked by points, which can be adjusted as follows: As a default a win is worth 2 points and a loss 1 point, these values can be overwritten to what you need by winpoints 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.

Alternatively teams can also be ranked by wins (set wins or percentage respectively)

Games behind
Games behind can be added to the table as well by setting yes, per default this will be with respect to the first-placed team. To have the GB with respect to a the team ranked N, set N.

Header options (goals/points for/against and custom other headers)
For sports with points for and against rather than goals, setting points switches the for, against and difference columns to using points instead. none removes these columns completely. For sports with frames for and against rather than goals or points, setting frames switches the for, against and difference columns to using points instead. none removes these columns completely.

The wording of the Grp (group) column can be adjusted using group_header, for example Lge.

Goal ratio/goal average
Using yes use goal ratio (goal average) instead of goal differential.

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.