Module:RoundN/doc

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:

Alternatively, the shorthand form  (or any power of 2 between N2 and N512) is equivalent to

Parameter list
{| class='wikitable' style='width:75%' ! Parameter name ! Description
 * parameter names are required.
 * italicized parameter names are required in some cases
 * parameter names involve new features not available prior to the release of this module




 * style='text-align:center;vertical-align:top;width:9em'|
 * style='background-color:#fff'|Number of columns/eliminations (3 columns for Round8, 4 columns for Round16, etc.)

Note
 * For  less than 4 (i.e. Round2-Round8), the 3rd Place match box is hidden by default. For   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.

While required for invoking the main function, 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  with. 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 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).




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Unnamed parameters (i.e. a value not prefixed by ) are read sequentially in groups of 5 such that:

Example 1
undefined 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='text-align:center;vertical-align:top'|
 * style='background-color:#fff'| Set the  parameter to add custom CSS to the table.

To center-align the whole block, use




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'| For large tables, set scroll_height to the desired height in pixels.

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.




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'| 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'




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|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.

The shorthand  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  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)


 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|If  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.)




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|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
Note:
 * If entering a score that includes non-numberssuch as, the Semi Final score for team C in the above examplethe module will first remove all non-digit characters and concatenate the rest. For example,   and   would be converted to   and  , respectively, before being compared. This should be valid for most cases, however, you may override using the   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.




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|

The form  is also available.



Set  to show numbers next to each match group (useful for skipmatch and manualboldmatch) when viewing on the template page.
 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|

Note that these numbers will not appear in article space.



undefined Note RD[N+1] = Third Place, and will perform the job of the  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).
 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Use, replacing # with the desired column such that 1 is the leftmost round and X is the rightmost when  . For example:


 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|By default,  is set to 'yes' when   is greater than 3 and 'no' otherwise. Override as desired. (See   if you wish to rename this heading)

undefined



undefined
 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Set  to change the 'Third Place' label to 'name'. You may also use the form RD# where # = columns + 1.




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Add


 * Note: When  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  for colored brackets when the winner is the highest scorer.

Add  for colored brackets when the winner is the lowest scorer.




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Add  for repechage brackets, where the winner is awarded a bronze medal.


 * Note 1: When  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  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  for colored brackets when the winner is the highest scorer.

Add  for colored brackets when the winner is the lowest scorer.

Add  for colored brackets when there are two bronze medalists.




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Set  to the desired width in pixels. (Default is 170)




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Set  to the desired width in pixels. (Default is 30)




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Setting  is basically equal to  . Provided for compatibility. Ignored if   is set.




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Set  to the desired number of score boxes per match. (Default is 1). The number can be followed by , which will add one more score box with the sum of all the others. For examples, see test case 5 and test case 6.




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Set  to make the brackets vertically more compact. That is, to have less space between matches of the same round.




 * style='text-align:center;vertical-align:top'|
 * style='background-color:#fff'|Set  to make the brackets horizontally more compact. That is, to have less space between matches of following rounds.


 * }

Node Functions
For greater customization, node functions may be added to the parameter usually used for providing match information such as dates and location. Simply insert  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  (at some point, the preferred format would be   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
 * heading - Not yet implemented. Planned node function with the form . 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.