 | This Lua module is used on approximately 12,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. 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 relatively 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. |
Usage
This is a module for meta templates such as {{Round16}}, {{Round8}}, etc. Though originally designed for sports, it can be used to present any tree.
Basic form:
{{#invoke:RoundN|main|columns = [number of columns (3 columns for Round8, 4 columns for Round16, etc.)]}}
Alternatively, the shorthand form {{#invoke:RoundN|N16}} (or any power of 2 between N2 and N512) is equivalent to {{#invoke:RoundN|main|columns = 4}}
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 |
|---|---|
| columns | Number of columns/eliminations (3 columns for Round8, 4 columns for Round16, etc.)
Note
While required for invoking the main function ( PS: Though adding shorthands up to N ~70 trillion would be easy, it would make unnecessary overhead as these meta functions are generated eached time this module is called (granted generating such functions up to ~70 trillion is probably less expensive than making the table for columns = 3). |
| {{{#}}} | 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 |
| style | Set the style parameter to add custom CSS to the table.
For example, if you add To center-align the whole block, use |
| scroll_height | For large tables, set scroll_height to the desired height in pixels.
For example, if you add 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 | 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'
For example, if you add |
| skipmatch## | 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.
For example, if you add The shorthand |skipmatch1=yes |skipmatch2=yes |skipmatch4=yes |skipmatch6=yes |skipmatch7=yes Note:
|
| omit_blanks | 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.)
For example, if you add |
| bold_winner | The bold_winner 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{{#invoke:RoundN|main
|columns=3
|widescore=yes
|bold_winner=high
<!-- Date-Place/Team 1/Score 1/Team 2/Score 2 -->
|Feb 1|bold if bold_winner=high|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:
|
| manualboldmatch## |
In the same manner as the
The form |
| previewnumbers |
Set Note that these numbers will not appear in article space. |
| RD## | Use RD#, replacing # with the desired column such that 1 is the leftmost round and X is the rightmost when columns = X. For example:
{{#invoke:RoundN|N128
|RD2 = {{red|'''SECOND ROUND'''}}|RD7 = {{red|'''Championship'''}} | RD8 = {{red|'''So close, yet so far'''}}
|scroll_height=15em
}}
Note RD[N+1] = Third Place, and will perform the job of the |
| 3rdplace | By default, |3rdplace= is set to 'yes' when columns is greater than 3 and 'no' otherwise. Override as desired. (See Consol if you wish to rename this heading)
{{#invoke:RoundN|main|columns=1
|1
}}
|
| Consol | Set Consol=name to change the 'Third Place' label to 'name'. You may also use the form RD# where # = columns + 1.
{{#invoke:RoundN|main|columns=1
|3rdplace=yes
|Consol=Runner up
|1
}}
|
| color | Add |color=yes
Lua error at line 25: attempt to index field 'row' (a nil value).
Add Add |
| color_repechage | Add |color_repechage=yes for repechage brackets, where the winner is awarded a bronze medal.
Lua error at line 25: attempt to index field 'row' (a nil value).
Add Add Add |
| team-width | Set team-width to the desired width in pixels. (Default is 170)
|
| score-width | Set score-width to the desired width in pixels. (Default is 30)
|
| widescore | Setting |widescore=yes is basically equal to |score-width=40. Provided for compatibility. Ignored if score-width is set.
|
| score-boxes | Set score-boxes to the desired number of score boxes per match. (Default is 1). The number can be followed by + sum, which will add one more score box with the sum of all the others. For examples, see test case 5 and test case 6.
|
| flex_tree | Set |flex_tree=yes to make the brackets vertically more compact. That is, to have less space between matches of the same round.
Script error: The function "N4" does not exist. |
| short_brackets | Set |short_brackets=yes to make the brackets horizontally more compact. That is, to have less space between matches of following rounds.
Script error: The function "N4" does not exist. |
Node Functions
 | Some of these functions are still in alpha testing and may not be stable. Please feel free to comment at the talk page. |
For greater customization, node functions may be added to the parameter usually used for providing match information such as dates and ___location. Simply insert node_function{function name} in the appropriate ___location. A demonstration of most of the node functions can be found at RoundN/testcases/4.
- orphan - Current node is disconnected from all other nodes (no lines will be drawn). One practical use for this may be when the winners of the previous round advance to a different tournament instead of playing each other but the losers still play a consolation match for 3rd place, as per this discussion.
For the next three node functions, the parameters usually used for team names and scores should be omitted if these node functions are used.
- line - Current node is omitted and replaced with a horizontal line. Text may be displayed above this line via
node_function{line(text)}(at some point, the preferred format would benode_function{line}textto match the form of the canvas function though backwards compatibility would probably be maintained). If curly brackets are desired in the text, make sure to escape them with\. - bridge - Current node is omitted and replaced with a vertical line.
- canvas - Current node is replaced with whatever you want via
node_function{canvas}anything - heading - Not yet implemented. Planned node function with the form
node_function{heading(name)}date/___location. Makes a round name heading like for the Consol parameter, but may be placed anywhere, as per the "Elimination Rounds" of RoundN/testcases/6 (which currently renders the planned output of this function without the functions).
Undocumented features
Alas User:Codehydro seriously overbuilt this module and never found the time to document even half the features available. Check out the following examples which may contain some advanced features:
Partial List of undocumented params
- no_column_head
- branch_upwards
Note that some of these features may not have been documented due to incomplete implementation.
local p = {}
local defaultRounds = {'Finals' , 'Semi Finals', 'Quarter Finals'}
local output = mw.html.create('table')
local last = {row = nil, cell = nil}
function newRow()
last.row = output:tag('tr')
last.cell = last.row:tag('td')
last.cell
:attr('height', 5)
end
function p._main(args, frame)
output
:css('font-size', '90%')
:css('margin', '1em 2em 1em 1em')
:css('border-spacing', 0)
:css('border', 0)
:css('padding', 0)
for k = 1, args.columns do
if N == 1 then
newRow()
else
last.row
:tag('td')
:attr('colspan', 2)
end
last.row:tag('td')
:attr('colspan', 2)
:css('text-align', 'center')
:css('border', '1px solid #aaa')
:css('background-color', '#f2f2f2')
:wikitext(args['RD' .. k] or defaultRounds[k - 1] or ('Round of ' .. math.pow(2, cols - k + 1)))
end
return output
end
function p.main(frame)
local args = require('Module:Arguments').getArgs(frame, {
wrappers = WRAPPER_TEMPLATE
})
return p._main(args, frame)
end
return p