Module:RoundN/doc

From blackwiki
< Module:RoundN
Revision as of 22:39, 1 January 2015 by blackwiki>Codehydro
Jump to navigation Jump to search

This is the documentation page for Module:RoundN

Usage

Basic form:

{{#invoke:{{BASEPAGENAME}}|main|columns = number of columns (3 columns for Round8, 4 columns for Round16, etc.)}}

Parameter List

  • red parameter names are required
  • italicized parameter names are required in some cases
  • blue parameter names involve new features not available prior to the release of this module
Parameter name Description
Template:TOC tab Number of columns/eliminations (3 columns for Round8, 4 columns for Round16, etc.)

Note

  • For columns less than 4 (i.e. Round2-Round8), the 3rd Place match box is hidden by default. For columns greater or equal to 4, the 3rd Place match box is visible by default. This reflects the behavior of the templates prior to this module's release.
Template:TOC tab Unnamed parameters (i.e. a value not prefixed by [param_name] =) are read sequentially in groups of 5 such that:

Example 1

{{#invoke:RoundN|main|columns=2
|Day 1|A|'''7'''|B|5
|Day 2|C||D|
|tdb|A|||
}}

 
Semi-finalsFinal
 
      
 
Day 1
 
 
A7
 
tdb
 
B5
 
A
 
Day 2
 
 
 
C
 
 
D
 

Placing each group of 5 on a new line is optional, but does make it easier to read. Also, consider adding the comments such as <!-- Date-Place/Team 1/Score 1/Team 2/Score 2 --> on top and <!-- Finals --> above the first group of 5 in the finals round, etc.

Template:TOC tab Set the style parameter to add custom CSS to the table.

Module talk:RoundN/testcases/1

Template:TOC tab For large tables, set scroll_height to the desired height in pixels.

Module talk:RoundN/testcases/1

CSS units are also allowed (i.e. '20em', '30%', etc.).

Note This works by duplicating the entire table and then using CSS to lock the clone of the table to the top of the div. Conceivably, for extremely large tables, this can result in a significant amount of extra HTML code to download versus if scroll_head_unlock is used.

Template:TOC tab If it is desirable to have the round heading scroll with the table (such as if a larger viewing area is desired), set scroll_head_unlock to 'yes'

Module talk:RoundN/testcases/1

Template:TOC tab If set, boxes for the #th match group will not be shown. Most often used for playoffs or when the number of teams playing in the first round is not a power of 2.

Module talk:RoundN/testcases/1 Note:

  • Unlike in the original templates, this module does not require leading zeroes in this parameter, i.e. skipmatch001 is the same as skipmatch1 (though it may make your template code easier to read if lead with an appropriate number of zeroes).
  • The 5 parameters that would have populated the skipped box will be ignored regardless of value unless omit_blanks is set to 'yes' (see below).
  • Match skipping is currently only allowed in the first round (in this case, the 'Semi Finals'). For example, setting columns=3 normally has 4 matches in the first round; thus, skipmatch5 and beyond will be ignored.
Template:TOC tab If omit_blanks is set to yes, then all parameters that would have been skipped will instead be shifted to the next non-skipped box. (This is turned off by default because most templates made before the release of this module were required to use empty parameters as placeholders.)

Module talk:RoundN/testcases/1

Template:TOC tab The boldwinner parameter accepts either 'high' or 'low', which will automatically bold the text of the participant with the higher or lower score, respectively. In other words, set this to 'low' if the lower score wins and 'high' if the high score wins.

Example 2

Module talk:RoundN/testcases/2 Note:

  • If entering a score that includes non-numbers—such as 3 (6), the Semi Final score for team C in the above example—the module will first remove all non-digit characters and concatenate the rest. For example, 3 (5) and 3 (6) would be converted to 35 and 36, respectively, before being compared. This should be valid for most cases, however, you may override using the manualboldmatch## parameter.
  • If the scores are tied or contain no numbers, then neither will be bolded, however, you may still manually bold them with wikimarkup.
Template:TOC tab

Module talk:RoundN/testcases/2

Template:TOC tab Use RD#, replacing # with the desired column such that 1 is the leftmost round and N is the rightmost when columns = N. For example:
{{#invoke:RoundN|main|columns=7
|RD1 = Auditions|RD3 = Blah Blah|RD7 = Championship
|style=display:inline-block;height:15em;max-width:80%;overflow:auto;border:2px solid;padding:2px
|1}}

 
AuditionsRound of 64Blah BlahRound of 16Quarter-finalsSemi-finalsChampionship
 
                          
 
1
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 Third place
 
 
 
  
 
 
 
  
 
 
 
  
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Template:TOC tab Set Consol=name to change the 'Third Place' label to 'name'.
 
Final
 
  
 
 
 
 
 
 
 
 
 
 
 
 
 
Runner up
 
 
 
 
 
 
 
 
 
 
Template:TOC tab Add |color=yes
 
Final
 
  
 
1
 
 
 
 
 
 
 
 
 
 
 
Third place
 
 
2
 
 
 
 
 
 
 
Template:TOC tab By default, |3rdplace=</code> is set to 'yes' when columns is greater than 3 and 'no' otherwise. Override as desired.