Template:Football squad player/doc

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

This template is used on approximately 19,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:Flag

Usage

This template is used to display a football (soccer) player squad in a standard format.

Syntax

Most squads are split into two vertical columns. For these, you can use the {{Football squad start}}, {{Football squad mid}} and {{Football squad end}} templates to help with the layouting, and then use this template repeatedly within them:

{{Football squad start}}
{{Football squad player|no=#SHIRT_NUMBER|nat=#NATIONALITY|pos=#POS_OR_ROLE|name=#PLAYER_NAME}}
{{Football squad player|no=#SHIRT_NUMBER|nat=#NATIONALITY|pos=#POS_OR_ROLE|name=#PLAYER_NAME|other=#OTHER_RELATED_INFO}}
...
{{Football squad mid}}
{{Football squad player|no=11|nat=ITA|pos=FW|name=[[Gioacchini Simone]]}}
...
{{Football squad end}}

Alternative template names

In order to make easier the work of writing new squads, some alternative, shorter, names has been designed. So, you may now use {{Fs start}}, {{Fs player}}, {{Fs mid}} and {{Fs end}} as alternative templates, using the same equivalent syntax of the other ones.

Parameters

In {{Football squad start}}:

• hidenote: By default, the note at the top of the template will always display. It can be disabled with |hidenote=yes.
• date: Optional parameter; will display the date as typed.
• ref: Optional parameter; will add a reference to the end of the header.

In {{Football squad start}} and {{football squad mid}}

• bg: Use this param to specify a custom background color for the table header. Use RRGGBB values without the # sign. Example: |bg=5d9731
• color: Use this param to specify a custom text color for the table header. Use RRGGBB values without the # sign. Example: |color=ffffff

In {{Football squad start}}, {{football squad mid}} and {{Football squad player}}:

• nonumber: Many clubs use squad numbers, but others do not. Adding |nonumber=yes to {{football squad start}} will disable the number column entirely. If used, this parameter should also be added to every player's entry, as otherwise a dash will be shown.

In {{Football squad player}}:

• no: The shirt number for the player, if they have one. If the player's number is not known, or unassigned, then you can use the – character instead.
• nat: The player's nationality. Use the name of the country, or its 3-letter IOC country code, rather than an adjective (e.g. "Spain" instead of "Spanish"). This is for the country that the player represents in international football (regardless of nationality of birth or citizenship, or non-FIFA sporting nationalities the player may use in other contexts). If this template is used in a non-FIFA context, then some other nationality might apply; however, this parameter is never for indication of birthplace as such, which has nothing to do with football.
• natvar: If the relevant flag of the country is other that its current one, e.g. |natvar=1931. (see Template:Flagicon/doc for how to look up the available flag options for each country.)
• pos: The position in which the player plays. You can use any of the four options below:
  1. GK for Goalkeeper;
  2. DF for Defender;
  3. MF for Midfielder;
  4. FW for Striker or Forward;
• name: The player's name.
• other: This is an optional parameter. You can add any related info to this parameter, like specifying captain, vice-captain, whether the player is on loan, etc. It will show additional info in the brackets after the player name. You do not have to specify it if neither applies.

Example

For example, the following code:

{{Football squad start}}
{{Football squad player | no=1  | nat=Spain      | pos=GK | name=[[Iker Casillas]]}}
{{Football squad player | no=3  | nat=ESP        | pos=DF | name=[[Gerard Pique]]}}
{{Football squad player | no=9  | nat=Singapore  | pos=FW | name=[[Aleksandar Đurić]] | other=team captain}}
{{Football squad player | no=10 | nat=NED| pos=FW | name=[[Robin Van Persie]]}}
{{Football squad mid}}
{{Football squad player | no=13 | nat=South Korea| pos=MF | name=[[Park Ji-sung]]}}
{{Football squad player | no=25 | nat=ENG  | pos=GK | name=[[Joe Hart]]}}
{{Football squad player | no=1  | nat=Spain  | natvar=1931 | pos=GK | name=[[Ricardo Zamora]]}}
{{Football squad player | no=   | nat=HUN  | natvar=1949 | pos=FW | name=[[Ferenc Puskas]]}}
{{Football squad player | no=42 | nat=     | natvar=     | pos=FW | name=[[Arthur Dent]]}}
{{Football squad end}}

Produces this table:

Note: Flags indicate national team as defined under FIFA eligibility rules. Players may hold more than one non-FIFA nationality.

No. Pos. Nation Player 1 GK  ESP Iker Casillas 3 DF  ESP Gerard Pique 9 FW  SGP Aleksandar Đurić (team captain) 10 FW  NED Robin Van Persie

No. Pos. Nation Player 13 MF  KOR Park Ji-sung 25 GK  ENG Joe Hart 1 GK  ESP Ricardo Zamora — FW  HUN Ferenc Puskas 42 FW   Arthur Dent

Microformat

The HTML markup produced by this template includes an hCard microformat, which makes the person'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.

To include a URL, use {{URL}}.

Classes

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

• agent
• family-name
• fn (required)
• given-name
• honorific-prefix
• honorific-suffix
• n
• nickname
• org
• url
• vcard

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Football squad player

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
National team	nat	The national team of the player, as name or IOC code. Example Spain or ESP, not Spanish	String	required
Position	pos	The position of the player which can be either GK (Goal keeper), DF(defender), MF(Mid fielder) or FW(Forward) Example FW	String	required
Name	name	Name of player. May be wikilinked. Example Kaká	Content	required
Other information	other	Optional field that is used to mention captain, vice-captain, on loan, etc. Example on loan	String	suggested
Number	no	The shirt number for the player, if they have one. If the player's number is not known, or unassigned, then you can use the – character instead. Example 10	Number	optional
No number	nonumber	Player shirt numbers are not shown in the table Example yes	Boolean	optional
Flag variant	natvar	To use a historical flag. See Template:Flagicon Default Use the current flag.	Unknown	optional
Reference	ref	no description	Unknown	optional

The template gives displays the shirt no., country, position and full name of a football (soccer) player. Also mentions if a player is a captain, vice-captain or on-loan.