Module:Sports table/WL OT/doc

Template:Module rating This style for Lua-based Module:Sports table is meant to build group and league tables for competitions with a win-loss format decided either in regular time or in overtime/shootout. Note that this module is used extensively, so test potential changes rigorously in the sandbox and please ensure consensus exists before implementing major changes. The rest of this documentation explains how to use this module with the WL OT style in an article or template, check the table of contents for specific items.

Usage

Basic usage

In its simplest form only several parameters need to be used to build a table

In article

What you type	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

The main command is the {{#invoke:Sports table|main|style=WL OT}} statement which basically calls the module and enables you to set everything up. Then you list the positions of the teams as Template:Para, Template:Para, etc for however many teams you need in the table. You can use full team names there without spaces if you want, but using codes (as in the example) can make it easier. For each team you now define the wins, OT wins, OT losses, losses, goals for and goals against by using Template:Para, Template:Para, Template:Para, Template:Para, Template:Para and Template:Para respectively (with TTT replaced by the team code). If you do not define these numbers, it is automatically assumed to be 0. It is good practice though to include them anyway and to align the columns using appropriate spaces (as in the example), so the code is easy to read. The last step now is to define the Template:Para parameters which determine what name is shown in the table, you can use wiki markup and templates in here as well. See #Dating to see how to change the update date.

In template

What you type	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

The markup is effectively the same, you only add two lines. The Template:Para parameter is automatically forward from a template call (see #Team highlighting and partial table); the Template:Para is automatically forwarded for truncated tables, (see #Appearance); the Template:Para is automatically forwarded to control match result visibility, see #Matches.

Customization

Several things can be customized in these tables

Points

What you type	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

As a default a win is worth 3 points, an OT win 2 points, an OT loss 1 point and a loss 0 points, these values can be overwritten to what you need by Template:Para, Template:Para, Template:Para and Template:Para. Teams can also start the season with bonus or penalty points, this can be included by using Template:Para for that specific team.

Header options (points for/against and custom other headers)

What you type	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

For sports with points for and against rather than goals, setting Template:Para switches the for, against and difference columns to using points instead. The wording of the OTW and OTL columns can be adjusted using Template:Para andTemplate:Para.

The wording of the Grp (group) column can be adjusted using Template:Para, for example Template:Para.

Goal ratio/goal average

What you type	<syntaxhighlight lang=moin></syntaxhighlight>
What it looks like

Using Template:Para use goal ratio (goal average) instead of goal differential.

Footer options

What you type	{{#invoke:Sports table|main|style=WL OT |update=1 January 1900 |source=[https://en.wikipedia.org/wiki/Main_Page Wikipedia] |team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |name_AAA=Team A |name_BBB=Team B |name_CCC=Team C |name_DDD=Team D |name_EEE=Team E |class_rules=1) points; 2) goal difference; 3) number of goals scored. }}
What it looks like	Pos Team Pld W OTW OTL L GF GA GD Pts 1 Team A 0 0 0 0 0 0 0 0 0 2 Team B 0 0 0 0 0 0 0 0 0 3 Team C 0 0 0 0 0 0 0 0 0 4 Team D 0 0 0 0 0 0 0 0 0 5 Team E 0 0 0 0 0 0 0 0 0 Updated to match(es) played on 1 January 1900. Source: Wikipedia Rules for classification: 1) points; 2) goal difference; 3) number of goals scored.

The footer information can be customized (although notes and status will be inserted automatically if they are called; see XXX and YYY). The update date is set by Template:Para, see below for details. If no source is given a citation-needed tag is shown, Template:Para can provide an actual link. The classification results can be shown with Template:Para, either directly or as a wikilink to a tie-breaker rules section. Using Template:Para suppresses the classification rules (this should only be used in template calls when multiple groups are summarized on a page and the rules are listed elsewhere on that page).

Dating

The default description is match(es), this can be changed by calling Template:Para for any other term.

Active season

What you type	{{#invoke:Sports table|main|style=WL OT |update=1 January 1900 }}
What it looks like

When the season is active, the footer should include the date of the last match played that is included in the table. This can be achieved by setting Template:Para.

Completed season

What you type	{{#invoke:Sports table|main|style=WL OT |update=complete }}
What it looks like

When all matches have been played, the season is completed and the update line can be removed by setting Template:Para.

Future season

What you type	{{#invoke:Sports table|main|style=WL OT |update=future |start_date=1 January 2121 }}
What it looks like

Before any games are played, the date of the first game should be indicated by using Template:Para and setting the start date by Template:Para.

Stacking

Using Template:Para makes the table smaller, which may lead to undesired width and linebreaks in the footer that can be fixed with parameter Template:Para. By setting Template:Para (or y, t, true or 1 or upper case variant of those) every new information, such as "source" and statuses, is displayed on a new row.

Without stack_footer

What you type	{{#invoke:Sports table|main|style=WL OT |only_pld_pts=yes |team1=AAA |name_AAA=The A Team |result1=RRR |status_AAA=DEOPRT |res_col_header=PQR |col_RRR= |text_RRR=Plain text }}
What it looks like

With stack_footer

What you type	{{#invoke:Sports table|main|style=WL OT |only_pld_pts=yes |stack_footer=yes |team1=AAA |name_AAA=The A Team |result1=RRR |status_AAA=DEOPRT |res_col_header=PQR |col_RRR= |text_RRR=Plain text }}
What it looks like

Appearance

What you type	{{#invoke:Sports table|main|style=WL OT |team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |name_AAA=Team A |name_BBB=Team B |name_CCC=Team C |name_DDD=Team D |name_EEE=Team E |only_pld_pts=yes }}
What it looks like

What you type	{{#invoke:Sports table|main|style=WL OT |team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |name_AAA=Team A |name_BBB=Team B |name_CCC=Team C |name_DDD=Team D |name_EEE=Team E |split2=yes |split3= |split5=1 |teamwidth=250 |postitle={{abbr|Exam.|Example}} }}
What it looks like

What you type	{{#invoke:Sports table|main|style=WL OT |team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |name_AAA=Team A |name_BBB=Team B |name_CCC=Team C |name_DDD=Team D |name_EEE=Team E |show_groups=yes |group_AAA=A |group_BBB=A |group_CCC=B |group_DDD=B |group_EEE=C }}
What it looks like

Only the position, team, matches and points columns can be displayed by defining Template:Para (or y, t, true or 1 or upper case variant of those); Template:Para suppresses the classification rules only (this should only be used in template calls when multiple groups are summarized on a page and the rules are listed elsewhere on that page).

A line can be added between section of the table (if desired) by adding Template:Para with N the position below which the bar should be shown. (Note that this bar will not be shown for the bottom position in the table).

A custom width of the team column can be set by Template:Para, for example when multiple groups exist within one tournament and you want to force the same width on all groups.

The position column header can be customized by Template:Para and the position labels by Template:Para for each team.

When multiple a table compares teams from multiple groups, the group can also be listed by setting Template:Para (or y, t, true or 1 or upper case variant of those) and using Template:Para to indicate what teams comes from what group. The group column header can be customized by Template:Para, for example Template:Para.

Team highlighting and partial table

What you type	{{#invoke:Sports table|main|style=WL OT |showteam=DDD |team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |name_AAA=Team A |name_BBB=Team B |name_CCC=Team C |name_DDD=Team D |name_EEE=Team E |show_limit=3 }}
What it looks like

When using a table on a team (season) page, you might want to highlight the team (and possibly only show part of the table), especially after a template call to a long league table. Team TTT is highlighted by Template:Para. A limited part of the table is shown by Template:Para, with the number indicating the number of position to show (if this is an even number, and it is in the middle of the table, then this number will be rounded up to the next odd number to show symmetry above and below).

A table can also start at position N, by using Template:Para in the module call.

Results and status

Indicating results

What you type

{{#invoke:Sports table|main|style=WL OT |team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |result1=WC |result2=PO |result3=PO |result4=RPO |result5=rel |name_AAA=Team A |name_BBB=Team B |name_CCC=Team C |name_DDD=Team D |name_EEE=Team E |res_col_header=QR |col_WC=green1 |text_WC=Qualification to [[World Cup]] |col_PO=blue1 |text_PO=Qualification to play-offs |col_RPO=red2 |text_RPO=Qualification to relegation play-offs |col_rel=red1 |text_rel=Relegation to lower division }}

What it looks like

The result of the table rankings can be indicated by a coloured bar and text indicating the result. The header of this column is defined by Template:Para with predefined values of Q, QR, P, PQR, PR and R (indicating various combinations of promotion, qualification and relegation), any other entry than these exact codes will print as that entry in the column header. With N the position Template:Para declares the codes (or words if you want that instead) for the results column. Now when RRR is the results column, the colours are defined by Template:Para. The colours green1, green2, green3, green4, blue1, blue2, blue3, blue4, yellow1, yellow2, yellow3, yellow4, red1, red2, red3, red4, black1, black2, black3 and black4 are predefined and should be used preferentially per consensus on WT:FOOTY (you can use either html colours, or RGB colour codes instead if you must [this is not recommended though, because it might violate WP:COLOR]). The text in the results column is now give by Template:Para, which can (and should) link to the relevant competition articles.

Consensus is also to use the colours in the following way: Green should be used for the top-level positive event (promotion, qualification, advancing to next round), blue for the second-level positive events (promotion play-offs when direct promotion exists, play-offs when direct qualification exist, secondary continental tournament), red for bottom-level negative events (relegation) and yellow for other level events. In addition, lower level colours should be used when teams qualify for different rounds (with lower levels corresponding to entry in lower rounds [green1 first, then green2, etc].) Black should be used when teams do not play a full season and their results are expunged or void. This consensus exists to have a uniform table appearance across Wikipedia. In addition, some wikiprojects have more detailed guidelines:

• Football colour guidelines

Colour options

Green	green1	green2	green3	green4
Blue	blue1	blue2	blue3	blue4
Yellow	yellow1	yellow2	yellow3	yellow4
Red	red1	red2	red3	red4
Black	black1	black2	black3	black4
Orange	orange1	orange2	White	white1

Indicating status

What you type	{{#invoke:Sports table|main|style=WL OT |status_pos=after |team1=AAA |result1=RRR |status_AAA=ABCDEFGHIJKLMNOPQRSTUVWXYZ |name_AAA=Team A |res_col_header=PQR |col_RRR= |text_RRR=Plain text |status_text_X=Custom 1 |status_text_Y=Custom 2 |status_text_Z=Custom 3 }}
What it looks like

What you type	{{#invoke:Sports table|main|style=WL OT |status_pos=before |team1=AAA |status_AAA=ABCDEFGHIJKLMNOPQRSTUVWXYZ |name_AAA=Team A |status_text_X=Custom 1 |status_text_Y=Custom 2 |status_text_Z=Custom 3 }}
What it looks like

The promotion/qualification/relegation status of a team can be indicated by Template:Para with the letters indicated above (although only the ones in use for this style are shown below the table). The letters will appear next to the team in the order given. Whichever letters are called out in the table will automatically be explained alphabetically in the footer.

These letters can be used for all scenarios as exemplified by the following group phase example with 4 teams that play 3 matches where the first advances directly, the second team will go to play-offs and the remaining two teams are eliminated:

• Teams start out without status letter
• Teams that get eliminated get status (E)
• Teams that can still finish worse than second (and might be eliminated) will remain without status
• Teams that will finish at least second will get status (T)
• Teams that will finish for sure second will get status (Q)
• Teams that will finish for sure first will get status (A)

If these scenarios are not sufficient, some style have wild letters L (marked with a question mark in the overview). They should be accompanied by Template:Para to indicate a non-standard status.

Most styles allow for these letter to be placed after the team name or before, set Template:Para or Template:Para respectively, the default value can differ and its use differs between sports or regions.

Notes

What you type

{{#invoke:Sports table|main|style=WL OT |team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |result1=WC |result2=PO |result3=PO |result4=RPO |result5=rel |note_AAA=Team note |note_BBB=AAA |hth_BBB=Team 2 wins head-to-head against team 3 |hth_CCC=BBB |note_DDD=EEE |name_AAA=Team A |name_BBB=Team B |name_CCC=Team C |name_DDD=Team D |name_EEE=Team E |res_col_header=QR |note_header_res=Header note |col_WC=green1 |text_WC=Qualification to [[World Cup]] |note_res_WC=Result note |col_PO=blue1 |text_PO=Qualification to play-offs |col_RPO=red2 |text_RPO=Qualification to relegation play-offs |note_res_RPO=WC |col_rel=red1 |text_rel=Relegation to lower division }}

What it looks like

When notes are present, they are automatically added to the footer. The following notes are available for teams with Template:Para for a note for a team, when this note is a team code with a defined notes, they will share the note. Results can have notes with Template:Para and the result header can have a note with Template:Para. Head-to-head result tiebreakers are listed in the points column and can be inserted with Template:Para, which can be shared between teams as with all-purpose notes.

Matches

What you type

{{#invoke:Sports table|main|style=WL OT |show_matches=true |team1=AAA |team2=BBB |team3=CCC |team4=DDD |team5=EEE |name_AAA=Team A |short_AAA=AAA |name_BBB=Team B |short_BBB=BBB |name_CCC=Team C |short_CCC=CCC |name_DDD=Team D |short_DDD=DDD |name_EEE=Team E |short_EEE=EEE |match_AAA_BBB=1–0 |match_AAA_CCC=0–1 |match_AAA_DDD=<small>16 Nov '14</small> |match_AAA_EEE=<small>3 Sep '15</small> |match_BBB_AAA= |match_BBB_CCC=<small>3 Sep '15</small> |match_BBB_DDD=B–D |match_BBB_EEE=<small>3 Sep '15</small> |match_CCC_AAA=<small>16 Nov '14</small> |match_CCC_BBB=C–B |match_CCC_DDD=<small>16 Nov '14</small> |match_CCC_EEE=C–E |match_DDD_AAA=D–A |match_DDD_BBB=<small>3 Sep '15</small> |match_DDD_CCC=D–C |match_DDD_EEE=<small>3 Sep '15</small> |match_EEE_AAA= |match_EEE_BBB=9–5 |match_EEE_CCC=<small>16 Nov '14</small> |match_EEE_DDD=E–D |match_EEE_DDD_note=Pitch was taken by [[Martian|Martians]], the match will be played in [[Iani Chaos]] instead. }}

What it looks like

The match list can be added by displayed by defining Template:Para (or y, t, true or 1 or upper case variant of those). The column headers for the match results are defined by Template:Para for team TTT. The results for the game TTT vs. SSS can now be input by Template:Para. Future games can be listed with their date (possibly between small tags) or they can be left blank. (Note that this calls Module:Sports results to build the match table.) A note can be added to a result using Template:Para, this note can be shared with team TTT note by setting Template:Para when Template:Para is set. The width of the match columns can be customized by setting Template:Para to the desired width.

Template:When pagename is

Example usage

The module parameters can be arranged in different orders depending on the editor and article but below is an example use that can be copied when creating a module table.

What you type

<syntaxhighlight lang=moin> Pos Team Pld W D L GF GA GD Pts Promotion, qualification or relegation 1 A team (C, Q) 0 0 0 0 0 0 0 0 Promotion to 2 B team (C) 0 0 0 0 0 0 0 0 Qualification to 3 C team (A) 0 0 0 0 0 0 0 0 Advance to 4 D team (T) 0 0 0 0 0 0 0 0 Qualification to 5 E team 0 0 0 0 0 0 0 0 Qualification to 6 F team 0 0 0 0 0 0 0 0 7 G team 0 0 0 0 0 0 0 0 8 H team 0 0 0 0 0 0 0 0 Qualification to 9 I team 0 0 0 0 0 0 0 0 10 J team 0 0 0 0 0 0 0 0 11 K team 0 0 0 0 0 0 0 0 Qualification to 12 L team (R) 0 0 0 0 0 0 0 0 Relegation to First match(es) will be played on Unknown. Source: Unknown Rules for classification: 1) Points; 2) Goal difference; 3) Number of goals scored; (A) Advance to a further round; (C) Champion; (Q) Qualified to the phase indicated; (R) Relegated; (T) Qualified, but not yet to the particular phase indicated </syntaxhighlight>

What it looks like

Pos Team Pld W OTW OTL L GF GA GD Pts Promotion, qualification or relegation 1 A team (C, Q) 0 0 0 0 0 0 0 0 0 Promotion to 2 B team (Q) 0 0 0 0 0 0 0 0 0 Qualification to 3 C team (A) 0 0 0 0 0 0 0 0 0 Advance to 4 D team (T) 0 0 0 0 0 0 0 0 0 Qualification to 5 E team 0 0 0 0 0 0 0 0 0 Qualification to 6 F team 0 0 0 0 0 0 0 0 0 7 G team 0 0 0 0 0 0 0 0 0 8 H team 0 0 0 0 0 0 0 0 0 Qualification to 9 I team 0 0 0 0 0 0 0 0 0 10 J team 0 0 0 0 0 0 0 0 0 11 K team 0 0 0 0 0 0 0 0 0 Qualification to 12 L team (R) 0 0 0 0 0 0 0 0 0 Relegation to First match(es) will be played on Unknown. Source: Unknown Rules for classification: 1) Points; 2) Goal difference; 3) Number of goals scored; (A) Advances to a further round; (C) Champion; (Q) Qualified to the phase indicated; (R) Relegated; (T) Qualified, but not yet to the particular phase indicated