View source for Template:Infobox French commune/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{High-use| 37304 }}
{{Uses Infobox settlement}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Coordinates|Module:Check for unknown parameters}}

This infobox is meant for communes (the lowest level of administrative division) in France. This is an empty infobox with all available fields. The contents of the parameter fields, and which are optional, are explained below. This infobox now also supports settlements that are part of a commune, for instance former communes that were merged into a ''commune nouvelle''. See the parameter {{para|commune}} for a manual.
{{TOC limit|2}}

==Usage==
Delete any unneeded fields when using the full template syntax.

{{Parameter names example
| name
| native name
| commune status
| total type
| image
| image size
| caption
| image flag
| image flag size
| flag_link
| image coat of arms
| image coat of arms size
| shield_link
| city motto
| map
| adjustable map
| map size
| map caption
| INSEE
| arrondissement
| canton
| intercommunality
| type
| commune
| subdivisions entry
| subdivisions
| party
| mayor
| term
| area km2 = 1
| area footnotes
| urban area date
| metro area date
| population date
| population ranking
| urban pop date
| urban pop
| metro area pop date
| metro area pop
| population
| population footnotes
| population demonym
| ethnic
| ethnic date
| utc offset
| postal code
| dialling code
| elevation m = 1
| elevation min m = 0
| elevation max m = 2
| elevation footnotes
| website
}}

<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Infobox French commune
| name                    = 
| native name             = 
| commune status          = 
| total type              = 
| image                   = 
| image size              = 
| caption                 = 
| image flag              = 
| image flag size         = 
| flag_link               = 
| image coat of arms      = 
| image coat of arms size = 
| shield_link             = 
| city motto              = 
| map                     = 
| adjustable map          = 
| map size                = 
| map caption             = 
| coordinates             = <!-- use {{Coord}} -->
| INSEE                   = 
| province                = <!-- New Caledonia only -->
| administrative subdivision = <!-- French Polynesia only -->
| arrondissement          = 
| canton                  = 
| intercommunality        = 
| commune                 = <!-- for settlements that are part of a commune -->
| type                    = <!-- for settlements that are part of a commune -->
| subdivisions entry      = 
| subdivisions            = 
| party                   = 
| mayor                   = 
| term                    = 
| area km2                = 
| area footnotes          = 
| urban area date         = 
| urban area km2          = 
| metro area date         = 
| metro area km2          = 
| population date         = 
| population ranking      = 
| urban pop date          = 
| urban pop               = 
| metro area pop date     = 
| metro area pop          = 
| population              = 
| population demonym      = 
| ethnic                  = 
| ethnic date             = 
| utc offset              = <!-- French Polynesia only -->
| postal code             = 
| dialling code           = 
| elevation m             = 
| elevation min m         = 
| elevation max m         = 
| elevation footnotes     = 
| website                 = 
}}
</syntaxhighlight>

==Parameters==
Note that the field name is case-sensitive; it should be lower case (apart from INSEE). Some lesser used fields are not discussed (yet) in this overview. 

Delete any unneeded fields when using the full template syntax.

=== Required parameters ===
* coordinates
* arrondissement
* canton
* population
* INSEE

===name===
English name of location. If this field is not specified, the article name is used.

===native name===
French name of location. Use only if French name is different from English name (e.g. Dunkirk–Dunkerque). Sometimes used for regional languages, such as Breton and Catalan.

===commune status===
If you want a sub-banner to appear. Defaults to empty. Can be anything—for example, [[Paris]] can use it to describe its status as both a commune and department.

===total type===
If this is left empty, area and population totals will appear on the same line as the respective title. If you indicate something different (for example, 'commune'), that title will appear as a sub-title for both area and population sections.

===image===
A representative picture of the location: skyline, notable landmark, etc. The image used should preferably be wider than it is tall, to keep the infobox as compact as possible. The plain image file name should be given, e.g. <nowiki>Vieux port de Marseille 2.jpg</nowiki>.

===caption===
The caption for this picture (optional).

===image flag, image coat of arms, etc.===
The official flag and coat of arms of the commune. See the infoboxes of [[Paris]] and [[Marseille]] for examples.

===city motto===
The official city motto (probably only applicable for the largest cities).

===map, adjustable map===
'''Avoid, except for overseas departments and territories.''' For locations in metropolitan (=European) France, an automatic map is generated if the coordinates are given in {{para|coordinates}} (see below). For locations in the overseas departments and territories (e.g. French Guiana, New Caledonia, Réunion), this automatic map will give strange results. In these cases, manual location maps ("map", "adjustable map"). 

* "map": Specify only the file name of the map image, e.g. "Cayenne.PNG".
* "adjustable map": Specify the file name of the map image, e.g. "adjustable map=Cayenne.PNG", and the width in the field "map size", e.g. "map size=200px".

===coordinates===
'''Required.''' Geographical coordinates of location. Give location in decimals. Northern hemisphere and eastern hemisphere have positive numbers. The coordinates are used for map calculation. If the coordinates are not available in French or Dutch ("Nederlands") Wikipedia, you can look them up at for instance https://www.google.fr/maps

===INSEE===
The INSEE (French national statistics institute) code of the commune. The region and the department to which the location belongs are retrieved using this code and a subtemplate. The INSEE code is also used to provide a link to the census results for the commune. For settlements that are part of a commune, use any number that starts with the department number, for instance the INSEE code of the commune, the former commune, or just the department number (e.g. 77 for a place in Seine-et-Marne). It does not show, but it is used to display the correct region, department and detailed map.

===region and department===
DEPRECATED: The region and the department to which the location belongs are retrieved using the (required!) INSEE code. The fields "region" and "department" are no longer used.

===province===
For New Caledonia.

===administrative subdivision===
For French Polynesia.

===arrondissement===
'''Required.''' The arrondissement to which the location belongs. No wikilinks required. Some overseas locations are not part of an arrondissement. The largest cities (e.g. Paris, Lyon, Marseille) are subdivided into arrondissements themselves. In those cases, use the "subdivisions" field instead.

===canton===
'''Required.''' The canton to which the location belongs. No wikilinks required. Some overseas locations are not part of a canton. Some locations, usually the larger cities, are subdivided into cantons themselves. In those cases, use the "subdivisions" field instead.

===intercommunality===
Many communes cooperate in an intercommunality. 

===commune, type===
For settlements that are part of a commune. "commune" is the commune the settlement is part of, "type" is the type of settlement, for instance ''commune déléguée'' or ''commune associée''. Default type is ''part''.

===subdivisions===
Some locations, usually the larger cities, are subdivided into arrondissements or cantons. In those cases, fill in something like "subdivisions=9 arrondissements". A link to an article about these subdivisions can also go here. 

===mayor===
The mayor of the commune. The governing period of the mayor (currently 2020&ndash;2026) should be given in the field "term". Optionally, the political affiliation of the mayor can be given in the field "party".

===area km2===
The area of the commune in square kilometres. Don't use a comma for decimal separator, but use a point (12.34 instead of 12,34): commas give bad results in the population density calculation. The template will also calculate the area in square miles.

===population===
The population of the commune. Don't use thousands separators like points or spaces (e.g. 5.678 or 34 567): they give bad results in the population density calculation. The census year should be given in the field "population date". You can add references and footnotes in the field "population footnotes" (not in "population"). '''Note:''' Adding references to commune, urban and metro population numbers 'breaks' the settlement template population density calculations for each respective area. For existing communes (i.e. not former communes) the template {{tl|France metadata Wikidata}} should be used, which retrieves the most recent population data from Wikidata. For example:
<syntaxhighlight lang="wikitext">|population             = {{France metadata Wikidata|population_total}}
|population date        = {{France metadata Wikidata|population_as_of}}
|population footnotes   = {{France metadata Wikidata|population_footnotes}}</syntaxhighlight>

===population_demonym===
The adjective describing the people and places of the region. Use the ''English'' demonym by default (e.g., <code>Parisian</code>, not "Parisien").

If the French demonym is included, specify the respective languages in full or via [[:wikt:Wiktionary:List of languages|language code]]. Use the correct capitalization common to each respective language. For example: {{nowrap|<code><nowiki>Parisian (English)<br>parisien (French)</nowiki></code>}} or {{nowrap|<code><nowiki>Parisian (en)<br>parisien (fr)</nowiki></code>}}. Use [[non-breaking space]]s (&amp;nbsp;) or {{tl|nowrap}} to prevent unhelpful text-wrapping in these lines. Do not include the [[feminine gender|feminine form]] as a separate demonym, but do include it as an alternative style of the French demonym if possible: <code>parisien(ne)</code>.

Do not include other languages' demonyms unless they are [[WP:NOTABILITY|notable]] (e.g., Breton names only for Breton places).

===time zone===
Only use this parameter for places in French Polynesia. For other places the time zone is derived from the INSEE code.

===postal code===
The postal code(s) of the commune.

===elevation min m, elevation max m, elevation m===
The minimum, maximum, and average elevation of the commune above sea level in metres. The metres will be converted to feet, and both are displayed.

===website===
The official website of the commune. Please follow the guidelines at [[WP:LINKS]].

== Example: [[Paris]] ==
<!-- Displayed as an infobox -->
{{Infobox French commune
| name = Paris
| population_demonym = Parisian&nbsp;([[English language|en]])<br />parisien(ne)&nbsp;([[French language|fr]])
| commune status = [[Communes of France|Commune]] / [[Departments of France|Department]]
| total type =
| image = Panorama Paris December 2007.jpg
| caption = The [[Eiffel Tower]] (foreground) and the skyscrapers of the<br />[[La Défense]] business district (background).
| image flag = Flag of Paris with coat of arms.svg
| image flag size = 85px
| image coat of arms = Grandes Armes de Paris.svg
| image coat of arms size = 120px
| flag_link = Flag of Paris
| shield_link = Coat of arms of Paris
| city motto = ''[[Fluctuat nec mergitur]]''<br />{{nowrap|([[Latin]]: She is tossed by the waves but is not sunk)}}
| coordinates = {{coord|48.856667|2.350833|format=dms}}
| mayor = [[Bertrand Delanoë]]
| party = [[Socialist Party (France)|PS]]
| term = 2008–2014
| subdivisions entry = [[Administrative division|Subdivisions]]
| subdivisions = [[Arrondissements of Paris|20 arrondissements]]
| area km2 = 105.4
| area footnotes = <ref name="area">[https://www.insee.fr/fr/statistiques/1405599?geo=COM-75056 INSEE local statistics], including [[Bois de Boulogne]] and [[Bois de Vincennes]].</ref>
| population date = January 1, 2009 estimate<ref name="pop">{{cite web
  | url=http://www.paris.fr/portail/accueil/Portal.lut?page_id=5427&document_type_id=5&document_id=8717&portlet_id=11661
  | title=La population par arrondissement de 1990 à 2009
  | date=2009-01-01
  | publisher=Mairie de Paris
  | language=French
  | accessdate=2009-07-09}}</ref>
| INSEE = 75056
| postal code = 75001-75020, 75116
| population = 2203817
| population ranking = [[List of communes in France with over 20,000 inhabitants (1999 census)|1st in France]]
| urban area km2 = 2,723
| urban area date = 1999
| urban pop = 10,142,983
| urban pop date = 2006
| metro area km2 = 14518.3
| metro area date = 1999
| metro area pop = 11,769,433
| metro area pop date = 2006
| website = {{URL|http://www.paris.fr/}}
}}

<!-- Displayed as infobox code -->
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Infobox French commune
| name = Paris
| population_demonym = Parisian&nbsp;([[English language|en]])<br />parisien(ne)&nbsp;([[French language|fr]])
| commune status = [[Communes of France|Commune]] / [[Departments of France|Department]]
| total type =
| image = Panorama Paris December 2007.jpg
| caption = The [[Eiffel Tower]] (foreground) and the skyscrapers of the<br />[[La Défense]] business district (background).
| image flag = Flag of Paris with coat of arms.svg
| image flag size = 85px
| image coat of arms = Grandes Armes de Paris.svg
| image coat of arms size = 120px
| flag_link = Flag of Paris
| shield_link = Coat of arms of Paris
| city motto = ''[[Fluctuat nec mergitur]]''<br />{{nowrap|([[Latin]]: She is tossed by the waves but is not sunk)}}
| coordinates = {{coord|48.856667|2.350833|format=dms}}
| mayor = [[Bertrand Delanoë]]
| party = [[Socialist Party (France)|PS]]
| term = 2008–2014
| subdivisions entry = [[Administrative division|Subdivisions]]
| subdivisions = [[Arrondissements of Paris|20 arrondissements]]
| area km2 = 105.4
| area footnotes = <ref name="area">[http://www.statistiques-locales.insee.fr/Fiches%5CRS%5CDEP%5C75%5CCOM%5CRS_COM75056.pdf INSEE local statistics], including [[Bois de Boulogne]] and [[Bois de Vincennes]].</ref>
| population date = January 1, 2009 estimate<ref name="pop">{{cite web
  | url=http://www.paris.fr/portail/accueil/Portal.lut?page_id=5427&document_type_id=5&document_id=8717&portlet_id=11661
  | title=La population par arrondissement de 1990 à 2009
  | date=2009-01-01
  | publisher=Mairie de Paris
  | language=French
  | accessdate=2009-07-09}}</ref>
| INSEE = 75056
| postal code = 75001-75020, 75116
| population = 2203817
| population ranking = [[List of communes in France with over 20,000 inhabitants (1999 census)|1st in France]]
| urban area km2 = 2,723
| urban area date = 1999
| urban pop = 10,142,983
| urban pop date = 2006
| metro area km2 = 14518.3
| metro area date = 1999
| metro area pop = 11,769,433
| metro area pop date = 2006
| website = {{URL|http://www.paris.fr/}}
}}
</syntaxhighlight>
;Footnotes
{{reflist}}
{{Clear}}

==TemplateData==
{{collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"params": {
		"name": {
			"required": false,
			"label": "Name",
			"type": "string",
			"description": "English name of location",
			"default": "Article Name"
		},
		"native name": {
			"required": false,
			"label": "Native Name",
			"type": "string",
			"description": "Native name of the location"
		},
		"commune status": {
			"required": false,
			"label": "Commune Status",
			"type": "string",
			"description": "Fill to show sub-banner: eg. Type of settlement (City, Commune, Municipality) "
		},
		"total type": {
			"required": false,
			"label": "Total Type",
			"type": "string",
			"description": "Fill to show Area/Population totals next to 'total type' value ''below'' Area/Population in each section line (normally on same line)"
		},
		"image flag": {
			"required": false,
			"label": "Image Flag",
			"type": "wiki-page-name",
			"description": "Image of the flag of commune"
		},
		"image flag size": {
			"required": false,
			"label": "Image flag size",
			"type": "line",
			"description": "Size of image of the flag of commune"
		},
		"city motto": {
			"required": false,
			"label": "City Motto",
			"type": "string",
			"description": "Motto of the city"
		},
		"image": {
			"required": false,
			"label": "Image",
			"type": "wiki-file-name",
			"description": "Image of the place or any notable landmark"
		},
		"caption": {
			"required": false,
			"label": "Caption",
			"type": "string",
			"description": "Caption for the image"
		},
		"map": {
			"required": false,
			"label": "Map",
			"type": "wiki-page-name",
			"description": "For overseas locations, provide an image for the map"
		},
		"timezone": {
			"required": false,
			"label": "Timezone",
			"type": "string",
			"description": "Timezone of the commune"
		},
		"coordinates": {
			"required": true,
			"label": "Coordinates",
			"type": "string",
			"description": "Coordinates of the location using {{coord}}"
		},
		"arrondissement": {
			"required": true,
			"label": "Arrondissement",
			"type": "string",
			"description": "The Arrondissement to which the location belongs"
		},
		"intercommunality": {
			"required": true,
			"label": "Intercommunality",
			"type": "string",
			"description": "Intercommunality of the commune"
		},
		"mayor": {
			"required": false,
			"label": "Mayor",
			"type": "string",
			"description": "Mayor of the commune"
		},
		"term": {
			"required": false,
			"label": "Term",
			"type": "line",
			"description": "The governing period of the mayor. Do not add references here, you can add these in the \"mayor\" parameter."
		},
		"elevation m": {
			"required": false,
			"label": "Elevation(meters)",
			"type": "number",
			"description": "Average elevation of commune above sea level in meters"
		},
		"elevation min m": {
			"required": false,
			"label": "Minimum Elevation(meters)",
			"type": "number",
			"description": "Minimum elevation of the commune in meters"
		},
		"elevation max m": {
			"required": false,
			"label": "Maximum Elevation(meters)",
			"type": "number",
			"description": "Maximum elevation of the commune in meters"
		},
		"area km2": {
			"required": false,
			"label": "Area (square km)",
			"type": "number",
			"description": "Area of the commune in square kilometers"
		},
		"population": {
			"required": true,
			"label": "Population",
			"type": "number",
			"description": "Population of the commune. For existing communes (i.e. not former communes) the template France metadata Wikidata should be used, which retrieves the most recent population data from Wikidata"
		},
		"population date": {
			"required": false,
			"label": "Population Date",
			"type": "line",
			"description": "Date (year) on which population was counted"
		},
		"INSEE": {
			"required": true,
			"label": "INSEE",
			"type": "number",
			"description": "INSEE code for the commune",
			"aliases": [
				"insee"
			]
		},
		"postal code": {
			"required": false,
			"label": "Postal code",
			"type": "number",
			"description": "Postal Code of the commune"
		},
		"website": {
			"required": false,
			"label": "Website",
			"type": "string",
			"description": "Official website of the commune"
		},
		"canton": {
			"label": "Canton",
			"type": "string"
		},
		"image size": {},
		"flag link": {
			"aliases": [
				"flag_link"
			]
		},
		"image coat of arms": {
			"description": "Image of coat of arms of commune."
		},
		"image coat of arms size": {
			"description": "Size of image of coat of arms of commune "
		},
		"shield_link": {},
		"adjustable map": {},
		"map size": {},
		"map caption": {},
		"province": {
			"description": "Used for places in New Caledonia",
			"type": "string"
		},
		"subdivisions entry": {},
		"subdivisions": {},
		"party": {},
		"area footnotes": {},
		"urban pop": {
			"description": "Population of the (inner) urban area (''unité urbaine''). To be added to the central commune only"
		},
		"urban pop date": {},
		"urban area date": {},
		"urban area km2": {},
		"metro area pop": {
			"description": "Population of the wider functional urban area (''aire d'attraction d'une ville''). To be added to the central commune only"
		},
		"metro area pop date": {},
		"metro area date": {},
		"metro area km2": {},
		"population footnotes": {},
		"population ranking": {},
		"population demonym": {
			"aliases": [
				"demonym",
				"population_demonym"
			],
			"type": "string"
		},
		"demonym": {},
		"ethnic": {},
		"ethnic date": {},
		"time zone": {
			"aliases": [
				"timezone"
			],
			"description": "Name of the time zone",
			"deprecated": "Time zones are derived from the INSEE code"
		},
		"utc offset": {
			"aliases": [
				"utc_offset"
			],
			"description": "Only for French Polynesia, for other places the time zone is derived from the INSEE code"
		},
		"time zone DST": {
			"aliases": [
				"time_zone_DST",
				"timezone_DST"
			],
			"type": "string",
			"deprecated": "Time zones are derived from the INSEE code"
		},
		"utc offset DST": {
			"aliases": [
				"utc_offset_DST"
			],
			"deprecated": "Time zones are derived from the INSEE code"
		},
		"dialling code": {},
		"elevation footnotes": {},
		"footnotes": {},
		"map dot label": {},
		"department": {
			"label": "Department",
			"type": "string",
			"deprecated": "Unused, remove. Department is derived from INSEE"
		},
		"commune": {
			"description": "Used for places that are part of a commune",
			"type": "string"
		},
		"type": {
			"description": "Used for places that are part of a commune.",
			"type": "string",
			"default": "Part"
		},
		"region": {
			"deprecated": "The region and the department to which the location belongs are retrieved using the (required!) INSEE code."
		},
		"administrative subdivision": {
			"description": "Used for places in French Polynesia"
		}
	}
}
</templatedata>
{{collapse bottom}}

== Microformat ==
{{UF-hcard-place}}

== Tracking category ==
* {{clc|Pages using infobox French commune with unknown parameters}}

== See also ==
{{About French nav boxes}}

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:French subdivision infobox templates|Communes]]
[[Category:Templates with coordinates fields]]
[[Category:Templates that add a tracking category]]
}}</includeonly>