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.
Usage
Basic usage
In it's simplest form only several parameters need to be used to build a table
The main command is the {{#invoke:Sports table|main|style=WL}} 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 #Dating to see how to change the update date.
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
Hiding played column
Setting |hide_played=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 |ranking_style=wins or |ranking_style=percentage respectively)
Games behind can be added to the table as well by setting |show_GB=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 |GB_team=N.
Header options (goals/points for/against and custom other headers)
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. |for_against_style=none removes these columns completely. For sports with frames for and against rather than goals or points, setting |for_against_style=frames switches the for, against and difference columns to using points instead. |for_against_style=none removes these columns completely.
The wording of the Grp (group) column can be adjusted using |group_header=, for example |group_header=<abbr title="League">Lge</abbr>.
Using |use_goal_ratio=yes use goal ratio (goal average) instead of goal differential.
Module:Sports table/doc/doc
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=WL
|showteam = {{{showteam|}}} <!-- For template use when passing forward what team shall be highlighted -->
|template_name = <!--If used as template add template name here (without template: first) -->
|update = future <!-- When tournament started update the update-parameter with date of latest update and remove start_date-->
|start_date = Unknown <!-- On form 24 April 2165. When tournament started remove start_date-->
|source = Unknown <!-- Add source for table here with single bracket [webadress info] -->
<!--Update team qualifications here (defined below)-->
|result1=PRO |result2=CLG |result3=KO |result4=CLPO |result5=ELPO |result8=ELG |result11=RPO |result12=REL
<!--Update team results here and then (if needed) positions above. Dont forget to update the date above (update parameter)-->
|win_AAA=0 |loss_AAA=0 |gf_AAA=0 |ga_AAA=0 |status_AAA=CQ <!-- Team A -->
|win_BBB=0 |loss_BBB=0 |gf_BBB=0 |ga_BBB=0 |status_BBB=C <!-- Team B -->
|win_CCC=0 |loss_CCC=0 |gf_CCC=0 |ga_CCC=0 |status_CCC=A <!-- Team C -->
|win_DDD=0 |loss_DDD=0 |gf_DDD=0 |ga_DDD=0 |status_DDD=T <!-- Team D -->
|win_EEE=0 |loss_EEE=0 |gf_EEE=0 |ga_EEE=0 |status_EEE= <!-- Team E -->
|win_FFF=0 |loss_FFF=0 |gf_FFF=0 |ga_FFF=0 |status_FFF= <!-- Team F -->
|win_GGG=0 |loss_GGG=0 |gf_GGG=0 |ga_GGG=0 |status_GGG= <!-- Team G -->
|win_HHH=0 |loss_HHH=0 |gf_HHH=0 |ga_HHH=0 |status_HHH= <!-- Team H -->
|win_III=0 |loss_III=0 |gf_III=0 |ga_III=0 |status_III= <!-- Team I -->
|win_JJJ=0 |loss_JJJ=0 |gf_JJJ=0 |ga_JJJ=0 |status_JJJ= <!-- Team J -->
|win_KKK=0 |loss_KKK=0 |gf_KKK=0 |ga_KKK=0 |status_KKK= <!-- Team K -->
|win_LLL=0 |loss_LLL=0 |gf_LLL=0 |ga_LLL=0 |status_LLL=R <!-- Team L -->
<!--Team definitions (wikilinks in table)-->
|name_AAA = <!-- Add wikilink for Team A here -->
|name_BBB = <!-- Add wikilink for Team B here -->
|name_CCC = <!-- Add wikilink for Team C here -->
|name_DDD = <!-- Add wikilink for Team D here -->
|name_EEE = <!-- Add wikilink for Team E here -->
|name_FFF = <!-- Add wikilink for Team F here -->
|name_GGG = <!-- Add wikilink for Team G here -->
|name_HHH = <!-- Add wikilink for Team H here -->
|name_III = <!-- Add wikilink for Team I here -->
|name_JJJ = <!-- Add wikilink for Team J here -->
|name_KKK = <!-- Add wikilink for Team K here -->
|name_LLL = <!-- Add wikilink for Team L here -->
<!--Table settings and rules-->
|show_limit = <!-- For league tables and other big tables use showlimit = 5 (standard per consensus to only show five teams on individual articles) -->
|class_rules = 1) Points; 2) Goal difference; 3) Number of goals scored; <!-- Add the classification rules here -->
<!--Qualification and relegation column definitions, use green for top tournament, then blue followed by yellow, red is elimination. Different levels of same competitions should have different shades in color like green1, green2 and so on.-->
|res_col_header = PQR <!-- All of these may not be needed, Promotion (P), Qualification (Q) and Relegation (R) -->
|col_PRO = green1 |text_PRO = Promotion to <!-- Wikilink to higher level, pipe year and association -->
|col_KO = green1 |text_KO = Advance to <!-- Wikilink to next stage for example knockout stage (KO) -->
|col_CLG = green1 |text_CLG = Qualification to <!-- Wikilink to tournament stage, pipe year and association -->
|col_CLPO= green2 |text_CLPO= Qualification to <!-- Wikilink to tournament stage, pipe year and association -->
|col_ELG = blue1 |text_ELG = Qualification to <!-- Wikilink to tournament stage, pipe year and association -->
|col_ELPO= blue2 |text_ELPO= Qualification to <!-- Wikilink to tournament stage, pipe year and association -->
|col_RPO = red2 |text_RPO = Qualification to <!-- Wikilink to relegation playoff, pipe to Relegation playoffs -->
|col_REL = red1 |text_REL = Relegation to <!-- Wikilink to lower level, pipe year and association -->
}}
