Template:Football box collapsible/doc

This is a documentation subpage for Template:Football box collapsible.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 27,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Football box collapsible (sandbox)

This template uses TemplateStyles:

Template:Football_box_collapsible/styles.css

Usage

This template is meant to be used for abbreviated regular season results with expandable details. The goal with this template is to display only one line of text (when collapsed) for each match. Therefore, avoid using line breaks (<br />) in parameters that are still visible when the box score is collapsed.

Sample:

{{Football box collapsible
|id           = Italy v France
|date         = {{Start date|2006|7|9|df=y}}
|time         = 20:00 [[Central European Summer Time|CEST]] ([[UTC+02:00|UTC+2]])
|round        = [[2006 FIFA World Cup Final|Final]]
|score        = 1–1
|aet          = yes
|report       = https://www.fifa.com/worldcup/matches/round=97410600/match=97410064/index.html
|team1        = {{fb-rt|ITA}}
|goals1       =
* [[Gianluca Zambrotta|Zambrotta]] {{yel|5}}
* [[Marco Materazzi|Materazzi]] {{goal|19}}
|team2        = {{fb|FRA}}
|goals2       =
* [[Willy Sagnol|Sagnol]] {{yel|12}}
* [[Claude Makélélé|Makélélé]] {{yel|76}}
* [[Zinedine Zidane|Zidane]] {{goal|7|pen.}} {{sent off|0|110}}
* [[Florent Malouda|Malouda]] {{yel|111}}
|stadium      = [[Olympiastadion (Berlin)|Olympiastadion]]
|location     = [[Berlin]], Germany
|attendance   = 69,000
|referee      = [[Horacio Elizondo]] ([[Argentine Football Association|Argentina]])
|penaltyscore = 5–3
|penalties1   =
* [[Andrea Pirlo|Pirlo]] {{pengoal}}
* [[Marco Materazzi|Materazzi]] {{pengoal}}
* [[Daniele De Rossi|De Rossi]] {{pengoal}}
* [[Alessandro Del Piero|Del Piero]] {{pengoal}}
* [[Fabio Grosso|Grosso]] {{pengoal}}
|penalties2   =
* {{pengoal}} [[Sylvain Wiltord|Wiltord]]
* {{penmiss}} [[David Trezeguet|Trezeguet]]
* {{pengoal}} [[Éric Abidal|Abidal]]
* {{pengoal}} [[Willy Sagnol|Sagnol]]
}}

Sample result:

9 July 2006 (2006-07-09) Final	Italy	1–1 (a.e.t.) (5–3 p)	France	Berlin, Germany
20:00 CEST (UTC+2)	Zambrotta 5' Materazzi 19'	Report	Sagnol 12' Makélélé 76' Zidane 7' (pen.), 110' Malouda 111'	Stadium: Olympiastadion Attendance: 69,000 Referee: Horacio Elizondo (Argentina)
	Penalties
	Pirlo Materazzi De Rossi Del Piero Grosso		Wiltord Trezeguet Abidal Sagnol

Blank template

All available parameters are shown here.

{{football box collapsible
<!-- recommended or required parameters -->
|id = 
|date = <!-- {{Start date|YYYY|MM|DD|df=y}} -->
|time = 
|round = 
|score = 
|report = 
|team1 = 
|goals1 = 
|team2 = 
|goals2 = 
|stadium = 

<!-- optional parameters -->
|scorenote = 
|aet = <!-- "yes" for extra time -->
|location = 
|attendance = 
|referee = 
|assistantreferees = 
|assistantreferee2 = <!-- rarely used, see explanation -->
|fourthofficial = 
|fifthofficial = 
|goallineassistants = 
|goallineassistant2 = <!-- rarely used, see explanation -->
|aggregatescore = 
|motm = 
|mvp = 
|note = 

<!-- penalty parameters, required if the match went to shootout -->
|penalties1 = 
|penaltyscore = 
|penalties2 = 

<!-- formatting/color parameters -->
|format = <!-- 1 to allow more space for round/date and location -->
|size = <!-- for example 80%, by default 100% -->
|result = <!-- W, L, T/D, V/P -->
|bg = <!-- color without number sign -->
|nobars = <!-- "1" to hide bars -->
|class = <!-- "uncollapsed " for removal of collapse function, "collapsible " for expanded with collapsible option, "collapsible collapsed " for box being initially collapsed (default) -->
}}

Parameters

Required parameters: team1, team2, score (if the match has occurred), and report. Everything else is optional, though goals1, goals2, referee, location, and stadium are highly encouraged wherever this template is used.

Content parameters

attendance - Match attendance as reported in the match report.
date - Date of the match. Use {{Start date}} (with df=y or mf=y; see: WP:ENGVAR)
location & stadium - If location is not specified, the value of stadium will appear at the top of the far right column "above the fold". If location is specified, then only the location value will appear "above the fold" on the right, and the value of stadium will be shown with the prefix "Stadium:" beside it only when the box score is expanded.
goals1 and goals2 - Goals scored and optionally cards issued. Use {{goal}}, {{yel}}, and {{sent off}} with the last name (or professional name) of the player involved. Create a list (lines starting with *) if multiple players are listed. If a player scores more than one goal (or cards) these can be grouped together so that the player's name only appears once. This is not required though. Preference should be given to listing goals (and cards) in chronological order.
penaltyscore - The result of the penalty shootout.
- penalties1 and penalties2 - List of the results of each penalty kick taken. Use {{pengoal}} and {{penmiss}} with the last name (or professional name) of the player taking the kick. Create a list (lines starting with *) if multiple players are listed.
shootoutscore - Alternative syntax for the result of the penalty shootout (changes the label from "penalties" to "shootout")
- shootout1 and shootout2 - Alternative syntax for the results of the shootout.
score - The final score of the match. If the match went into extra time (and possibly penalties) the aet parameter should be set to yes.
aet - Set this parameter to yes if the match went to extra time.
aggregatescore - Optionally, the aggregate score if the match is the second of a two leg tie. Example: |aggregatescore = 4[[Away goals rule|a]]–4, which produces (4a–4 agg.)
time - Time of the match. The local time of the match (local to the stadium it took place in). Either 24h or 12h formats are acceptable.
team1 and team2 - Typically team1 is the home team. Both should be wikilinked to a team page if there is one.
referee - Name of head referee (wikilinked only if there is a page for the referee or you intend to create it soon). The referee's national federation in parenthesis is optional but recommended when the box score is for an international competition.
- assistantreferees, fourthofficial, fifthofficial, & goallineassistants - Further detailed referee information. Same guidelines apply as referee.
  - assistantreferee2 & goallineassistant2 - For use when putting both officials name in the parameter takes too much space. If this field is used, only one referee should be in "assistantreferees" or "goallineassistants", and the other should be in this parameter. An example of a use for this is when putting the national football association which the referees belong, and running out of space.
motm - Man of the match.
mvp - Most valuable player.
report - An external link to an official match report or box score. It is important that match information be referenced, so please use this parameter! (See also: Verifiability and No Original Research)
round - For use when the match is part of a tournament with various rounds of play, such as Preliminary Round, First Round, Group Stage, etc. Wikilinking to the appropriate tournament page/section is recommended.
note - For use when a short explanation is needed. It creates text in italics in the bottom left hand corner.

Formatting Parameters

format - Set to 1 to allow more space for round/date and location, 1.1 and 1.2 are variations of 1 which allow very long team name; 1.1 for team1, and 1.2 for team2
bg - Use this param to specify a custom background color (ignored if result is specified). Use RRGGBB values without the # sign. Example: |bg=99C0B0
id - Unique anchor to the match. Example: |id="Italy v France"
nobars - Set this parameter to 1 if you don't want the one pixel bars to show above and below the template. Example: |nobars=1
result - Adjusts background color to indicate win (green), draw/tie (yellow), loss (red) or void/postponement (grey). Possible values: W, L, T, D, V or P. See the Legend section below when using this parameter.
size - By default Footballbox_collapsible is 100% wide. Use this param to specify a different width. Example: |size=80%
class - Use this if you do not want the template collapsed. The options are "uncollapsed " (removal of collapse function), "collapsible " (box can be collapsed, but by default is not) and "collapsible collapsed " (box is initially collapsed). If unused, the parameter will default to "collapsible collapsed ". Example: |class=collapsible

Legend

Simple coloring legend recommended when an article makes use of result parameter:

{{legend2|#BBF3BB|Win|border=1px solid #AAAAAA}}
{{legend2|#FFFFBB|Draw|border=1px solid #AAAAAA}}
{{legend2|#FFBBBB|Loss|border=1px solid #AAAAAA}}
{{legend2|#BBBBBB|Void|border=1px solid #AAAAAA}} <!-- optional -->
{{legend2|#BBBBBB|Postponed|border=1px solid #AAAAAA}} <!-- optional -->

Which produces:

Win Draw Loss Void Postponed

Note: Given the rarity of voided results and postponements, those entries are optional and can be omitted in most cases.

Microformats

The HTML markup produced by this template includes an hCard microformat, which makes the person's or organisation's name parsable by computers, either acting automatically to catalogue articles across Wikipedia or via a browser tool operated by a reader, to (for example) add the subject to an address book. For more information about the use of microformats on Wikipedia, please see the microformat project.

The hCard in this template uses at least some of these HTML classes:

fn (required)
nickname
org
vcard

Please do not rename or remove these classes nor collapse nested elements which use them.

The HTML mark-up produced by this template includes an hCalendar microformat that makes event details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.

Classes used

The HTML classes of this microformat include:

attendee
contact
description
dtend
dtstart
location
organiser
summary
url
vevent

Please do not rename or remove these classes
nor collapse nested elements which use them.

Tracking

TemplateData

This template displays the summary of a football (soccer) match. The summary include date and time, stadium, competing teams, goal scorers and the minute of goal, a link to the official match report and attendance of the stadium. It also includes whether or not the match went to extra-time or penalty-shoots and displays respective results. It is collapsible.

Template parameters
Parameter		Description	Type	Status
ID	`id`	Unique anchor to the match. Example Italy v France	String	suggested
Date	`date`	Displays the date the match took place. Example 9 July 2006	Date	optional
Time	`time`	Time the match took place. Example 20:00 CEST (UTC+02:00)	String	optional
Round	`round`	The competition round the match belongs to. Example 2006 FIFA World Cup Final	String	suggested
Score	`score`	The match score. Example 1–1	String	suggested
Report	`report`	The URL of a match report. Example https://www.fifa.com/worldcup/matches/round=97410600/match=97410064/index.html#nosticky	URL	required
Team 1	`team1`	First team displayed, usually home team. Example Italy	String	required
Goals 1	`goals1`	The goals (and cards) for the home team. Example [[Marco Materazzi\|Materazzi]] {{goal\|19}}	String	suggested
Team 2	`team2`	Second team displayed, usually guest team. Example France	String	required
Goals 2	`goals2`	The goals (and cards) for the guest team. Example [[Zinédine Zidane\|Zidane]] {{goal\|7}}, {{sent off\|0\|110}}	String	suggested
scorenote	`scorenote`	An optional note clarifying the final score Default no Example Decided by a coin flip Auto value	String	optional
Stadium	`stadium`	The name of the stadium that was played in. Example Olympiastadion	String	suggested
AET	`aet`	Set to "yes" if the match went into extra time. Default no Example yes Auto value	Boolean	optional
Location	`location`	The city the match took place in. Example Berlin, Germany	String	suggested
Attendance	`attendance`	The number of people attending the match. Example 69,000	Number	optional
Referee	`referee`	The referee for the match. Example Horacio Elizondo (Argentina)	Unknown	optional
Assistant Referees	`assistantreferees`	The assistant referees for the match. Example Dario García (Argentina)	String	optional
Assistant Referee 2	`assistantreferee2`	Second assistant referee; rarely used as usually both assistants go in the "assistantreferees" field Example Rodolfo Otero (Argentina)	Unknown	optional
Fourth Official	`fourthofficial`	The fourth official for the match. Example Luis Medina Cantalejo (Spain)	String	optional
Fifth Official	`fifthofficial`	The fifth official for the match. Example Victoriano Giraldez Carrasco (Spain)	String	optional
Goal Line Assistants	`goallineassistants`	The goal line assistants for the match.	String	optional
Goal Line Assistant 2	`goallineassistant2`	Second goal line assistant; rarely used as usually both assistants go in the "goallineassistants" field	String	optional
Aggregate Score	`aggregatescore`	The aggregate score for matches played over two legs.	String	optional
Man of the Match	`motm`	The Man of the Match. Example Andrea Pirlo	String	optional
MVP	`mvp`	The Most Valuable Player	String	optional
Note	`note`	Space for any notes regarding the match.	String	optional
Penalties 1	`penalties1`	The penalties for the home team. Example [[Andrea Pirlo\|Pirlo]] {{pengoal}}	String	optional
Penalty Score	`penaltyscore`	The score in the penalty shoot-out. Example 5–3	String	optional
Penalties 2	`penalties2`	The penalties for the guest team. Example {{pengoal}} [[Sylvain Wiltord\|Wiltord]]	String	optional
Shootout 1	`shootout1`	The shootout goal attempts for the home team. Example [[Andrea Pirlo\|Pirlo]] {{pengoal}}	String	optional
Shootout Score	`shootoutscore`	The score in the penalty shoot-out (alternative to penaltyscore). Example 5–3	String	optional
Shootout 2	`shootout2`	The shootout goal attempts for the guest team. Example {{pengoal}} [[Sylvain Wiltord\|Wiltord]]	String	optional
Format	`format`	Set to 1 to leave more space for round/date and location. Example 1	Number	optional
Size	`size`	Width of the box. Default 100% Example 80%	Number	optional
Result	`result`	Changes the color of the box based on result. Example W, D, L	String	optional
Background	`bg`	Background color. Example red	String	optional
No Bars	`nobars`	Set to 1 to hide bars. Example 1	Number	optional
Class	`class`	Used to uncollapse the box. Example uncollapsed, collapsible, collapsible collapsed	String	optional