Module:Build bracket/doc

This is an old revision of this page, as edited by Pbrks (talk | contribs) at 18:58, 3 August 2022 (Path codes). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Description

This template is intended to be used to create and edit intricate sports brackets that cannot be made by Module:RoundN or Module:Team bracket. For example, additional headers (for double-elimination brackets; 3rd-, 5th-, 7th-place matches; etc), singular omitted matches (i.e., having a horizonal line instead of a match), and N-way brackets (N teams per match). The syntax is slightly more complicated than the aforementioned brackets, but simpler than using the standard wikitable code.

The template breaks down the brackets into rows and columns.

Bracket builder

{{#invoke:Build bracket|main
| rounds =
| rows =

<!--Column 1 -->
| 0-1  = 
| 1-1  = 
| 2-1  = 
| 3-1  = 
...

<!--Column 1.5 -->
| 0-1a = 
| 1-1a = 
| 2-1a = 
| 3-1a = 
...

<!--Column 2 -->
| 0-2  = 
| 1-2  = 
| 2-2  = 
| 3-2  = 
...

}}
  0-1 0-2 0-3
           
  1-1 1-1a 1-2 1-2a 1-3
  2-1 2-1a 2-2 2-2a 2-3
  3-1 3-1a 3-2 3-2a 3-3
 

Note: Borders are not actually present. They are only here to help visualization.

Parameters

Parameter Description
rounds number of rounds (columns).
rows number of rows.
n-m Entry for row n column m. Valid entries areheader, team, or text. Note: |0-m= will only accept header for all m.
n-ma The line path code directly after n column m. See below for details.
RDm
RDm-k
The header text of the (kth) header in round m.
RDm-seedk The seed of the kth team in round m.
RDm-teamk The name of the kth team in round m.
RDm-scorek
RDm-scorek-l
The score of (the lth leg of) the kth team in round m.
RDm-textk The text of the kth text entry in round m.
seed-width the width of the cells for seeds. Plain numbers are assumed to be in px units (e.g., 25 or 25px 2em for 2em)
team-width the width of the cells for team names. Plain numbers are assumed to be in px units (e.g., 200 for 200px or 15em for 15em)
score-width the width of the cells for scores. Plain numbers are assumed to be in px units (e.g., 25 or 25px 2em for 2em)
seeds set to no to omit seeds in all rounds.
legs the number of legs for all rounds.
RDm-legs the number of legs in round m. Overrides |legs=.
RD-shade the background color (in hex format, e.g. #ABCDEF) of all headers.
RDm-shade
RDm-k-shade
the background color (in hex format, e.g. #ABCDEF) of the (kth) header in round m. Overrides |RD-shade=.
RDm-scorek-shade
RDm-scorek-l-shade
the background color (in hex format, e.g. #ABCDEF) the (lth leg of) kth team's score round m.

Path codes

Path codes are only accepted in parameters of the form |n-ma=.

Input Output Notes
out
   
   
By default, path will connect between two rows, e.g.:
       
       

Appending the text split will cause the path to connect in the middle of a row, e.g.:

     
in
   
   
up
   
   
down
   
   

Path codes can be combined to create any combination, repeats are ignored, and order does not matter. For example, out up down creates

   
   

Examples

Note: These are only examples. Module:Team bracket and Module:RoundN handle some of these brackets much better than this template does.

Standard 4-team bracket

{{#invoke:Build bracket|main
| rounds=2
| rows=6

<!-- Column1 -->
| 0-1  = header
| 1-1  = team
| 2-1  = team
| 5-1  = team
| 6-1  = team

<!-- Column1.5 -->
| 1-1a  = out down
| 2-1a  = down
| 3-1a  = in
| 4-1a  = up
| 5-1a  = out up

<!-- Column2 -->
| 0-2  = header
| 3-2  = team
| 4-2  = team

<!-- Overrides -->
| RD2 = Final

| RD1-seed1 = 1
| RD1-seed3 = 2
}}
SemifinalsFinal

No seeds

{{#invoke:Build bracket|main
| rounds=2
| rows=2
| seeds = no

<!-- Column1 -->
| 0-1  = header
| 1-1  = team
| 2-1  = team

<!-- Column1.5 -->
| 1-1a  = out in

<!-- Column2 -->
| 0-2  = header
| 1-2  = team
| 2-2  = team
}}
SemifinalsFinal

Legs

{{#invoke:Build bracket|main
| rounds=3
| rows=4
| legs=2
| RD3-legs=3

<!-- Column1 -->
| 0-1  = header
| 3-1  = team
| 4-1  = team

<!-- Column1.5 -->
| 2-1a  = in
| 3-1a  = out up

<!-- Column2 -->
| 0-2  = header
| 2-2  = team
| 3-2  = team

<!-- Column2.5 -->
| 1-2a  = in
| 2-2a  = out up

<!-- Column3 -->
| 0-3  = header
| 1-3  = team
| 2-3  = team
}}
QuarterfinalsSemifinalsFinal

3-way bracket

{{#invoke:Build bracket|main
| rounds=2
| rows=11

<!-- Column1 -->
| 0-1  = header
| 1-1  = team
| 2-1  = team
| 3-1  = team
| 5-1  = team
| 6-1  = team
| 7-1  = team
| 9-1  = team
| 10-1 = team
| 11-1 = team

<!-- Column1.5 -->
| 2-1a  = out down split
| 3-1a  = up
| 4-1a  = up
| 5-1a  = up
| 6-1a  = out up down in split
| 7-1a  = up
| 8-1a  = up
| 9-1a  = up
| 10-1a = out up split

<!-- Column2 -->
| 0-2  = header
| 5-2  = team
| 6-2  = team
| 7-2  = team
}}
SemifinalsFinal