Module:RoundN/doc

This is a documentation subpage for Module:RoundN.
It may contain usage information, categories and other content that is not part of the original module page.

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.

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

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.

shorthand

Shorthand

While required for invoking the main function ({{#invoke:RoundN|main|columns=}}), this module has meta functions in the form of 'N##' which can call main with the right columns for you. For example, you may replace ... |main|columns = 7... with ...|N128 .... Valid for N# where # is a power of 2. You must invoke this module directly to use this (vs. a template that already has a columns value). Only works up to N512. If say N1024 ever becomes necessary, call main directly and set |columns=10.

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|||
}}

Semi-finals		Final

Day 1

A	7
		tdb
B	5
		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  on top and  above the first group of 5 in the finals round, etc.

style

Set the style parameter to add custom CSS to the table.

For example, if you add |style=width:20em;font-size:70% to Example 1:

Semi-finals		Final

Day 1

A	7
		tdb
B	5
		A
Day 2

C

D

To center-align the whole block, use style=margin:auto;

scroll_height

scroll_height

For large tables, set scroll_height to the desired height in pixels.

For example, if you add |scroll_height=140 to Example 1:

Semi-finals		Final

Day 1

A	7
		tdb
B	5
		A
Day 2

C

D

Semi-finals		Final

Day 1

A	7
		tdb
B	5
		A
Day 2

C

D

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.

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 |scroll_head_unlock=yes to the code the scroll_height example:

Semi-finals		Final

Day 1

A	7
		tdb
B	5
		A
Day 2

C

D

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 |skipmatch2=yes to Example 1:

Semi-finals		Final

Day 1

A	7
		tdb
B	5
		A

shorthand (range)

NEW:

The shorthand |skipmatch = 1-2;4;6-7 will do the same thing as:

|skipmatch1=yes
|skipmatch2=yes
|skipmatch4=yes
|skipmatch6=yes
|skipmatch7=yes

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).
Previously, skipmatch only worked in the first round. This limitation no longer applies. (See Module talk:RoundN/testcases/3)

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 |omit_blanks=yes to Example 1 with |skipmatch2=yes:

Semi-finals		Final

Day 1

A	7
		Day 2
B	5
		C

		D

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&#61;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|||
}}

Quarter-finals		Semi-finals		Final

Feb 1

bold if bold_winner=high	7
		Feb 2
B	5
		A	3 (5)
Feb 1
		C	3 (6)
C	1

D	2

Feb 1

E	3
		Feb 3
F	5
		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.
If the scores are tied or contain no numbers, then neither will be bolded, however, you may still manually bold them with wikimarkup.
This does not remove any formatting already present.

manualboldmatch##

In the same manner as the skipmatch parameters, you may use|manualboldmatch1=yeson Example 2 to prevent automatic bolding in the first group, etc. Again, as with skipmatch, leading zeroes may be added as desired.

Quarter-finals		Semi-finals		Final

Feb 1

bold if bold_winner=high	7
		Feb 2
B	5
		A	3 (5)
Feb 1
		C	3 (6)
C	1

D	2

Feb 1

E	3
		Feb 3
F	5
		F
Feb 2

G

H

Quarter-finals		Semi-finals		Final

Feb 1

bold if bold_winner=high	7
		Feb 2
B	5
		A	3 (5)
Feb 1
		C	3 (6)
C	1

D	2

Feb 1

E	3
		Feb 3
F	5
		F
Feb 2

G

H

shorthand (range)

Shorthand

The form manualboldmatch = 1-3;6;9-12 is also available.

previewnumbers

Set |previewnumbers = yes to show numbers next to each match group (useful for skipmatch and manualboldmatch) when viewing on the template page.

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
}}

Round of 128

SECOND ROUND

Round of 32

Round of 16

Quarter-finals

Semi-finals

Championship

So close, yet so far

Round of 128

SECOND ROUND

Round of 32

Round of 16

Quarter-finals

Semi-finals

Championship

So close, yet so far

Note RD[N+1] = Third Place, and will perform the job of the Consol parameter if the latter is omitted, i.e. RD[N+1] is ignored if Consol is true. Also, this alternate name for Consol was not available prior to the release of this module (and is provided because the module's programmer thought 'Consol' was unintuitive).

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
}}

	Final

	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
}}

	Final

	1








	Runner up

color

Add |color=yes

	Final

	7

	Team A	3

	Team B	2




	Third place

	8

	Team C

	Team D	0

Note: When |color=yes is set, the brackets are hardcoded to be colored as shown in the example above. To color the "correct" cells, you must also activate bold_winner to either high or low. Thus allowing the module to identify and color the winners and losers correctly.

Add |color=yes & |bold_winner=high for colored brackets when the winner is the highest scorer.

	Final

	7

	Silver medalist	2

	Gold medalist	3




	Third place

	8

		0

	Bronze medalist	1

Add |color=yes & |bold_winner=low for colored brackets when the winner is the lowest scorer.

	Final

	7

	Gold medalist	2

	Silver medalist	3




	Third place

	8

	Bronze medalist	0

		1

color_repechage

Add |color_repechage=yes for repechage brackets, where the winner is awarded a bronze medal.

	Final

	7

	Team A	3

	Team B	2

Note 1: When |color_repechage=yes is set, the brackets are hardcoded to be colored as shown in the example above. To color the "correct" cells, you must also activate bold_winner to either high or low. Thus allowing the module to identify and color the winners and losers correctly.

Note 2: When |color_repechage=yes is set AND the final match of the brackest is skipped, as in cases where there are two bronze medalists, all winners of the final stage visible will be colored bronze.

Add |color_repechage=yes & |bold_winner=high for colored brackets when the winner is the highest scorer.

	Final

	7

	Team A	3

	Team B	2

Add |color_repechage=yes & |bold_winner=low for colored brackets when the winner is the lowest scorer.

	Final

	7

	Team A	3

	Team B	2

Add |color_repechage=yes & skip the final match of the brackets for colored brackets when there are two bronze medalists.

Repechage		Bronze medal

1

Team A	3
		3
Team B	2
		Team A	8

		Team E	7




2

Team C	6
		4
Team D	5
		Team C	10

		Team F	11

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.

	Semi-finals				Final

short_brackets

Set |short_brackets=yes to make the brackets horizontally more compact. That is, to have less space between matches of following rounds.

	Semi-finals				Final

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 be node_function{line}text to 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.