Module:Build bracket/doc: Difference between revisions

Content deleted Content added
 
(33 intermediate revisions by 7 users not shown)
Line 2:
| Module =
{{high-use|| Wikipedia talk:High-risk templates}}
{{Module rating|betarelease}}
 
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.
Line 37:
| RD1-score1 =
...</nowiki>
{{))}}|lang=moin"wikitext"}}
Per [[MOS:ACCESS#Font size]] and [[MOS:SMALLFONT]], "avoid using smaller font sizes in elements that already use a smaller font size, such as infoboxes, navboxes and reference sections". Since this template's text is already reduced to 90% of the normal size, use of the {{tl|Small}} template or {{tag|small}} tags within this template produces a font size that is 77% of the page default, well below the 85% minimum specified in the linked guidelines.
}}
Line 49:
| Module =
{{!}} <code>rounds</code> {{!!}} number of rounds (columns). {{!!}} <code>1</code>
{{!-}}
{{!}} <code>autocol</code> {{!!}} set to <code>yes</code> to automatically set set maximum round to display based on entries. {{!!}} <code>no</code>
{{!-}}
{{!}} <code>rows</code> {{!!}} manually set the number of rows. {{!!}} Automatic
Line 58 ⟶ 60:
{{!}} <code>col<i>m</i>-matches</code> {{!!}} enter the row numbers where a match is desired in column ''m''. Matches take up two rows by default. Separate entries with <code>,</code>. Half integer values are allowed. {{!!}}
{{!-}}
{{!}} <code>RDcol<i>mhm</i>-hidetext</code> {{!!}} set to <code>yes</code> to hideenter the (alpha)row ''h''thnumbers headerwhere andadditional alltext matchesis beneath itdesired in column ''m''. unless any of thoseSeparate entries arewith non empty<code>,</code>. UsefulHalf forinteger consolationvalues are matchesallowed. {{!!}}
{{!-}}
{{!}} <code>col<i>m</i>-col<i>m</i>+1-paths</code> {{!!}} enter the starting and ending row numbers, separated by <code>-</code>, from columns ''m'' and ''m''+1 where a path is desired. Separate entries with <code>,</code>. Half integer values are allowed. {{!!}}
Line 79 ⟶ 81:
| <code>minround</code> || first round to display. || <code>1</code>
|-
| <code>autocolheight</code> || setthe toamount <code>yes</code>of tovertical automaticallyvisibility setdesired setfor maximumthe roundbracket. toCreates displaya basedvertical onscroll entriesbar. ||Enter a number with units (e.g., <code>no30em</code> or <code>480px</code>). ||
|-
| <code>col-spacing</code> || the amount of horizontal space between rounds. Enter as a plain number (e.g., <code>10</code> for 10px). || <code>5</code>
|-
| <code>nowrapseed-width</code> || setthe width of the cells for seeds. Plain numbers are assumed to be in px units (e.g., <code>yes25</code> tofor prevent25px textor from<code>2em</code> wrapping.for 2em) || <code>no25</code>
|-
| <code>seed-width</code> || the width of the cells for seeds. Plain numbers are assumed to be in px units (e.g., <code>25</code> for 25px <code>2em</code> for 2em) || <code>25</code>
|-
| <code>team-width</code> || the width of the cells for team names. Plain numbers are assumed to be in px units (e.g., <code>200</code> for 200px or <code>15em</code> for 15em) || <code>150</code>
|-
| <code>score-width</code> || the width of the cells for scores. Plain numbers are assumed to be in px units (e.g., <code>25</code> orfor 25px or <code>2em</code> for 2em) || <code>25</code>
|-
| <code>seedagg-width</code> || the width of the cells for seedsaggregate scores. <code>score-width</code> will change aggregate score widths unless this parameter is used. Plain numbers are assumed to be in px units (e.g., <code>25</code> for 25px or <code>2em</code> for 2em) || <code>25</code>
|-
| <code>seeds</code> || set to <code>no</code> to omit seeds in in all matches. set to <code>yes</code> to show seed cells to show for all matches. ||
Line 97 ⟶ 99:
| <code>autolegs</code> || set to <code>yes</code> to automatically generate score cells per team. If <code>legs</code> or <code>RD<i>m</i>-legs</code> is used, <code>autolegs</code> will be set to <code>no</code> .|| <code>no</code>
|-
| <code>byes</code> || set to <code>yes</code> to hide any team cells that are empty. Alternatively, set to <code>m</code> to have rounds <code>1</code> through <code>m</code> hide any team cells that are empty. Use <code>RD<i>m</i>-byes</code> for alljust matches under column ''m''. Use <code>RD<i>mh</i>-byes</code> for just matches under header ''h'' only in column ''m''. || <code>no</code>
|-
| <code>RD<i>m</i>-hide</code> || set to <code>yes</code> to hide the all matches in columns ''m'' unless any of those entries are non empty. Use <code>RD<i>mh</i>-byes</code> to hide the (alpha) ''h''th header and all matches beneath it in column ''m''. Useful for consolation matches. {{!!}}
|-
| <code>show-bye-paths</code> || set to <code>yes</code> to replace any team cells that that are hidden <code>byes</code> with a path. || <code>no</code>
Line 105 ⟶ 109:
-->
|-
| <code>aggregate</code> || setSet to <code>yessets</code> or <code>legs</code> to addsum anthe aggregatesets/legs scorewon boxand append to the end of the scores. Set to <code>score</code> to sum the scores from each matchset/leg and append to the end of the scores. Set to <code>y</code> or <code>yes</code> to enable the <code>-agg</code> suffix, but without any auto computation. Only matchesworks withwhen there are two or more legs/sets willin showthe round. Any automatically computed value can be overridden by setting the aggregatevalue scoremanually boxwith the <code>-agg</code> suffix for the score. || <code>no</code>
|-
| <code>boldwinner</code> || set to <code>yeshigh</code> to automatically bold the seed/team/score with the higher score in each match. Set to <code>low</code> for the lowest score. Set to <code>aggregate</code> to only bold the higher aggregate score. Set to <code>aggregate-low</code> to only bold the lower aggregate score. || <code>no</code>
|-
| <code>shift</code> || vertically shifts all of the entries by the number entered. Use <code>RD<i>m</i>-shift</code> for individual in columns. || <code>0</code>
Line 129 ⟶ 133:
| <code>RD<i>m</i>-RD(<i>m</i>+1)-path</code>{{efn|name=note1}} || set to <code>no</code> or <code>0</code> to omit the paths from round ''m'' to round ''m''+1. || <code>yes</code>
|-
| <code>paramstyle</code>{{efn|name=note2}} || set to <code>numbered</code> change the parameter name style of <code>RD<i>m</i>-text<i>k</i></code>, <code>RD<i>m</i>-seed<i>k</i></code>, <code>RD<i>m</i>-team<i>k</i></code>, and <code>RD<i>m</i>-score<i>k</i></code> to a numbered notation ({{para|1}},{{para|2}}...). Set {{para|seeds|yes}} add seeds. || <code>indexed</code>
|}
{{notelist|refs=
{{efn|name=note1|Does not currently work for paths under subheaders.}}
{{efn|name=note2|<code>numbered</code> may not be compatible with certain other features, e.g. <code>boldwinner</code> and groups.}}
}}
 
Line 347 ⟶ 351:
| RD1-score1 =
...</nowiki>
{{))}}|lang=moin"wikitext"}}
{{{{#if:{{{limitexamples|}}}|void|{{BASEPAGENAME}}}}|RD1-text1=Text 1|RD1-text2=Text 2|RD2-text1=Text 3}}
}}
Line 393 ⟶ 397:
| RD1-score1 =
...</nowiki>
{{))}}|lang=moin"wikitext"}}
{{{{#if:{{{limitexamples|}}}|void|{{BASEPAGENAME}}}}|RD1-group1=Group 1|RD1-group2=Group 2|RD2-group1=Group 3}}
}}
 
=== Legs and aggregate ===
{{#switch:{{NAMESPACE}}
| Module =
Line 405 ⟶ 409:
| legs = 2
| RD1-legs = 3
| aggregate = y
 
| col1-matches = 3,6,9,12
Line 418 ⟶ 423:
| legs = 2
| RD1-legs = 3
| aggregate = y
 
| col1-matches = 3,6,9,12
Line 431 ⟶ 437:
| legs = 2
| RD1-legs = 3
| aggregate = y
| RD1 =
| RD1-seed1 =
Line 437 ⟶ 444:
| RD1-score1-2=
| RD1-score1-3=
...</nowiki>
{{))}}|lang=moin}}
{{{{#if:{{{limitexamples|}}}|void|{{BASEPAGENAME}}}}|legs=2|RD1-legs=3}}
}}
 
=== Aggregate ===
{{#switch:{{NAMESPACE}}
| Module =
<pre style="overflow: auto;">
{{#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
}}
</pre>
{{#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
}}
|#default =
{{#tag:syntaxhighlight|
{{((}}{{BASEPAGENAME}}<nowiki>
| legs=2
| aggregate=y
| RD1 =
| RD1-seed1 =
| RD1-team1 =
| RD1-score1-1 =
| RD1-score1-2 =
| RD1-score1-agg=
...</nowiki>
{{))}}|lang=moin"wikitext"}}
{{{{#if:{{{limitexamples|}}}|void|{{BASEPAGENAME}}}}|legs=2|RD1-legs=3|aggregate=y}}
}}
 
Line 532 ⟶ 495:
| RD1-score2 =
...</nowiki>
{{))}}|lang=moin"wikitext"}}
{{{{#if:{{{limitexamples|}}}|void|{{BASEPAGENAME}}}}|RD1-byes=y|RD1-team1=Team 1|RD1-team2=Team 2}}
}}
 
<!--=== Numbered parameters ===
{{#switch:{{NAMESPACE}}
| Module =
Line 578 ⟶ 541:
| Text 2 | Team 3 | S3 | Team 4 | S4
...</nowiki>
{{))}}|lang=moin"wikitext"}}
{{{{#if:{{{limitexamples|}}}|void|{{BASEPAGENAME}}}}|paramstyle=numbered|1=Text 1|2=Team 1|3=S1 |4=Team 2|5=S2|6=Text 2|7=Team 3|8=S3|9=Team 4|10=S4}}
}}-->
 
{{#switch:{{NAMESPACE}}
Line 630 ⟶ 593:
* [[Module:Team bracket]]
* [[Module:RoundN]]
* [[Module:Bracket]]
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go here, and interwikis go in Wikidata -->
Line 635 ⟶ 599:
}}</includeonly>
| #default =
==Alternatives to avoid Wikipedia's [[WP:PEIS|Post-expand include size]] limit==
Pages with many brackets or large brackets, especially those containing flag icons, may come close to or exceed Wikipedia's [[WP:PEIS|Post-expand include size]] limit. In these cases consider using modules directly instead:
* {{#invoke:Bracket|doc}}
* In most cases, flag templates can be replaced with {{ml|flag}}, e.g. {{tlx|flag|CAN}}→{{mlx|flag|{{!}}CAN}} or {{tlx|flag athlete|CAN}}→{{mlx|flag|athlete|CAN}}.
 
{{#if:{{{see also|}}}|
== See also ==
Line 640 ⟶ 609:
}}
}}
<noinclude>
[[Category:Module documentation pages]]
</noinclude>