Module:Build bracket/doc

This is a documentation subpage for टेम्पलेट:Terminate sentence
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on many 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 at Wikipedia talk:High-risk templates before implementing them.

This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.

This module 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.

Usage

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

| col1-headers = 
| col1-matches = 
| col1-lines   = 

| col2-headers = 
| col2-matches = 
| col2-lines   = 

...

| col1-col2-paths = 
| col2-col3-paths = 

...
}}

Parameters

Parameter	Description	Default
`rounds`	number of rounds (columns).	`1`
`rows`	manually set the number of rows.	Automatic
`teams-per-match`	enter the number of teams in each match. Use `colm-teams-per-match` to set individual columns	`2`
`colm-headers`	(optional) enter the row numbers where headers are desired in column m. Separate entries with `,`. Half integer values are allowed.	Automatic
`colm-matches`	enter the row numbers where a match is desired in column m. Matches take up two rows by default. Separate entries with `,`. Half integer values are allowed.
`colm-lines`	enter the row numbers where a line is desired (in leu of a match) in column m. Separate entries with `,`. Half integer values are allowed.
`colm-colm+1-paths`	enter the starting and ending row numbers, separated by `-`, from columns m and m+1 where a path is desired. Separate entries with `,`. Half integer values are allowed.
`colm-colm+1-cross`	enter the row number where paths intersect from column m to m+1. Only one cross can exist per column.
`compact`	set to `yes` to vertically condense the bracket.	`no`
`RDm-altname`	Alternate name for `RDm`. Use `RDmh-altname` for cells under header mh.

`maxround`	final round to display. This parameter should be omitted unless it is less than the default value set by `rounds`.
`minround`	first round to display.	`1`
`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)	`25`
`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)	`150`
`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)	`25`
`seeds`	set to `no` to omit seeds in in all matches. set to `yes` to show seed cells to show for all matches.
`legs`	the number of legs for all rounds. Use `RDm-legs` to individually set columns. Use `RDm-legsk` to individually set teams.	`1`
`autolegs`	set to `yes` to automatically generate score cells per team.	`no`
`byes`	set to `yes` to hide any team cells that are empty. Use `RDm-byes` to set individual columns.	`no`
`aggregate`	set to `yes` to add an aggregate score box to each match. Only matches with two or more legs will show the aggregate score box.	`no`
`boldwinner`	set to `yes` to automatically bold the seed/team/score with the higher score in each match.	`no`

`RDm`, `RDmh`	The header text of the (alpha hth) header in column m (e.g., `RD1` for the first header and `RD1b` for the second header in column 1).
`RDm-seedk`	The seed of the kth team in column m. Alternatively, use `RDmh-seedk` for the kth team under header mh.
`RDm-teamk`	The name of the kth team in column m. Alternatively, use `RDmh-teamk` for the kth team under header mh.
`RDm-scorek`	The score of the kth team in column m. Alternatively, use `RDmh-scorek` for the kth team under header mh. Append the suffix `-l` for the lth leg or `-agg` for the aggregate score.
`RDm-textk`	The text above the kth match in column m. Alternatively, use `RDmh-textk` for the kth match under header mh.
`RD-shade`	the background color (in hex format, e.g. `#ABCDEF`) of all headers. Use `RDm-shade` or `RDmh-shade` for individual headers.	`#F2F2F2`
`RDm-RD(m+1)-path`	set to `no` or `0` to omit the paths from round m to round m+1. Note: Does not currently work for paths under subheaders.	`yes`

Parameter hierarchy

Whenever there are multiple headers in a single column, more than one parameter may be assigned to a cell value. For example, in the following bracket, both |RD1-team3= and |RD1b-team1= can be used to assign the third team in the first column:


	फाइनल









	निचला राउंड 1



	`RD1-team3` or `RD1b-team1`

By default, entries with subheader prefixes will override those without. In the above example, RD1b-team1 will override any value that has been set by RD1-team3.

Parameters used in articles take precedence over parameters used in the template itself. For example, suppose ArticleX used the template NTeamBracket, and suppose NTeamBracket had the parameter |RD1-seed1=1 set. If ArticleX implemented {{NTeamBracket |RD1-seed1=2}}, then the first team in round 1 would have a seed of 2.

Path codes

Path codes are entered in the form a-b, where a is associated match in the first column, and b is associated match in the second column. Path codes can be grouped; for example, (a,b)-c is equivalent to a-c, b-c. टेम्पलेट:Wikitable

Examples

Note: These are only examples to illustrate parameters. Standard 4-team, 8-team, etc. brackets are better handled by Module:Team bracket.

Standard 4-team bracket

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

| col1-headers = 1
| col2-headers = 1

| col1-matches = 3,7
| col2-matches = 5

| col1-col2-paths = (3,7)-5

<!-- Defaults -->
| RD2 = Grand Final

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


	सेमीफाइनल					Grand Final



	1







	2

3-way bracket

{{#invoke:Build bracket|main
| rounds=2
| teams-per-match = 3

| col1-headers = 1
| col2-headers = 1

| col1-matches = 3,7,11
| col2-matches = 7

| col1-col2-paths = (3,7,11)-7
}}


	सेमीफाइनल					फाइनल

Double-elimination bracket

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

| col1-headers = 1,7
| col2-headers = 1,7
| col3-headers = 7
| col4-headers = 1

| col1-matches = 4,11
| col2-matches = 3,10
| col3-lines   = 3
| col3-matches = 9
| col4-matches = 6

| col1-col2-paths = 4-3, 11-10
| col2-col3-paths = 3-3, 10-9
| col3-col4-paths = (3,9)-6

<!-- Defaults -->
| RD1 = Upper round 1
| RD2 = Upper final
| RD3b = Lower final
}}

Upper round 1

Upper final

फाइनल

निचला राउंड 1

निचला राउंड 2

Lower final

Crossing paths

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

| col1-matches = 3,7
| col2-matches = 3,7

| col1-col2-paths = 3-7, 7-3
| col1-col2-cross = 5
}}


	सेमीफाइनल						फाइनल

No seeds

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

| col1-matches = 3,7
| col2-matches = 5

| col1-col2-paths = (3,7)-5
}}


	सेमीफाइनल				फाइनल

Text

{{#invoke:Build bracket|main
| rounds=2
| col1-matches = 3,6
| col2-matches = 4.5
| col1-col2-paths = (3,6)-4.5

| RD1-text1 = Text 1
| RD1-text2 = Text 2
| RD2-text1 = Text 3
}}


	सेमीफाइनल					फाइनल

	Text 1


						Text 3


	Text 2

Legs

{{#invoke:Build bracket|main
| rounds=3
| legs = 2
| RD1-legs = 3

| col1-matches = 3,6,9,12
| col2-matches = 4.5,10.5
| col3-matches = 7.5

| col1-col2-paths = (3,6)-4.5, (9,12)-10.5
| col2-col3-paths = (4.5,10.5)-7.5
}}

क्वार्टर

सेमीफाइनल

फाइनल

Aggregate

{{#invoke:Build bracket|main
| rounds=3
| legs=2
| aggregate=y

| col1-matches = 3,6,9,12
| col2-matches = 4.5,10.5
| col3-matches = 7.5

| col1-col2-paths = (3,6)-4.5, (9,12)-10.5
| col2-col3-paths = (4.5,10.5)-7.5
}}

क्वार्टर

सेमीफाइनल

फाइनल

Byes

{{#invoke:Build bracket|main
| rounds=3
| RD1-byes = y

| col1-matches = 3,6,9,12
| col2-matches = 4.5,10.5
| col3-matches = 7.5

| col1-col2-paths = (3,6)-4.5, (9,12)-10.5
| col2-col3-paths = (4.5,10.5)-7.5

| RD1-team1 = Team 1
| RD1-team2 = Team 2
}}

क्वार्टर

सेमीफाइनल

फाइनल

Team 1

Team 2

Bold winner

{{#invoke:Build bracket|main
| rounds=2
| legs = 3
| boldwinner=y
| col1-matches = 3,7
| col2-matches = 5
| col1-col2-paths = (3,7)-5

| RD1-seed1 = 1 | RD1-team1 = Team 1 | RD1-score1-1 = 5  | RD1-score1-2 = 12 | RD1-score1-3 = 15
| RD1-seed2 = 4 | RD1-team2 = Team 2 | RD1-score2-1 = 11 | RD1-score2-2 = 10 | RD1-score2-3 = 4

| RD1-seed3 = 2 | RD1-team3 = Team 3 | RD1-score3-1 = 6  | RD1-score3-2 = 13 | RD1-score3-3 = {{ndash}}
| RD1-seed4 = 3 | RD1-team4 = Team 4 | RD1-score4-1 = 3  | RD1-score4-2 = 2  | RD1-score4-3 = {{ndash}}

| RD2-seed1 = 4 | RD2-team1 = Team 2 | RD2-score1-1 = 2  | RD2-score1-2 = 2  | RD2-score1-3 = 5
| RD2-seed2 = 2 | RD2-team2 = Team 3 | RD2-score2-1 = 1  | RD2-score2-2 = 7  | RD2-score2-3 = 2
}}


सेमीफाइनल					फाइनल



1	Team 1	5	12	15

4	Team 2	11	10	4

					4	Team 2	2	2	5

					2	Team 3	1	7	2

2	Team 3	6	13	–

3	Team 4	3	2	–

Usage

Parameters

Parameter hierarchy

Path codes

Examples

Standard 4-team bracket

3-way bracket

Double-elimination bracket

Crossing paths

No seeds

Text

Legs

Aggregate

Byes

Bold winner

See also