Difference between revisions of "Module:RoundN/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Codehydro
(alpha release and basic doc)
blackwiki>Codehydro
Line 12: Line 12:
 
! Description
 
! Description
 
|-
 
|-
|style='text-align:center;vertical-align:top'| '''columns'''
+
|style='text-align:center;vertical-align:top'| {{#invoke:Headless TOC|main|'''columns'''}}
 
| Number of columns/eliminations (3 columns for Round8, 4 columns for Round16, etc.)
 
| Number of columns/eliminations (3 columns for Round8, 4 columns for Round16, etc.)
  
Line 18: Line 18:
 
* For <code>columns</code> ''less than 4'' (i.e. Round2-Round8), the 3rd Place match box is hidden by default. For <code>columns</code> ''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.
 
* For <code>columns</code> ''less than 4'' (i.e. Round2-Round8), the 3rd Place match box is hidden by default. For <code>columns</code> ''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.
 
|-
 
|-
|style='text-align:center;vertical-align:top'| {{{#}}}
+
|style='text-align:center;vertical-align:top'|{{#invoke:Headless TOC|main|{{{#}}}}}
 
|Unnamed parameters (i.e. a value not prefixed by <code>[param_name] =</code>) are read sequentially in groups of 5 such that:
 
|Unnamed parameters (i.e. a value not prefixed by <code>[param_name] =</code>) are read sequentially in groups of 5 such that:
 
====Template 1====
 
====Template 1====
Line 43: Line 43:
  
 
'''Note:'''
 
'''Note:'''
*The next 5 unnamed parameters will be ignored regardless of value unless <code>omit_blanks</code> is set to 'yes' (see below).
+
*The 5 parameters that would have populated the skipped box will be ignored regardless of value unless <code>omit_blanks</code> is set to 'yes' (see below).
*Skipping is currently only allowed in the first round (in this case, the 'Semi Finals'). For example, setting <code>columns=3</code> normally has 4 matches in the first round; thus, skipmatch5 and beyond will be ignored.
+
*Match skipping is currently only allowed in the first round (in this case, the 'Semi Finals'). For example, setting <code>columns=3</code> normally has 4 matches in the first round; thus, skipmatch5 and beyond will be ignored.
 
|-
 
|-
 
|style='text-align:center;vertical-align:top'|omit_blanks
 
|style='text-align:center;vertical-align:top'|omit_blanks
Line 58: Line 58:
 
====Template 2====
 
====Template 2====
 
turned off by default because most templates made before the release of this module were required to use empty parameters as placeholders.)
 
turned off by default because most templates made before the release of this module were required to use empty parameters as placeholders.)
 +
<pre>{{#invoke:RoundN|main|columns=3
 +
|bold_winner=yes
 +
|widescore=yes
 +
|Feb 1|A|7|B|5
 +
|Feb 1|C|1|D|2
 +
|Feb 1|E|3|F|5
 +
|Feb 2|G||H|
 +
|Feb 2|A|3 (5)|C|3 (6)
 +
|Feb 3|F|||
 +
}}</pre>
 
{{#invoke:RoundN|main|columns=3
 
{{#invoke:RoundN|main|columns=3
 
|bold_winner=yes
 
|bold_winner=yes
 +
|widescore=yes
 
|Feb 1|A|7|B|5
 
|Feb 1|A|7|B|5
 
|Feb 1|C|1|D|2
 
|Feb 1|C|1|D|2
 
|Feb 1|E|3|F|5
 
|Feb 1|E|3|F|5
 
|Feb 2|G||H|
 
|Feb 2|G||H|
|Feb 2|A|3|C|5
+
|Feb 2|A|3 (5)|C|3 (6)
 
|Feb 3|F|||
 
|Feb 3|F|||
 
}}
 
}}
 +
'''Note:'''
 +
* If entering a score that includes non-numbers{{--}}such as <code>3 (6)</code>, 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, <code>3 (5)</code> and <code>3 (6)</code> would be converted to <code>35</code> and <code>36</code>, respectively, before being compared. This should be valid for most cases, however, you may override using the <code>manualboldmatch[#]</code> parameter.
 +
* Also modified by <code>low_score_wins</code> parameter.
 +
* If scores are tied, neither are bolded.
 +
 
|}
 
|}
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

Revision as of 22:10, 30 December 2014

Usage

Basic form:

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

Parameter List

  • bold parameter names are required
  • italicized parameter names are required in some cases
Parameter name Description
Script error: No such module "Headless TOC". 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.
Script error: No such module "Headless TOC". Unnamed parameters (i.e. a value not prefixed by [param_name] =) are read sequentially in groups of 5 such that:

Template 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.

skipmatch[#] No boxes will be shown for the #th match group. For example, adding |skipmatch2=yes to Template 1 will result in
 
Semi-finalsFinal
 
      
 
Day 1
 
 
A7
 
tdb
 
B5
 
A
 
 
 
 
 
 
 

Useful for playoffs or when the number of teams playing in a round is not a power of 2. Unlike in the original template, 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).

Note:

  • 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.
omit_blanks Add |omit_blanks=yes|skipmatch2=yes to Template 1 and 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.)
 
Semi-finalsFinal
 
      
 
Day 1
 
 
A7
 
Day 2
 
B5
 
C
 
 
D
 
 
 
 
bold_winner Instead of using wikimark-up to bold the names/scores, just set bold_winner like in the following:

Template 2

turned off by default because most templates made before the release of this module were required to use empty parameters as placeholders.)

{{#invoke:RoundN|main|columns=3
|bold_winner=yes
|widescore=yes
|Feb 1|A|7|B|5
|Feb 1|C|1|D|2
|Feb 1|E|3|F|5
|Feb 2|G||H|
|Feb 2|A|3 (5)|C|3 (6)
|Feb 3|F|||
}}
 
Quarter-finalsSemi-finalsFinal
 
          
 
Feb 1
 
 
A7
 
Feb 2
 
B5
 
A3 (5)
 
Feb 1
 
C3 (6)
 
C1
 
 
 
D2
 
 
 
Feb 1
 
 
 
E3
 
Feb 3
 
F5
 
F
 
Feb 2
 
 
 
G
 
 
H
 

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.
  • Also modified by low_score_wins parameter.
  • If scores are tied, neither are bolded.