Module:Sports table/doc

This Lua module is used on many pages, so changes to it will be widely noticed. Please test any changes in the module's /sandbox or /testcases subpages. Please consider discussing changes on the talk page before implementing them.

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This module depends on the following other modules:

This module uses TemplateStyles:

Module:Sports table/styles.css

Module:Sports table 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

Wikitext test cases are at Module:Sports table/testcases wikitext.

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
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
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
CricketRT – Cricket table for Ranji Trophy with batting, bowling bonus points and Runs per wicket ratio.
Fencing
College – Tables with separate conference and overall records.
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

section

When there are two sports tables on the same page, you can use |section= to provide an anchor name for the table. Pages transcluding the table, will have modified "VTE" links where the "view" link points to the anchor. Pages transcluding the table and using |transcludesection= will only show tables with a matching |section= and not all tables.

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. For a final table set "complete".

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