View source for Template:Infobox football club season/doc

{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

This infobox template is to be used for any [[association football]] club's season article.

== Usage ==
<pre>
{{Infobox football club season
|club               = 
|season             = 
|chrtitle           = 
|chairman           = 
|ownertitle         = 
|owner              = 
|mgrtitle           = 
|manager            = 
|stdtitle           = 
|stadium            = 
|league             = 
|league result      = 
|league2            = 
|league2 result     = 
|cup1               = 
|cup1 result        = 
|cup2               = 
|cup2 result        = 
|cup3               = 
|cup3 result        = 
|cup4               = 
|cup4 result        = 
|cup5               = 
|cup5 result        = 
|cup6               = 
|cup6 result        = 
|cup7               = 
|cup7 result        = 
|cup8               = 
|cup8 result        = 
|league topscorer   = 
|season topscorer   = 
|highest attendance = 
|lowest attendance  = 
|average attendance = 
|largest win        = 
|largest loss       = 
|pattern_name1      = 
|pattern_la1        = 
|pattern_b1         = 
|pattern_ra1        = 
|pattern_sh1        = 
|pattern_so1        = 
|leftarm1           = 
|body1              = 
|rightarm1          = 
|shorts1            = 
|socks1             = 
|alt1               = 
|filetype1          = 
|pattern_name2      = 
|pattern_la2        = 
|pattern_b2         = 
|pattern_ra2        = 
|pattern_sh2        = 
|pattern_so2        = 
|leftarm2           = 
|body2              = 
|rightarm2          = 
|shorts2            = 
|socks2             = 
|alt2               = 
|filetype2          = 
|pattern_name3      = 
|pattern_la3        = 
|pattern_b3         = 
|pattern_ra3        = 
|pattern_sh3        = 
|pattern_so3        = 
|leftarm3           = 
|body3              = 
|rightarm3          = 
|shorts3            = 
|socks3             = 
|alt3               = 
|filetype3          = 
|American           = 
|updated            = 
|prevseason         = 
|nextseason         = 
}}</pre>

== Parameters ==
{| class="wikitable"
! Parameter
! Description
|-
| <code>club</code>
| The commonly used name of the club.
|-
| <code>season</code>
| The related season in the form YYYY–YY, unless it is at the turn of the century, where is should be YYYY–YYYY. This can be linked to an appropriate article, like [[2014–15 in English football]]. Make sure to use an en dash.
|-
| <code>chrtitle</code>
| If the club chairman is known by a different title (e.g. president, owner, chief executive, etc.), that title should be noted here.
|-
| <code>chairman</code>
| The chairman of the club in the season. If two or more chairmans served for the club during the season, you can indicate all of them by splitting them in different rows using <nowiki><br></nowiki> to divide their names.
|-
| <code>ownertitle</code>
| If the club owner is known by a different title, that title should be noted here.
|-
| <code>owner</code>
| The owner of the club in the season. If two or more owners served for the club during the season, you can indicate all of them by splitting them in different rows using <nowiki><br></nowiki> to divide their names.
|-
| <code>mgrtitle</code>
| If the club manager is known by a different title (e.g. coach, head coach, first team coach, etc.), that title should be noted here.
|-
| <code>manager</code>
| The manager of the club in the season. If two or more managers served for the club during the season, you can indicate all of them by splitting them in different rows using <nowiki><br></nowiki> to divide their names.
|-
| <code>stdtitle</code>
| If the stadium is known by a different title (e.g. ground, etc.), that title should be noted here.
|-
| <code>stadium</code>
| The stadium or ground occupied during the season.
|-
| <code>league</code>
| The league in which the club played in the given season. For this to show up, the parameter <code>league result</code> must have a value. This should be linked to the current season of the league.
|-
| <code>league result</code>
| The current standing or final result achieved in the league in the season. If the result is the current standing, it should be italicized. Make sure to use the suffixes -th, -st, -nd and -rd. If the final result is first or second, then replace it with "Winners" in bold or "Runners-up", respectively.
|-
| <code>league2</code>
| The secondary league in which the club played in the given season. For this to show up, the parameter <code>league2 result</code> must have a value. This should be linked to the current season of the league.
|-
| <code>league2 result</code>
| The current standing or final result achieved in the secondary league in the season. If the result is the current standing, it should be italicized. Make sure to use the suffixes -th, -st, -nd and -rd.
|-
| <code>cup''n''</code>
| A cup in which the club played in the season. The value ''n'' can be substituted for a number from 1 to 8, depending on how many cups the club is participating in that season. For this to show up, the parameter <code>cup''n'' result</code> must have a value. This should be linked to the current season of the cup.
|-
| <code>cup''n'' result</code>
| In progress or the final result achieved in the cup by the club during the season. The value ''n'' can be substituted for a number from 1 to 8, depending on how many cups the club is participating in that season.
|-
| <code>league topscorer</code>
| The club top scorer in the domestic league level. Beside the player's name, in parentheses, should be the number of goals they scored.
|-
| <code>season topscorer</code>
| The club top scorer in all competitions. Beside the player's name, in parentheses, should be the number of goals they scored. If this value is set, there should also be a value for <code>league topscorer</code>. If the top scorer in all competitions has all of his goals in the league, leave this parameter blank.
|-
| {{Nowrap|<code>highest attendance</code>}}
| The highest home attendance (all competitive matches) enjoyed by the club during the season.
|-
| <code>lowest attendance</code>
| The lowest home attendance (all competitive matches) enjoyed by the club during the season.
|-
| <code>average attendance</code>
| The average home attendance (league matches only) enjoyed by the club during the domestic season.
|-
| <code>largest win</code>
| The largest win (all competitive matches) enjoyed by the club during the season.
|-
| <code>largest lost</code>
| The largest defeat (all competitive matches) enjoyed by the club during the season.
|-
| <code>updated</code>
| The last time the statistics in the template were updated.
|-
| <code>prevseason</code>
| Link to the article for the club's previous season.
|-
| <code>nextseason</code>
| Link to the article for the club's next season.
|}

=== Football kit parameters ===
{{main|Template:Football kit}}

For the following parameters, the value ''n'' can be substituted for 1 (for the home kit), 2 (for the away kit), or 3 (for the third kit). For info on how to create a kit, see [[Template:Football kit#Best practice|here]].

{| class="wikitable"
! Parameter
! Description
|-
| {{Nowrap|<code>pattern_name''n''</code>}}
| This changes the title that appears under the template. It is optional, and usually does not need to be changed. The default titles are home, away, and third, for the value of ''n'' being 1, 2, and 3, respectively. This can only be used if there is a value for <code>pattern_la''n''</code>, <code>pattern_b''n''</code>, <code>pattern_ra''n''</code>, <code>pattern_sh''n''</code>, <code>pattern_so''n''</code>, <code>leftarm''n''</code>, <code>body''n''</code>, <code>rightarm''n''</code>, <code>shorts''n''</code>, and/or <code>socks''n''</code>, and the value of ''n'' is the same between the parameter(s) used and <code>pattern_name''n''</code>.
|-
| <code>American</code>
| This changes the word "colour" to "color" for the title of the football kit. This can only be used if there is a value for the parameters <code>pattern_la''n''</code>, <code>pattern_b''n''</code>, <code>pattern_ra''n''</code>, <code>pattern_sh''n''</code>, <code>pattern_so''n''</code>, <code>leftarm''n''</code>, <code>body''n''</code>, <code>rightarm''n''</code>, <code>shorts''n''</code>, and/or <code>socks''n''</code>.
|-
| <code>pattern_la''n''</code>
| The name for pattern modifier for left arm.
|-
| <code>pattern_b''n''</code>
| The name for pattern modifier for body.
|-
| <code>pattern_ra''n''</code>
| The name for pattern modifier for right arm.
|-
| <code>pattern_sh''n''</code>
| The name for pattern modifier for shorts.
|-
| <code>pattern_so''n''</code>
| The name for pattern modifier for socks.
|-
| <code>leftarm''n''</code>
| The color code modifier for left arm. Do not use the hashtag when naming the color.
|-
| <code>body''n''</code>
| The color code modifier for body. Do not use the hashtag when naming the color.
|-
| <code>rightarm''n''</code>
| The color code modifier for right arm. Do not use the hashtag when naming the color.
|-
| <code>shorts''n''</code>
| The color code modifier for shorts. Do not use the hashtag when naming the color.
|-
| <code>socks''n''</code>
| The color code modifier for socks. Do not use the hashtag when naming the color.
|-
| <code>alt''n''</code>
| This displays alternative text that is helpful for users with screen readers. For more information, see [[Wikipedia:Alternative text for images]]. This can only be used if there is a value for <code>pattern_la''n''</code>, <code>pattern_b''n''</code>, <code>pattern_ra''n''</code>, <code>pattern_sh''n''</code>, <code>pattern_so''n''</code>, <code>leftarm''n''</code>, <code>body''n''</code>, <code>rightarm''n''</code>, <code>shorts''n''</code>, and/or <code>socks''n''</code>, and the value of ''n'' is the same between the parameter(s) used and <code>pattern_name''n''</code>.

|-
| <code>filetype''n''</code>
| An optional parameter if there is a different image format than the default PNG. For example, setting the value to "svg" will direct the template to SVG files. When using this optional parameter, you must ensure that all of the images you want to use exist in the format that you select. Currently, most images only exist as PNG files and will not work with the SVG setting. This can only be used if there is a value for <code>pattern_la''n''</code>, <code>pattern_b''n''</code>, <code>pattern_ra''n''</code>, <code>pattern_sh''n''</code>, <code>pattern_so''n''</code>, <code>leftarm''n''</code>, <code>body''n''</code>, <code>rightarm''n''</code>, <code>shorts''n''</code>, and/or <code>socks''n''</code>, and the value of ''n'' is the same between the parameter(s) used and <code>pattern_name''n''</code>.
|}

== Example ==
{{Infobox football club season
| club = Footy Town F.C.
| season = 2019–20
| manager = [[Lucas Boss]]
| chairman = [[Alan Money]]
| stadium = [[Arsenal Stadium]]
| league = [[Premier League]]
| league result = 7th (UEFA Intertoto Cup)
| cup1 = [[FA Cup]] | cup1 result = Third Round
| cup2 = [[League Cup]] | cup2 result = Second Round
| league topscorer = [[Patrick Scorer]] (17)
| season topscorer = [[Patrick Scorer]] (20)
| highest attendance = 16,044 (vs [[Manchester United F.C.]], 16 March 2020)
| lowest attendance = 166 (vs [[Cardiff City F.C.]], 14 November 2019)
| average attendance = 10,121
| prevseason = [[Footy Town F.C. 2018–19|2018–19]]
| nextseason = [[Footy Town F.C. 2020–21|2020–21]]
}}

The infobox shown is produced with:

<pre style="overflow: auto">
{{Infobox football club season
| club = Footy Town F.C.
| season = 2019–20
| manager = [[Lucas Boss]]
| chairman = [[Alan Money]]
| stadium = [[Arsenal Stadium]]
| league = [[Premier League]]
| league result = 7th (UEFA Intertoto Cup)
| cup1 = [[FA Cup]] | cup1 result = Third Round
| cup2 = [[League Cup]] | cup2 result = Second Round
| league topscorer = [[Patrick Scorer]] (17)
| season topscorer = [[Patrick Scorer]] (20)
| highest attendance = 16,044 (vs [[Manchester United F.C.]], 16 March 2020)
| lowest attendance = 166 (vs [[Cardiff City F.C.]], 14 November 2019)
| average attendance = 10,121
| prevseason = [[Footy Town F.C. 2018–19|2018–19]]
| nextseason = [[Footy Town F.C. 2020–21|2020–21]]
}}
</pre>

== Microformat ==
{{UF-hcard-org}}

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>{
  "description": "An infobox for information on the season of a football club.",
  "params": {
    "club": {
      "label": "Club",
      "description": "The commonly-used name of the club.",
      "type": "string",
      "default": "",
      "required": false
    },
    "season": {
      "label": "Season",
      "description": "The related season in the form YYYY–YYYY.",
      "type": "string",
      "default": "",
      "required": false
    },
    "manager": {
      "label": "Manager",
      "description": "The manager of the club in the season.",
      "type": "string",
      "default": "",
      "required": false
    },
    "chairman": {
      "label": "Chairman",
      "description": "The chairman of the club.",
      "type": "string",
      "default": "",
      "required": false
    },
    "ground": {
      "label": "Ground",
      "description": " The ground occupied during the season.",
      "type": "string",
      "default": "",
      "required": false
    },
    "stadium": {
      "label": "Stadium",
      "description": " The stadium occupied during the season.",
      "type": "string",
      "default": "",
      "required": false
    },
    "league": {
      "label": "League",
      "description": "The league in which the club played in the given season.",
      "type": "string",
      "default": "",
      "required": false
    },
    "league result": {
      "label": "League result",
      "description": "The current standing or final result achieved in the season.",
      "type": "string",
      "default": "",
      "required": false
    },
    "cup1": {
      "label": "Cup 1",
      "description": "A cup in which the club played in the season.",
      "type": "string",
      "default": "",
      "required": false
    },
    "cup1 result": {
      "label": "Cup 1 result",
      "description": "In progress or the final result achieved in the cup by the club during the season.",
      "type": "string",
      "default": "",
      "required": false
    },
    "cup2": {
      "label": "Cup 2",
      "description": "Another cup in which the club played in the season.",
      "type": "string",
      "default": "",
      "required": false
    },
    "cup2 result": {
      "label": "Cup 2 result",
      "description": "In progress or the final result achieved in the cup2 by the club during the season.",
      "type": "string",
      "default": "",
      "required": false
    },
    "league topscorer": {
      "label": "League topscorer",
      "description": "The club topscorer in the domestic league level, and the number of scored goals, in the form Football Player (goals).",
      "type": "string",
      "default": "",
      "required": false
    },
    "mgrtitle": {
      "label": "Manager title",
      "description": "If the club manager is known by a different title (e.g. Coach, Head Coach, First team coach, etc.), that title should be noted here.",
      "type": "string",
      "default": "",
      "required": false
    },
    "chrtitle": {
      "label": "Chairman title",
      "description": " If the club chairman is known by a different title (e.g. President, Owner, Chief Executive, etc.), that title should be noted here.",
      "type": "string",
      "default": "",
      "required": false
    },
    "season topscorer": {
      "label": "Season topscorer",
      "description": "The club topscorer in the whole season (also featuring cup matches), and the number of scored goals, in the form Football Player (goals).",
      "type": "string",
      "default": "",
      "required": false
    },
    "highest attendance": {
      "label": "Highest attendance",
      "description": "The highest home attendance (all competitive matches) enjoyed by the club during the season.",
      "type": "line",
      "default": "",
      "required": false
    },
    "lowest attendance": {
      "label": "Lowest attendance",
      "description": "The lowest home attendance (all competitive matches) enjoyed by the club during the season.",
      "type": "line",
      "default": "",
      "required": false
    },
    "average attendance": {
      "label": "Average attendance",
      "description": "The average home attendance (league matches only) enjoyed by the club during the domestic season.",
      "type": "line",
      "default": "",
      "required": false
    },
    "prevseason": {
      "label": "Previous season",
      "description": "Link to the article for the club's previous season.",
      "type": "wiki-page-name",
      "default": "",
      "required": false
    },
    "nextseason": {
      "label": "Next season",
      "description": " Link to the article for the club's next season.",
      "type": "wiki-page-name",
      "default": "",
      "required": false
    }
  }
}
</templatedata>

== See also ==
* [[Template:Football kit]]
; Hidden tracking/maintenance category
* [[:Category:Articles using infobox football club season with missing parameters]]

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Association football infobox templates|Football club season]]
[[Category:Templates that add a tracking category]]
}}</includeonly>