Module:Sports table/CricketRR/doc: Difference between revisions

Content deleted Content added
add basic doc
 
Tags: Mobile edit Mobile web edit
 
(5 intermediate revisions by 4 users not shown)
Line 1:
{{tl|Module rating |releasebeta}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
This style for Lua-based [[Module:Sports table]] is meant to build group and league tables for cricket competitions which use [[Net run rate]] as a ranking criteria (typically One-day or T20 competionscompetitions).
 
== Usage ==
 
The main command is the <nowiki>{{#invoke:Sports table|main|style=CricketRR}}</nowiki> statement which calls the module and enables you to set everything up. Next, list the positions of the teams as {{para|team1}}, {{para|team2}}, etc for however many teams you need in the table. You can use full team names there <u>without spaces</u> if you want, but using codes (as in the example) can make it easier. For each team you now define the wins, losses, ties, no results, overs bowled, overs received, runs scored and runs concededNRR using {{para|win_TTT}}, {{para|loss_TTT}}, {{para|tie_TTTdraw_TTT}}, {{para|nr_TTTtie_TTT}}, {{para|ob_TTTnr_TTT}}, {{para|or_TTT}}, {{para|rs_TTT}} and {{para|rc_TTTnrr_TTT}} respectively (with TTT replaced by the team code). If you do not define these numbers, they are 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. Define the {{para|name_TTT}} parameters which determine what name is shown in the table, you can use wiki markup and templates here as well. The module uses a set of default points values of 2 for a win, 1 for a tie or no result and 0 for a loss, but it is possible to override these and also include bonus points or deductions, as have sometimes been used as well as NRR to separate teams.
 
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Sports modules]]
}}</includeonly>