Doku
-
- vor 3 Jahren zuletzt von Systembenutzer bearbeitet
-
Dies ist die Dokumentationsseite für Modul:RoundN
Inhaltsverzeichnis
Usage
This is a module for meta templates such as Vorlage:Tl, Vorlage:Tl, etc. Though originally designed for sports, it can be used to present any tree.
Basic form:
{{#invoke:RoundN|main|columns = [number of columns (3 columns for Round8, 4 columns for Round16, etc.)]}}
Alternatively, the shorthand form {{#invoke:RoundN|N16}}
(or any power of 2 between N2 and N512) is equivalent to Vorlage:Code
Parameter List
- Vorlage:Red parameter names are required.
- italicized parameter names are required in some cases
- Vorlage:Blue parameter names involve new features not available prior to the release of this module
Parameter name | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Vorlage:TOC tab | Number of columns/eliminations (3 columns for Round8, 4 columns for Round16, etc.)
Note
Vorlage:TOC tab
While required for invoking the main function ( PS: Though adding shorthands up to N ~70 trillion would be easy, it would make unnecessary overhead as these meta functions are generated eached time this module is called (granted generating such functions up to ~70 trillion is probably less expensive than making the table for columns = 3). | |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Unnamed parameters (i.e. a value not prefixed by [param_name] = ) are read sequentially in groups of 5 such that:
Example 1Vorlage:Demo
Placing each group of 5 on a new line is optional, but does make it easier to read. Also, consider adding the comments such as | |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Set the style parameter to add custom CSS to the table.
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | For large tables, set Vorlage:Code to the desired height in pixels.
Modul Diskussion:RoundN/testcases/1 CSS units are also allowed (i.e. '20em', '30%', etc.). Note This works by duplicating the entire table and then using CSS to lock the clone of the table to the top of the div. Conceivably, for extremely large tables, this can result in a significant amount of extra HTML code to download versus if Vorlage:Code is used. | |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | If it is desirable to have the round heading scroll with the table (such as if a larger viewing area is desired), set Vorlage:Code to 'yes' | |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | If set, boxes for the #th match group will not be shown. Most often used for playoffs or when the number of teams playing in the first round is not a power of 2.
Modul Diskussion:RoundN/testcases/1
Vorlage:TOC tab:
The shorthand |skipmatch1=yes |skipmatch2=yes |skipmatch4=yes |skipmatch6=yes |skipmatch7=yes Note:
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | If omit_blanks is set to yes, then all parameters that would have been skipped will instead be shifted to the next non-skipped box. (This is turned off by default because most templates made before the release of this module were required to use empty parameters as placeholders.)
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | The Vorlage:Code parameter accepts either Vorlage:Code or Vorlage:Code, which will automatically bold the text of the participant with the higher or lower score, respectively. In other words, set this to 'low' if the lower score wins and 'high' if the high score wins.
Example 2Modul Diskussion:RoundN/testcases/2 Note:
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab |
Modul Diskussion:RoundN/testcases/2
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab |
Set Note that these numbers will not appear in article space. | |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Use RD# , replacing # with the desired column such that 1 is the leftmost round and X is the rightmost when columns = X . For example:
Vorlage:Demo
Note RD[N+1] = Third Place, and will perform the job of the | |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | By default, |3rdplace= is set to 'yes' when columns is greater than 3 and 'no' otherwise. Override as desired. (See Consol if you wish to rename this heading)
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Set Consol=name to change the 'Third Place' label to 'name'. You may also use the form RD# where # = columns + 1.
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Add |color=yes
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Set team-width to the desired width in pixels. (Default is 170)
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Set score-width to the desired width in pixels. (Default is 30)
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Setting |widescore=yes is basically equal to |score-width=40 . Provided for compatibility. Ignored if score-width is set.
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Set score-boxes to the desired number of score boxes per match. (Default is 1). The number can be followed by + sum , which will add one more score box with the sum of all the others. For examples, see test case 5 and test case 6.
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Set |template=yes if used to create a template for a specific game (add V.T.E. link using Vorlage:Tl).
| |||||||||||||||||||||||||||||||||||||
Vorlage:TOC tab | Set |flex_tree=yes to make the brackets more compact. That is, to have less space between matches of the same round.
|
Node Functions
For greater customization, node functions may be added to the parameter usually used for providing match information such as dates and location. Simply insert node_function{function name}
in the appropriate location. A demonstration of most of the node functions can be found at RoundN/testcases/4.
- orphan - Current node is disconnected from all other nodes (no lines will be drawn). One practical use for this may be when the winners of the previous round advance to a different tournament instead of playing each other but the losers still play a consolation match for 3rd place, as per this discussion.
For the next three node functions, the parameters usually used for team names and scores should be omitted if these node functions are used.
- line - Current node is omitted and replaced with a horizontal line. Text may be displayed above this line via
node_function{line(text)}
(at some point, the preferred format would benode_function{line}text
to match the form of the canvas function though backwards compatibility would probably be maintained). If curly brackets are desired in the text, make sure to escape them with\
. - bridge - Current node is omitted and replaced with a vertical line.
- canvas - Current node is replaced with whatever you want via
node_function{canvas}anything
- heading - Not yet implemented. Planned node function with the form
node_function{heading(name)}date/location
. Makes a round name heading like for the Consol parameter, but may be placed anywhere, as per the "Elimination Rounds" of RoundN/testcases/6 (which currently renders the planned output of this function without the functions).
Undocumented features
Alas User:Codehydro seriously overbuilt this module and never found the time to document even half the features available. Check out the following examples which may contain some advanced features: Spezial:PrefixIndex/Module talk:RoundN/testcases
Partial List of undocumented params
- no_column_head
- short_brackets
- branch_upwards
Note that some of these features may not have been documented due to incomplete implementation.