View source for Template:Football box collapsible/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<includeonly>{{Intricate template}}</includeonly>

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

'''Sample:'''
<pre style="overflow:auto">
{{football box collapsible
|date = {{Start date|2217|07|06|df=y}}
|time = 20:00
|round = [[World Cup 70 Final]]
|team1 = {{fb-rt|FEL}}
|score = 1–2 
|report = [[nspost:23126928|Report]]
|team2 = {{fb|OSR}}
|goals1 = [[Luca Esser|Esser]] {{goal|39}}
|goals2 = [[Emanuele Riviello|Riviello]] {{goal|28}}<br />[[Ezio Grassi|Grassi]] {{goal|84}}
|stadium = [[Royal Equestria Stadium]]
|competiton = default
|location = [[Canterlot]], [[Equestrian States]]
|attendance = 98,625
|referee = Gareth Schwarzer ({{subst:nfa|NPH}})
|assistantreferees = Jayce Wilhelm ({{subst:nfa|NPH}})
|assistantreferee2 = Markus Crossley ({{subst:nfa|NPH}})
|fourthofficial = Joel Martín Águila Nena ({{subst:nfa|SJG}})
|fifthofficial = Mathias Morrison ({{subst:nfa|YTT}})
|goallineassistants = 
|goallineassistant2 = 
|aggregatescore = 
|mvp = 
|note = 
|motm = [[Ezio Grassi]]
|size = 100%
|result = 
|bg = 
|nobars = 
|stack = 
|class = "collapsible collapsed"
}}</pre>

'''Sample result:'''

{{football box collapsible
|date = {{Start date|2217|07|06|df=y}}
|time = 20:00
|round = [[World Cup 70 Final]]
|team1 = {{fb-rt|FEL}}
|score = 1–2 
|report = [[nspost:23126928|Report]]
|team2 = {{fb|OSR}}
|goals1 = [[Luca Esser|Esser]] {{goal|39}}
|goals2 = [[Emanuele Riviello|Riviello]] {{goal|28}}<br />[[Ezio Grassi|Grassi]] {{goal|84}}
|stadium = [[Royal Equestria Stadium]]
|competiton = default
|location = [[Canterlot]], [[Equestrian States]]
|attendance = 98,625
|referee = Gareth Schwarzer ([[Nepharim Football Association|Nephara]])
|assistantreferees = Jayce Wilhelm ([[Nepharim Football Association|Nephara]])
|assistantreferee2 = Markus Crossley ([[Nepharim Football Association|Nephara]])
|fourthofficial = Joel Martín Águila Nena ([[Federación Guayabalense de Fútbol|San Jose Guayabal]])
|fifthofficial = Mathias Morrison ([[Yttribian Football Federation|Yttribia]])
|goallineassistants = 
|goallineassistant2 = 
|aggregatescore = 
|mvp = 
|note = 
|motm = [[Ezio Grassi]]
|size = 100%
|result = 
|bg = 
|nobars = 
|stack = 
|class = "collapsible collapsed"
}}

==Blank template==

All available parameters are shown here.
<pre style="overflow:auto">
{{football box collapsible
<!-- recommended or required parameters -->
|date = <!-- {{Start date|YYYY|MM|DD|df=y}} -->
|time = 
|round = 
|team1 = 
|score = 
|report = <!-- [ Report] -->
|team2 = 
|goals1 = 
|goals2 = 
|stadium = 

<!-- optional parameters -->
|aet = <!-- "yes" for extra time -->
|competition = <!-- "default" (default), "Cascadia Cup", "SuperClasico" -->
|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 -->
|size = <!-- for example 80%, by default 100% -->
|result = <!-- the following are based on the parameter "competition" --><!-- default: W, L, T/D, V/P --><!-- Cascadia Cup: V/VAN, S/SEA, P/PDX, T/D, VOID/POST --><!-- SuperClasico: LA, CHIVAS, T/D, V/P -->
|bg = <!-- color without number sign -->
|nobars = <!-- "1" to hide bars -->
|stack = <!-- "yes" with multiple boxscores stacked together.  Hides the bar at the bottom avoiding double lines between boxscores. -->
|class = <!-- "uncollapsed " for removal of collapse function, "collapsible " for expanded with collapsible option, "collapsible collapsed " for box being initially collapsed (default) -->
}}
</pre>

== 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 {{TL|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 {{tl|goal}}, {{tl|yel}}, and {{tl|sent off}} with the last name (or professional name) of the player involved.  Place a line break '''&lt;br&gt;''' between each player 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 {{tl|pengoal}} and {{tl|penmiss}} with the last name (or professional name) of the player taking the kick.  Place a line break '''&lt;br&gt;''' between each player listed.
*'''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: '''<code><nowiki>|aggregatescore = 4[[Away goals rule|a]]–4</nowiki></code>''', which produces <span  style="font-size: 85%">('''4[[Away goals rule|a]]–4''' [[Aggregate score|agg.]])</span>
*'''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 wikilined 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: [[WP:V|Verifiability]] and [[WP:OR|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 ===
*'''bg''' - Use this param to specify a custom background color (ignored if '''result''' is specified).  Use RRGGBB values ''without'' the # sign. Example: '''|bg=99C0B0'''
*'''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. See competition parameter below for custom values of the result parameter.
*'''size''' - By default Footballbox_collapsible is 100% wide.  Use this param to specify a different width. Example: '''|size=80%'''
*'''stack''' - Use when multiple {{tl|footballbox collapsible}}s are stacked together.  It causes the bottom bar to be hidden so that a thick bar does not appear between each box score.  Example '''|stack=yes'''
*'''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 '''
*'''competition''' - Used with result parameter to define [[Template:Football box collapsible/result|custom background colors]] in derby and competition articles. Case sensitive.

== Legend ==
Simple coloring legend recommended when an article makes use of '''result''' parameter:
<pre>{{legend2|#CCFFCC|Win|border=1px solid #AAAAAA}}
{{legend2|#FFFFCC|Draw|border=1px solid #AAAAAA}}
{{legend2|#FFCCCC|Loss|border=1px solid #AAAAAA}}
{{legend2|#CCCCCC|Void|border=1px solid #AAAAAA}} <!-- optional -->
{{legend2|#CCCCCC|Postponed|border=1px solid #AAAAAA}} <!-- optional --></pre>

Which produces:

{{legend2|#CCFFCC|Win|border=1px solid #AAAAAA}}
{{legend2|#FFFFCC|Draw|border=1px solid #AAAAAA}}
{{legend2|#FFCCCC|Loss|border=1px solid #AAAAAA}}
{{legend2|#CCCCCC|Void|border=1px solid #AAAAAA}}
{{legend2|#CCCCCC|Postponed|border=1px solid #AAAAAA}}


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

== Microformats ==

{{UF-hcard-short}}

{{UF-hcal}}

== See also ==
*{{tl|football box}} - almost the same thing, but not collapsible

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Sports match box templates|{{PAGENAME}}]]

</includeonly>