Module:Sports table/doc
This is the documentation page for Module:Sports table
 | This Lua module is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
 | This module depends on the following other modules: |
This Lua-based module is meant to build group and league tables for 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 the set-up of the module. Refer to individual style pages for detailed usage instructution
Usage
The basic command is {{#invoke:Sports table|main|style=XXX}}
Style
The XXX in style=XXX is to be replaced by one of the following available styles:
General styles
- WDL – For tables with a win-draw-loss system
- WL – For tables with a win-loss system
- WL PK – For tables with a win-loss system that gives different weights to wins and losses from a penalty kick shootout
- WL OT – For tables with a win-loss system that gives different weights to overtime wins
- WL OTL tiebreak – For tables with a win-loss-OT loss system and a separate tiebreak column
- WL goal points – For tables with a win-loss system that gives additional points for goals
- WDLHA – For tables with separate home and away win-draw-loss accounting
- WLHA – For tables with separate home and away win-loss accounting
- WDL OT – For tables with a win-loss system which allow draws or overtime wins in certain situations
- PP – For simple tables which only show games played and number of points
- Round robin
- Custom – For tables in which the number of columns and all column headers are specified as inputs, for greater customization
Sport or league specific styles
- Volleyball – For tables with volleyball system, including sets, set-points and different points for different types of wins
- Darts
- Badminton individual
- Badminton team
- Chess
- CricketRR – Cricket table with Net Run Rate
- CricketCC – Cricket table for County Championship with batting and bowling bonus points
- Fencing
- Football (soccer) was the first creation. This style is renamed to WDL
More styles
The module uses Lua to create the tables. Most functionality is obtained from the main module, but specific column formatting comes from the style sub-modules. The existing styles can handle a lot of different options. In case you need additional options it could be useful to create a new style. Note that some tweaking of an existing style could give you the functionality you need, rather than creating a completely new style. In case you do create a new style, you might want to refer to the Lua reference manual.
Other options
Other options can be used, for example: {{#invoke:Sports table|main|style=WL OT
|sortable_table = yes
|source=ICC
|update=July 28, 2018
- sortable_table
"yes" makes the table columns sortable
- source
Adds a link which should point to a web resource with the information for verifying or updating the table
- update
Gives the date when the table info was last updated. This is to be set manually - it's not automatically changed when someone changes the table.
- float
Set to left or right to float the table to the left or right on the page
- title_source
To append a reference to the title and suppress the need for a source at the foot of the table