Difference between revisions of "Module:RoundN/doc"
blackwiki>Codehydro |
blackwiki>Codehydro (more params) |
||
| Line 5: | Line 5: | ||
<pre>{{#invoke:{{BASEPAGENAME}}|main|columns = number of columns (3 columns for Round8, 4 columns for Round16, etc.)}}</pre> | <pre>{{#invoke:{{BASEPAGENAME}}|main|columns = number of columns (3 columns for Round8, 4 columns for Round16, etc.)}}</pre> | ||
| − | + | ==Parameter List== | |
*'''bold''' parameter names are required | *'''bold''' parameter names are required | ||
*''italicized'' parameter names are required in some cases | *''italicized'' parameter names are required in some cases | ||
| Line 11: | Line 11: | ||
! Parameter name | ! Parameter name | ||
! Description | ! Description | ||
| + | |||
|- | |- | ||
| − | |style='text-align:center;vertical-align:top'| {{ | + | |
| + | |style='text-align:center;vertical-align:top;width:9em'| {{TOC tab|'''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.) | ||
'''Note''' | '''Note''' | ||
* 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'|{{TOC tab|{{{#}}}}} | ||
|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: | ||
| − | ==== | + | ====Example 1==== |
<pre>{{#invoke:RoundN|main|columns=2 | <pre>{{#invoke:RoundN|main|columns=2 | ||
|Day 1|A|'''7'''|B|5 | |Day 1|A|'''7'''|B|5 | ||
| Line 32: | Line 36: | ||
}} | }} | ||
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 <code><nowiki><!-- Date-Place/Team 1/Score 1/Team 2/Score 2 --></nowiki></code> on top and <code><nowiki><!-- Finals --></nowiki></code> above the first group of 5 in the finals round, etc. | 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 <code><nowiki><!-- Date-Place/Team 1/Score 1/Team 2/Score 2 --></nowiki></code> on top and <code><nowiki><!-- Finals --></nowiki></code> above the first group of 5 in the finals round, etc. | ||
| + | |||
|- | |- | ||
| − | |style='text-align:center;vertical-align:top'| skipmatch[#] | + | |
| − | |No boxes will be shown for the #th match group. For example, adding <code><nowiki>|</nowiki>skipmatch2=yes</code> to ''' | + | |style='text-align:center;vertical-align:top'| {{TOC tab|skipmatch[#]}} |
| + | |No boxes will be shown for the #th match group. For example, adding <code><nowiki>|</nowiki>skipmatch2=yes</code> to '''Example 1''' will result in | ||
{{#invoke:RoundN|main|columns=2|skipmatch2=yes | {{#invoke:RoundN|main|columns=2|skipmatch2=yes | ||
|Day 1|A|'''7'''|B|5 | |Day 1|A|'''7'''|B|5 | ||
| Line 45: | Line 51: | ||
*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). | *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). | ||
*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. | *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 | + | |
| − | |Add <code><nowiki>|omit_blanks=yes|skipmatch2=yes</nowiki></code> to ''' | + | |style='text-align:center;vertical-align:top'|{{TOC tab|omit_blanks|depth=2}} |
| + | |Add <code><nowiki>|omit_blanks=yes|skipmatch2=yes</nowiki></code> to '''Example 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.) | ||
{{#invoke:RoundN|main|columns=2|skipmatch2=yes|omit_blanks=yes | {{#invoke:RoundN|main|columns=2|skipmatch2=yes|omit_blanks=yes | ||
|Day 1|A|'''7'''|B|5 | |Day 1|A|'''7'''|B|5 | ||
| Line 53: | Line 61: | ||
|tdb|A||| | |tdb|A||| | ||
}} | }} | ||
| + | |||
|- | |- | ||
| − | |bold_winner | + | |
| + | |style='text-align:center;vertical-align:top'|{{TOC tab|bold_winner}} | ||
|Instead of using wikimark-up to bold the names/scores, just set <code>bold_winner</code> like in the following: | |Instead of using wikimark-up to bold the names/scores, just set <code>bold_winner</code> like in the following: | ||
| − | ==== | + | ====Example 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 | <pre>{{#invoke:RoundN|main|columns=3 | ||
| Line 83: | Line 93: | ||
* If scores are tied, neither are bolded. | * If scores are tied, neither are bolded. | ||
| + | |- | ||
| + | |||
| + | |style='text-align:center;vertical-align:top'|{{TOC tab|low_score_wins|depth=2}} | ||
| + | ||Add <code>|low_score_wins=yes</code> to '''Example 2''' to bold the team with the lower score if <code>bold_winner</code> is set to yes. (Example is cropped to save space) | ||
| + | <div style='height:200px;overflow:hidden'>{{#invoke:RoundN|main|columns=3 | ||
| + | |bold_winner=yes | ||
| + | |widescore=yes | ||
| + | |low_score_wins=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||| | ||
| + | }}</div> | ||
| + | |||
| + | |- | ||
| + | |||
| + | |style='text-align:center;vertical-align:top'|{{TOC tab|manualboldmatch[#]|depth=2}} | ||
| + | ||In the same manner as the <code>skipmatch</code> parameters, you may use <code>|manualboldmatch1=yes</code> on '''Example 2''' to prevent automatic bolding in the first group, etc. | ||
| + | <div style='height:150px;overflow:hidden'>{{#invoke:RoundN|main|columns=3 | ||
| + | |bold_winner=yes | ||
| + | |widescore=yes | ||
| + | |low_score_wins=yes | ||
| + | |manualboldmatch1=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||| | ||
| + | }}</div> | ||
|} | |} | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | ||
Revision as of 23:51, 30 December 2014
| This module is rated as alpha. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Template:TOC tab | Number of columns/eliminations (3 columns for Round8, 4 columns for Round16, etc.)
Note
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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|||
}}
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Template:TOC tab | No boxes will be shown for the #th match group. For example, adding |skipmatch2=yes to Example 1 will result in
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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Template:TOC tab | Add |omit_blanks=yes|skipmatch2=yes to Example 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.)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Template:TOC tab | Instead of using wikimark-up to bold the names/scores, just set bold_winner like in the following:
Example 2turned 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|||
}}
Note:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Template:TOC tab | Add |low_score_wins=yes to Example 2 to bold the team with the lower score if bold_winner is set to yes. (Example is cropped to save space)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Template:TOC tab | In the same manner as the skipmatch parameters, you may use |manualboldmatch1=yes on Example 2 to prevent automatic bolding in the first group, etc.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||