Module:Bracket/doc
 | This is a documentation subpage for Module:Bracket. It may contain usage information, categories and other content that is not part of the original module page. |
 | This module is rated as beta. It is considered ready for widespread use, but as it is still relatively new, it should be applied with some caution to ensure results are as expected. |
Wrapper for bracket templates, which can be used in place of the following for reduced Post-expand include size:
- {{2TeamBracket}}
- {{2TeamBracket-Info}}
- {{3TeamBracket-PagePlayoff}}
- {{4TeamBracket}}
- {{4TeamBracket-Consols}}
- {{4TeamBracket-Info}}
- {{4TeamBracket-PagePlayoff}}
- {{4TeamBracket-Stepladder}}
- {{4TeamBracket-Tennis3}}
- {{4TeamBracket-Tennis35}}
- {{4TeamBracket-Tennis5}}
- {{5TeamBracket}}
- {{5TeamBracket-Consols}}
- {{5TeamBracket-Stepladder}}
- {{6TeamBracket}}
- {{6TeamBracket-PagePlayoff}}
- {{7TeamBracket}}
- {{7TeamBracket-Consols}}
- {{7TeamBracket-StepladderToSF}}
- {{8TeamBracket}}
- {{8TeamBracket-2Leg}}
- {{8TeamBracket-Byes}}
- {{8TeamBracket-Compact-Byes}}
- {{8TeamBracket-Compact-NoSeeds-Byes}}
- {{8TeamBracket-Consols}}
- {{8TeamBracket-Double-Stepladder}}
- {{8TeamBracket-Info}}
- {{8TeamBracket-PagePlayoff}}
- {{8TeamBracket-Stepladder}}
- {{8TeamBracket-Tennis3}}
- {{8TeamBracket-Tennis5}}
- {{8TeamBracket-info}}
- {{12TeamBracket}}
- {{12TeamBracket-Consols}}
- {{14TeamBracket}}
- {{14TeamBracket-Consols}}
- {{14TeamBracket-Stepladder}}
- {{16TeamBracket}}
- {{16TeamBracket-Byes}}
- {{16TeamBracket-Compact-Archery}}
- {{16TeamBracket-Compact-NoSeeds-Byes}}
- {{16TeamBracket-Compact-Tennis3}}
- {{16TeamBracket-Compact-Tennis3-Byes}}
- {{16TeamBracket-Compact-Tennis5}}
- {{16TeamBracket-Compact-Tennis5-Byes}}
- {{16TeamBracket-Consols}}
- {{16TeamBracket-Info}}
- {{16TeamBracket-Tennis3}}
- {{16TeamBracket-Tennis5}}
- {{18TeamBracket}}
- {{24TeamBracket}}
- {{24TeamBracket-Byes}}
- {{24TeamBracket-Byes2}}
- {{24TeamBracket-Info}}
- {{24TeamBracket-NoSeeds}}
- {{32TeamBracket}}
- {{32TeamBracket-Byes}}
- {{32TeamBracket-Compact-NoSeeds-Byes}}
- {{32TeamBracket-Compact-Squash5}}
- {{32TeamBracket-Compact-Tennis3}}
- {{32TeamBracket-Info}}
- {{32TeamBracket-Tennis3}}
- {{64TeamBracket}}
Usage
{{#invoke:Bracket|template_name}}
Example
{{#invoke:Bracket|16TeamBracket-Compact-Tennis3}}
| 1st round | 2nd round | Semifinals | Finals | ||||||||||||||||||||||||
Adding new templates
New templates can be added using the following format:
p['TEMPLATE_NAME'] = function (frame)
return p._teamBracket(frame, 'TEMPLATE_NAME', {ALTERNATIVE_PARAMETER_NAMES}, {PARAMETER_DEFAULTS})
end
- TEMPLATE_NAME is the name of the template without "Template:"
- ALTERNATIVE_PARAMETER_NAMES is an array of custom parameters and the standard parameter of Moduke:Team Bracket that they translate to, in the form
CUSTOM_NAME = "STANDARD_NAME". For example, a template that uses|RD1-group1 = {{{RD1-group1|{{{group1|}}}}}}would havegroup1 = "RD1-group1". Any parameters that start with a number or contain a dash need to be specified as['CUSTOM_NAME'], e.g.['RD1-seed01'] = 'RD1-seed1'. - PARAMETER_DEFAULTS is an array of default parameter values that are used in a parameter is not specified. For example, a template that uses
|RD1 = Quarterfinalswould haveRD1 = "Quarterfinals", or a template that uses|team-width = {{{team-width|125}}}would have['team-width'] = "125". Some parameters are automatically determined based on TEMPLATE-NAME unless explicity specified in PARAMETER_DEFAULTS:roundsis automatically calculated based on the##Teamor##Roundtext present in TEMPLATE-NAME. This does not need to be specified.- Templates with
-Tennis##or-Squash##in TEMPLATE-NAME will havesetsset to the value of##. In addition, these templates will have{seeds = "yes", nowrap = "yes"}set. - Templates with
-Compactin TEMPLATE-NAME will automatically default tocompact = "yes"