Module:RoundN/doc: Difference between revisions

Revision as of 10:36, 27 August 2021

Latest revision as of 22:30, 6 June 2024

(13 intermediate revisions by 6 users not shown)

Line 1:

{{Module rating |release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}

<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

{{High-use}}

{{Module rating |release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}

== Usage ==

This is a module for meta templates such as {{tl|Round16}}, {{tl|Round8}}, etc. Though originally designed for sports, it can be used to present any tree.

Line 9 ⟶ 11:

Alternatively, the shorthand form <code><nowiki>{{#invoke:RoundN|N16}}</nowiki></code> (or any power of 2 between N2 and N512) is equivalent to {{code|<nowiki>{{#invoke:RoundN|main|columns = 4}}</nowiki>}}

==Parameter Listlist==

*{{red|red}} parameter names are required.

*''italicized'' parameter names are required in some cases

Line 48 ⟶ 50:

{{Module talk:RoundN/testcases/1|param=style|style=width:20em;font-size:70%}}

To center-align the whole block, use <code>style=margin:auto;</code>

|-

Line 154 ⟶ 158:

|color=yes

|3rdplace=yes

|7|GoldTeam medalistA|3|SilverTeam medalistB|2

|8|BronzeTeam medalistC|1|Team D|0

}}

* '''Note:''' When <code><nowiki>|color=yes</nowiki></code> 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 <code><nowiki>|color=yes & |bold_winner=high</nowiki></code> for colored brackets when the winner is the ''highest scorer''.

{{#invoke:RoundN|main|columns=1

|bold_winner=high

|color=yes

|3rdplace=yes

|7|Silver medalist|2|Gold medalist|3

|8||0|Bronze medalist|1

}}

----

Add <code><nowiki>|color=yes & |bold_winner=low</nowiki></code> for colored brackets when the winner is the ''lowest scorer''.

{{#invoke:RoundN|main|columns=1

|bold_winner=low

|color=yes

|3rdplace=yes

|7|Gold medalist|2|Silver medalist|3

|8|Bronze medalist|0||1

}}

|-

|style='text-align:center;vertical-align:top'|{{TOC tab|color_repechage}}

|style='background-color:#fff'|Add <code><nowiki>|color_repechage=yes</nowiki></code> for repechage brackets, where the winner is awarded a bronze medal.

{{#invoke:RoundN|main|columns=1

|color_repechage=yes

|7|Team A|3|Team B|2

}}

* '''Note 1:''' When <code><nowiki>|color_repechage=yes</nowiki></code> 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 <code><nowiki>|color_repechage=yes</nowiki></code> 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 <code><nowiki>|color_repechage=yes & |bold_winner=high</nowiki></code> for colored brackets when the winner is the ''highest scorer''.

{{#invoke:RoundN|main|columns=1

|bold_winner=high

|color_repechage=yes

|7|Team A|3|Team B|2

}}

----

Add <code><nowiki>|color_repechage=yes & |bold_winner=low</nowiki></code> for colored brackets when the winner is the ''lowest scorer''.

{{#invoke:RoundN|main|columns=1

|bold_winner=low

|color_repechage=yes

|7|Team A|3|Team B|2

}}

----

Add <code><nowiki>|color_repechage=yes & skip the final match of the brackets</nowiki></code> for colored brackets when there are two bronze medalists.

{{#invoke:RoundN|main|columns=3

|bold_winner = high

|color_repechage = yes

|flex_tree = yes

|skipmatch = 2;4;7

|omit_blanks = yes

|RD1 = Repechage

|RD2 = Bronze medal

|RD3 = omit_label

|1|Team A|3|Team B|2

|2|Team C|6|Team D|5

|3|Team A|8|Team E|7

|4|Team C|10|Team F|11

}}

Line 180 ⟶ 248:

|-

|style='text-align:center;vertical-align:top'|{{TOC tab|templateflex_tree}}

|style='background-color:#fff'|Set <code>|templateflex_tree=yes</code> ifto usedmake tothe createbrackets avertically templatemore forcompact. aThat specificis, gameto (addhave V.T.E.less space between matches of linkthe usingsame {{tl|navbar}})round.

{{#invoke:RoundN|N4

| 3rdplace = no

| flex_tree = yes

}}

|-

|style='text-align:center;vertical-align:top'|{{TOC tab|flex_treeshort_brackets}}

|style='background-color:#fff'|Set <code>|flex_treeshort_brackets=yes</code> to make the brackets horizontally more compcatcompact. That is, to have less space between matches of the samefollowing roundrounds.

{{#invoke:RoundN|N4

| 3rdplace = no

*| short_brackets = yes

}}

|}

Line 212 ⟶ 286:

===Partial List of undocumented params===

*no_column_head

*short_brackets

*branch_upwards

Line 219 ⟶ 292:

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

<!-- Categories below this line, please; interwikis at Wikidata -->

[[Category:Sports modules]]

}}</includeonly>