Module:Sports series/doc

This is a module for generating match results for a sports series, such as a two-legged tie. However, the module can support single-match ties up to an unlimited number of legs. The template supports domestic and international club matches, as well as national team matches. While deisgned for association football, it can be used for any sport that features a series between teams.

Usage
In its simplest form, only a few parameters are needed to build a table.

International club football
For two-legged ties in international club football, seven parameters are expected to be passed for each row. This includes each club's name and national association country name/code, the aggregate score and the score of both legs.

Domestic club football
For two-legged ties in domestic club football, five parameters are expected to be passed for each row. This includes each club's name, the aggregate score and the score of both legs.

National team football
For two-legged ties in national team football, five parameters are expected to be passed for each row. This includes each national team's name/code, the aggregate score and the score of both legs.


 * Men


 * Women

International club football

 * Usage


 * Output

Domestic club football

 * Usage


 * Output

Men's national team football

 * Usage


 * Output

Women's national team football

 * Usage


 * Output

Parameter list
Below is a full list of template parameters. All parameters are optional.

{| class="wikitable" style="width:75%" ! Parameter name ! Description ! Type




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Determines the type of competition to be featured. Valid values are  (default, for club competitions) or   (for national team competitions).

Using  instead of   allows for the default flag template being changed to fbw without setting flag. Using  acts as an alias for. Note that while the documentation will make mention of what setting NT does to the output, it will be equally true for also setting it to  or.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Determines the flag icon template which will be used in the table. The default for club is fbaicon, the default for NT is fb, and the default for WNT is fbw. If set to a negative value (e.g. n, no, 0), no flags will be displayed for club (this will have no impact if NT). For NT, the text "-rt" is always added to the end of the template name for the first team column, allowing for the flag to be aligned to the right side of the cell.

For club, flags are displayed next to club names, while for NT the national team codes/names are wrapped into the national team flag template. To support national team flag templates that use the first parameter to pass a special value (e.g. for youth team templates, such as fbu which passes the age level), use a "+" in between the template name and the first parameter value (e.g. fbu+17 generates code for ).

If the flag template passed through the parameter does not exist, the module will revert to the default values for club or NT.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Determines the number of legs that will be displayed in the table, and how many scores are expected to be passed to each row. The default is . If set to a negative value (e.g. n, no, 0), the table will display no legs and will be formatted to display the results of single-leg ties (the aggregate column header will then be changed to "Score").

Example 1

 * Usage


 * Output

Example 2

 * Usage


 * Output


 * style="background-color:#fff"|Number




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|To enable, set to a positive value (e.g. y, yes, 1). Automatically bolds the winning team of the tie. First priority is given to the winning team of scores listed inside brackets (which is commonly used to denote the results of a penalty shoot-out). Otherwise, the regular score will be used. If the aggregate scores are level (such as ties decided on away goals) or no winner can be determined based on the input, neither team in a given tie will be bolded.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|To enable, set to a positive value (e.g. y, yes, 1). Automatically colors the winning team of the tie with a background color of . First priority is given to the winning team of scores listed inside brackets (which is commonly used to denote the results of a penalty shoot-out). Otherwise, the regular score will be used. If the aggregate scores are level (such as ties decided on away goals) or no winner can be determined based on the input, neither team in a given tie will be colored.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|To enable, set to a positive value (e.g. y, yes, 1). If set, it collapses the table using mw-collapsed. This results in the table being spread across the entire width of the page.

Example 3

 * Usage


 * Output


 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Adds a caption to the table.

Example 4

 * Usage


 * Output


 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Adds a title to the table in the form of a table header spanning all columns, placed above the standard column headings.

Example 5

 * Usage


 * Output


 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Adds an anchor to the top of the table which allows direct linking to the table.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|To enable, set to a positive value (e.g. y, yes, 1). Adds a nowrap value to the table style.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|To enable, set to a positive value (e.g. y, yes, 1). Adds a placeholder flag icon to the space next to a team's name when flag parameters are present in the table, but the parameter for a given team is left blank (for club) or does not contain a flag (for NT). This will have no impact if false.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Set to an integer value for the width of the two team columns, in pixels. Default is.
 * style="background-color:#fff"|Number




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Set to an integer value for the width of the aggregate score column and each leg score column, in pixels. Default is.
 * style="background-color:#fff"|Number




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Adds a custom heading for the first team column. Default is.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Adds a custom heading for the second team column. Default is.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|To enable, set to a positive value (e.g. y, yes, 1). Changes the default column headers for the teams to "Home" and "Away". If team1 and/or team2 is set, those respective parameter(s) will override headers set by h_a.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Adds a custom heading for the aggregate score column. Default is, unless legs is set to a negative value (e.g. n, no, 0), for which the default will be.
 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Adds a custom heading for the Nth leg column (e.g. leg1 for the first leg column, leg3 for the third leg column, etc.). Default is  (e.g.   for the first leg column,   for the third leg column, etc.).

Example 6

 * Usage


 * Output


 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Changes the format of the leg score column headings. Instead of using " leg", now the format will be " N". Any string can be specified through the parameter to add as a custom prefix. However, when set only to a positive value (e.g. y, yes, 1), the output will default to . If legN is set, this will replace the Nth leg score column heading, overriding the custom prefix.

Example 7

 * Usage


 * Output

Example 8

 * Usage


 * Output


 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Adds a custom suffix after the ordinal for the leg score column headings. Default is . If legN is set, this will replace the Nth leg score column heading, overriding the custom suffix. In addition, leg_prefix takes precedence over leg_suffix.

Example 9

 * Usage


 * Output


 * style="background-color:#fff"|String




 * style="text-align:center;vertical-align:top"|
 * style="background-color:#fff"|Adds a custom heading spanning all columns above the Nth row of the table (e.g. heading1 for above the first row, heading20 for above the twentieth row, etc.).

Example 10

 * Usage


 * Output


 * style="background-color:#fff"|String


 * }

Other features/notes
Please note that in order to display a row in the table, at least one cell of said row must have value that is not empty or whitespace. Otherwise, the module will not create a row for that line and all others below it.

Team names/codes
For club, the country codes supplied for each club are by default wrapped into fbaicon, based on Wikipedia's country data system of templates, and displayed next to each team.

For NT, the national team names/codes supplied are by default wrapped into fb and fb-rt, based on Wikipedia's country data system of templates.

Leg scores
If a cell of one of the leg scores contains only, the cell will not be generated. This is useful for rounds of competitions that have an inconsistent number of legs, for example competitions that have a possible replay or play-off match after two legs.


 * Usage


 * Output

Plus sign (+) for flag templates/youth level
Some youth national team flag templates, such as fbu, have an additional parameter to pass the age level to be linked within to template. To accomodate, this module supports within the flag parameter the use of a plus sign (+) in between the name of the flag template and the age level. For example, fbu+17 will generate a flag template in the form of. This only applies for NT. If the portion before the plus sign is a negative value (e.g. n, no, 0), the default flag template (fb) will be used.


 * Usage


 * Output

Plus sign (+) for country codes/flag variants
To allow for the use of flag variants, this module supports within country parameters (the country code parameter for club, or the national team name/code parameter for NT), the use of a plus sign (+) in between the country name/code and the name of the flag variant.


 * Usage 1


 * Output 1


 * Usage 2


 * Output 2

Asterick (*) for strings instead of national teams
By default, when NT is set, the team parameters wrap into a flag template. However, it may be desired to pass a plan string to the template without a flag icon, for example as placeholder text for a team that will advance from a prior round. In this case, starting the team parameter with an asterick (*), followed by the text to be displayed, will result in the text showing in that team's cell instead of being wrapped into a flag template. If fill_blanks is set to a positive value (e.g. y, yes, 1), a placeholder flag will also be displayed.


 * Usage 1


 * Output 1


 * Usage 2


 * Output 2

Three apostrophes ( ''' ) for manual bolding
While the template allows for automatic bolding of winning teams via y, in some situations (such as matches tied on away goals) the module will be unable to determine the winner. Or, some users may find it undesirable to use bold_winner to determine the winner automatically. In these cases, manual bolding can be used to indicate the winning team of a tie. This is simple to do for club, by placing the three apostrophes before and after the name of the team. Additionally, the module supports using three apostrophes around both sides of the national team name/code for NT. If bold_winner is set, the team that is manually bolded will override the winning team as determined by the module. If color_winner is also set, the cell of the team that is manually bolded will also be colored.

This may be used in conjunction with the below method by using five apostrophes on either side of a team to bold and color the cell.


 * Usage 1


 * Output 1


 * Usage 2 (third row overrides bold_winner)


 * Output 2 (third row overrides bold_winner)

Two apostrophes ( '' ) for manual coloring
While the template allows for automatic coloring of the cells of winning teams via y, in some situations (such as matches tied on away goals) the module will be unable to determine the winner. Or, some users may find it undesirable to use color_winner to determine the winner automatically. In these cases, manual coloring can be used to indicate the winning team of a tie. This is simple to do for club, by placing the two apostrophes before and after the name of the team. Additionally, the module supports using two apostrophes around both sides of the national team name/code for NT. If color_winner is set, the cell of team that is manually colored will override the winning team as determined by the module. If bold_winner is also set, the cell of the team that is manually colored will also be bolded.

This may be used in conjunction with the below method by using five apostrophes on either side of a team to color and bold the cell.

(Note: While two apostrophes surrounding both sides of text are usually used to add italics in wikitext, the usage was modified here to allow for a simple way to color the cell. Therefore, it is not possible to italicize team names using this formatting.)


 * Usage 1


 * Output 1


 * Usage 2 (third row overrides color_winner)


 * Output 2 (third row overrides color_winner)