Template:Infobox settlement/sandbox

Template documentation[view] [edit] [history] [purge]

This template should be used to produce an Infobox for human settlements (cities, towns, villages, communities) as well as other administrative districts, counties, provinces, et cetera—in fact, any subdivision below the level of a country, for which {{Infobox country}} should be used. Parameters are described in the table below. For questions, see the talk page. For a US city guideline, see WP:USCITIES.

The template is aliased or used as a sub-template for several infobox front-end templates.

Usage

• Important: Please enter all numeric values in a raw, unformatted fashion. References and {{citation needed}} tags are to be included in their respective section footnotes field. Numeric values that are not "raw" may create an "Expression error". Raw values will be automatically formatted by the template. If you find a raw value is not formatted in your usage of the template, please post a notice on the discussion page for this template.
• An expression error may also occur when any coordinate parameter has a value, but one or more coordinate parameters are blank or invalid.

Basic blank template, ready to cut and paste. See the next section for a copy of the template with all parameters and comments. See the table below that for a full description of each parameter.

Using metric units

<syntaxhighlight lang="wikitext" style="overflow:auto">

Infobox settlement/sandbox

</syntaxhighlight>

Using non-metric units

<syntaxhighlight lang="wikitext" style="overflow:auto">

Infobox settlement/sandbox

</syntaxhighlight>

Short version

<syntaxhighlight lang="wikitext" style="overflow:auto">

Infobox settlement/sandbox

</syntaxhighlight>

Complete empty syntax, with comments

This copy of the template lists all parameters except for some of the repeating numbered parameters which are noted in the comments. Comments here should be brief; see the table below for full descriptions of each parameter.

<syntaxhighlight lang="wikitext" style="overflow:auto;">

Infobox settlement/sandbox

</syntaxhighlight>

Parameter names and descriptions

Name and transliteration
Parameter name	Usage	Description
name	optional	This is the usual name in English. If it's not specified, the infobox will use the official_name as a title unless this too is missing, in which case the page name will be used.
official_name	optional	The official name in English. Avoid using official_name if it leads to redundancy with name and settlement_type. Use official_name if the official name is unusual or cannot be simply deduced from the name and settlement type.
native_name	optional	Name in the local language, if different from name, and if not English. In this case "native" does not mean indigenous but is related to de facto language that is not English. This will display below the name/official name.
native_name_lang	optional	Use ISO 639-1 code, e.g. "fr" for French. If there is more than one native name, in different languages, enter those names using {{lang}}, instead.
other_name	optional	For places with other commonly used names like Bombay or Saigon
settlement_type	optional	Any type can be entered, such as City, Town, Village, Hamlet, Municipality, Reservation, etc. If set, will be displayed under the names. Might also be used as a label for total population/area (defaulting to City), if needed to distinguish from Urban, Rural or Metro (if urban, rural or metro figures are not present, the label is Total unless total_type is set).
Transliteration(s)
translit_lang1	optional	Will place the "entry" before the word "transliteration(s)". Can be used to specify a particular language like in Dêlêg or one may just enter "Other", like in Gaza's article.
translit_lang1_type translit_lang1_type1 to translit_lang1_type6	optional
translit_lang1_info translit_lang1_info1 to translit_lang1_info6	optional
translit_lang2	optional	Will place a second transliteration. See Dêlêg
translit_lang2_type translit_lang2_type1 to translit_lang2_type6	optional
translit_lang2_info translit_lang2_info1 to translit_lang2_info6	optional
Images, nickname, motto
Parameter name	Usage	Description
Image
image_skyline	optional	Primary image representing the settlement. Commonly a photo of the settlement’s skyline.
imagesize	optional	Can be used to tweak the size of the image_skyline up or down. This can be helpful if an editor wants to make the infobox wider. If used, px must be specified; default size is 250px. Note WP:IMGSIZELEAD recommends that images should be no wider than upright=1.35 -equivalent to 300px
image_alt	optional	Alt text for the image, used by visually impaired readers who cannot see the image. See WP:ALT.
image_caption	optional	Will place a caption under the image_skyline (if present)
Flag image
image_flag	optional	Used for a flag.
flag_size	optional	Can be used to tweak the size of the image_flag up or down from 100px as desired. If used, px must be specified; default size is 100px.
flag_alt	optional	Alt text for the flag.
flag_border	optional	Set to 'no' to remove the border from the flag
flag_link	optional
Seal image
image_seal	optional	If the place has an official seal.
seal_size	optional	If used, px must be specified; default size is 100px.
seal_alt	optional	Alt text for the seal.
seal_link seal_type	optional
Coat of arms image
image_shield	optional	Can be used for a place with a coat of arms.
shield_size	optional	If used, px must be specified; default size is 100px.
shield_alt	optional	Alt text for the shield.
shield_link	optional	Can be used if a wiki article if known but is not automatically linked by the template. See Coquitlam, British Columbia's infobox for an example.
Logo or emblem image
image_blank_emblem	optional	Can be used if a place has an official logo, crest, emblem, etc.
blank_emblem_type	optional	Caption beneath "image_blank_emblem" to specify what type of emblem it is.
blank_emblem_size	optional	If used, px must be specified; default size is 100px.
blank_emblem_alt	optional	Alt text for blank emblem.
blank_emblem_link	optional
Nickname, motto
etymology	optional	origin of name
nickname	optional	well-known nickname
nicknames	optional	if more than one well-known nickname, use this
motto	optional	Will place the motto under the nicknames
mottoes	optional	if more than one motto, use this
anthem	optional	Will place the anthem (song) under the nicknames
Maps, coordinates
Parameter name	Usage	Description
Map images
image_map	optional
mapsize	optional	If used, px must be specified; default is 250px.
map_alt	optional	Alt text for map.
map_caption	optional
image_map1	optional	A secondary map image. The field image_map must be filled in first. Example see: Bloomsburg, Pennsylvania.
mapsize1	optional	If used, px must be specified; default is 250px.
map_alt1	optional	Alt text for secondary map.
map_caption1	optional
Pushpin map(s), coordinates
pushpin_map	optional	The name of a location map as per Template:Location map (e.g. Indonesia or Russia). The coordinate fields (from |coordinates=) position a pushpin coordinate marker and label on the map automatically. Example: Padang, Indonesia. To show multiple pushpin maps, provide a list of maps separated by #, e.g., California#USA
pushpin_mapsize	optional	Must be entered as only a number—do not use px. The default value is 250. Equivalent to width parameter in Template:Location map.
pushpin_map_alt	optional	Alt text for pushpin map; used by screen readers, see WP:ALT. Equivalent to alt parameter in Template:Location map.
pushpin_map_caption	optional	Fill out if a different caption from map_caption is desired. Equivalent to caption parameter in Template:Location map.
pushpin_map_caption_notsmall	optional
pushpin_label	optional	The text of the label to display next to the identifying mark; a wikilink can be used. If not specified, the label will be the text assigned to the name or official_name parameters (if |pushpin_label_position=none, no label is displayed). Equivalent to label parameter in Template:Location map.
pushpin_label_position	optional	The position of the label on the pushpin map relative to the pushpin coordinate marker. Valid options are {left, right, top, bottom, none}. If this field is not specified, the default value is right. Equivalent to position parameter in Template:Location map.
pushpin_outside	optional	Equivalent to outside parameter in Template:Location map.
pushpin_relief	optional	Set this to y or any non-blank value to use an alternative relief map provided by the selected location map (if a relief map is available). Equivalent to relief parameter in Template:Location map.
pushpin_image	optional	Allows the use of an alternative map; the image must have the same edge coordinates as the location map template. Equivalent to AlternativeMap parameter in Template:Location map.
pushpin_overlay	optional	Can be used to specify an image to be superimposed on the regular pushpin map. Equivalent to overlay_image parameter in Template:Location map.
mapframe	optional	Add a {{infobox mapframe}} map. See the documentation below in #Mapframe maps for more details on usage.
coordinates	optional	Latitude and longitude. Use {{Coord}}. See the documentation for {{Coord}} for more details on usage.
coor_pinpoint	optional	If needed, to specify more exactly where (or what) coordinates are given (e.g. Town Hall) or a specific place in a larger area (e.g. a city in a county). Example: In the article Masovian Voivodeship, coor_pinpoint=Warsaw specifies Warsaw.
coordinates_footnotes	optional	Reference(s) for coordinates, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}}
grid_name grid_position	optional	Name of a regional grid system and position on the regional grid
Location, established, seat, subdivisions, government, leaders
Parameter name	Usage	Description
Location
subdivision_type	optional	almost always Country
subdivision_name	optional	Depends on the subdivision_type — use the name in text form, sample: United States. Per MOS:INFOBOXFLAG, flag icons or flag templates may be used in this field
subdivision_type1 to subdivision_type6	optional	Can be State/Province, region, county. These labels are for subdivisions above the level of the settlement described in the article. For subdivisions below or within the place described in the article, use |parts_type=.
subdivision_name1 to subdivision_name6	optional	Use the name in text form, sample: Florida or [[Florida]]. Per MOS:INFOBOXFLAG, flag icons or flag templates should not be used in these fields
Established
established_title	optional	Example: Founded
established_date	optional	Requires established_title=
established_title1	optional	Example: Incorporated (town) [Note that "established_title1" is distinct from "established_title"; you can think of "established_title" as behaving like "established_title0".]
established_date1	optional	[See note for "established_title1".] Requires established_title1=
established_title2	optional	Example: Incorporated (city)
established_date2	optional	Requires established_title2=
established_title3	optional
established_date3	optional	Requires established_title3=
established_title4	optional
established_date4	optional	Requires established_title4=
established_title5	optional
established_date5	optional	Requires established_title5=
established_title6	optional
established_date6	optional	Requires established_title6=
established_title7	optional
established_date7	optional	Requires established_title7=
extinct_title	optional	For when a settlement ceases to exist
extinct_date	optional	Requires extinct_title=
founder	optional	Who the settlement was founded by
named_for	optional	The source of the name of the settlement (a person, a place, et cetera)
Seat of government
seat_type	optional	The label for the seat of government (defaults to Seat).
seat	optional	The seat of government.
Smaller parts (e.g. boroughs of a city)
parts_type	optional	The label for the smaller subdivisions (defaults to Boroughs).
parts_style	optional	Set to list to display as a collapsible list, coll as a collapsed list, or para to use paragraph style. Default is list for up to 5 items, otherwise coll.
parts	optional	Text or header of the list of smaller subdivisions.
p1 p2 to p50	optional	The smaller subdivisions to be listed. Example: Warsaw
Government type, leaders
government_footnotes	optional	Reference(s) for government, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}}
government_type	optional	Examples: Mayor–council government, Council–manager government, City commission government, ...
governing_body	optional	Name of the place's governing body
leader_party	optional	Political party of the place's leader
leader_title	optional	First title of the place's leader, e.g. Mayor
leader_name	optional	Name of the place's leader
leader_title1 to leader_title4	optional
leader_name1 to leader_name4	optional	For long lists use {{Collapsible list}}. See Halifax for an example.
Geographic information
These fields have dual automatic unit conversion meaning that if only metric values are entered, the imperial values will be automatically converted and vice versa. If an editor wishes to over-ride the automatic conversion, e.g. if the source gives both metric and imperial or if a range of values is needed, they should enter both values in their respective fields.
Parameter name	Usage	Description
Display settings
total_type	optional	Specifies what "total" area and population figure refer to, e.g. Greater London. This overrides other labels for total population/area. To make the total area and population display on the same line as the words "Area" and "Population", with no "Total" or similar label, set the value of this parameter to &nbsp;.
unit_pref	optional	To change the unit order to imperial (metric), enter imperial. The default display style is metric (imperial). However, the template will swap the order automatically if the subdivision_name equals some variation of the US or the UK. For the middle east, a unit preference of dunam can be entered (only affects total area). All values must be entered in a raw format: no commas, spaces, or unit symbols. The template will format them automatically.
Area
area_footnotes	optional	Reference(s) for area, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}}
dunam_link	optional	If dunams are used, the default is to link the word dunams in the total area section. This can be changed by setting dunam_link to another measure (e.g. dunam_link=water). Linking can also be turned off by setting the parameter to something else (e.g. dunam_link=none or dunam_link=off).
area_total_km2	optional	Total area in square kilometers—symbol: km2. Value must be entered in raw format, no commas or spaces. Auto-converted to display square miles if area_total_sq_mi is empty.
area_total_ha	optional	Total area in hectares—symbol: ha. Value must be entered in raw format, no commas or spaces. Auto-converted to display acres if area_total_acre is empty.
area_total_sq_mi	optional	Total area in square miles—symbol: sq mi. Value must be entered in raw format, no commas or spaces. Auto-converted to display square kilometers if area_total_km2 is empty.
area_total_acre	optional	Total area in acres. Value must be entered in raw format, no commas or spaces. Auto-converted to display hectares if area_total_ha is empty.
area_total_dunam	optional	Total area in dunams, which is wiki-linked. Used in middle eastern places like Israel, Gaza, and the West Bank. Value must be entered in raw format, no commas or spaces. Auto-converted to display square kilometers or hectares and square miles or acreds if area_total_km2, area_total_ha, area_total_sq_mi, and area_total_acre are empty. Examples: Gaza and Ramallah
area_land_km2	optional	Land area in square kilometers—symbol: km2. Value must be entered in raw format, no commas or spaces. Auto-converted to display square miles if area_land_sq_mi is empty.
area_land_sq_mi	optional	Land area in square miles—symbol: sq mi. Value must be entered in raw format, no commas or spaces. Auto-converted to display square kilometers if area_land_km2 is empty.
area_land_ha	optional	similar to area_total_ha
area_land_dunam	optional	similar to area_total_dunam
area_land_acre	optional	similar to area_total_acre
area_water_km2	optional	Water area in square kilometers—symbol: km2. Value must be entered in raw format, no commas or spaces. Auto-converted to display square miles if area_water_sq_mi is empty.
area_water_sq_mi	optional	Water area in square miles—symbol: sq mi. Value must be entered in raw format, no commas or spaces. Auto-converted to display square kilometers if area_water_km2 is empty.
area_water_ha	optional	similar to area_total_ha
area_water_dunam	optional	similar to area_total_dunam
area_water_acre	optional	similar to area_total_acre
area_water_percent	optional	percent of water without the "%"
area_urban_km2	optional
area_urban_sq_mi	optional
area_urban_ha	optional	similar to area_total_ha
area_urban_dunam	optional	similar to area_total_dunam
area_urban_acre	optional	similar to area_total_acre
area_rural_km2	optional
area_rural_sq_mi	optional
area_rural_ha	optional	similar to area_total_ha
area_rural_dunam	optional	similar to area_total_dunam
area_rural_acre	optional	similar to area_total_acre
area_metro_km2	optional
area_metro_sq_mi	optional
area_metro_ha	optional	similar to area_total_ha
area_metro_dunam	optional	similar to area_total_dunam
area_metro_acre	optional	similar to area_total_acre
area_rank	optional	The settlement's area, as ranked within its parent sub-division
area_blank1_title	optional	Example see London
area_blank1_km2	optional
area_blank1_sq_mi	optional
area_blank1_ha	optional	similar to area_total_ha
area_blank1_dunam	optional	similar to area_total_dunam
area_blank1_acre	optional	similar to area_total_acre
area_blank2_title	optional
area_blank2_km2	optional
area_blank2_sq_mi	optional
area_blank2_ha	optional	similar to area_total_ha
area_blank2_dunam	optional	similar to area_total_dunam
area_blank2_acre	optional	similar to area_total_acre
area_note	optional	A place for additional information such as the name of the source.
Dimensions
dimensions_footnotes	optional	Reference(s) for dimensions, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}}
length_km	optional	Raw number entered in kilometers. Will automatically convert to display length in miles if length_mi is empty.
length_mi	optional	Raw number entered in miles. Will automatically convert to display length in kilometers if length_km is empty.
width_km	optional	Raw number entered in kilometers. Will automatically convert to display width in miles if length_mi is empty.
width_mi	optional	Raw number entered in miles. Will automatically convert to display width in kilometers if length_km is empty.
Elevation
elevation_footnotes	optional	Reference(s) for elevation, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}}
elevation_m	optional	Raw number entered in meters. Will automatically convert to display elevation in feet if elevation_ft is empty. However, if a range in elevation (i.e. 5–50 m ) is desired, use the "max" and "min" fields below
elevation_ft	optional	Raw number, entered in feet. Will automatically convert to display the average elevation in meters if elevation_m field is empty. However, if a range in elevation (e.g. 50–500 ft ) is desired, use the "max" and "min" fields below
elevation_max_footnotes elevation_min_footnotes	optional	Same as above, but for the "max" and "min" elevations. See City of Leeds.
elevation_max_m elevation_max_ft elevation_max_rank elevation_min_m elevation_min_ft elevation_min_rank	optional	Used to give highest & lowest elevations and rank, instead of just a single value. Example: Halifax Regional Municipality.
Population, demographics
The density fields have dual automatic unit conversion meaning that if only metric values are entered, the imperial values will be automatically converted and vice versa. If an editor wishes to over-ride the automatic conversion, e.g. if the source gives both metric and imperial or if a range of values is needed, they can enter both values in their respective fields. To calculate density with respect to the total area automatically, type auto in place of any density value.
Parameter name	Usage	Description
Population
population_total	optional	Actual population (see below for estimates) preferably consisting of digits only (without any commas)
population_as_of	optional	The year for the population total (usually a census year)
population_footnotes	optional	Reference(s) for population, placed within <ref> </ref> tags
population_density_km2	optional
population_density_sq_mi	optional
population_est	optional	Population estimate.
pop_est_as_of	optional	The year or month & year of the population estimate
pop_est_footnotes	optional	Reference(s) for population estimate, placed within <ref> </ref> tags
population_urban	optional
population_urban_footnotes	optional	Reference(s) for urban population, placed within <ref> </ref> tags
population_density_urban_km2	optional
population_density_urban_sq_mi	optional
population_rural	optional
population_rural_footnotes	optional	Reference(s) for rural population, placed within <ref> </ref> tags
population_density_rural_km2	optional
population_density_rural_sq_mi	optional
population_metro	optional
population_metro_footnotes	optional	Reference(s) for metro population, placed within <ref> </ref> tags
population_density_metro_km2	optional
population_density_metro_sq_mi	optional
population_rank	optional	The settlement's population, as ranked within its parent sub-division
population_density_rank	optional	The settlement's population density, as ranked within its parent sub-division
population_blank1_title	optional	Can be used for estimates. Example: Windsor, Ontario
population_blank1	optional	The population value for blank1_title
population_density_blank1_km2	optional
population_density_blank1_sq_mi	optional
population_blank2_title	optional
population_blank2	optional
population_density_blank2_km2	optional
population_density_blank2_sq_mi	optional
population_demonym	optional	A demonym or gentilic is a word that denotes the members of a people or the inhabitants of a place. For example, a citizen in Liverpool is known as a Liverpudlian.
population_demonyms	optional	If more than one demonym, use this
population_note	optional	A place for additional information such as the name of the source. See Windsor, Ontario for example.
Demographics (section 1)
demographics_type1	optional	Section Header. For example: Ethnicity
demographics1_footnotes	optional	Reference(s) for demographics section 1, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}}
demographics1_title1 to demographics1_title7	optional	Titles related to demographics_type1. For example: White, Black, Hispanic...
demographics1_info1 to demographics1_info7	optional	Information related to the "titles". For example: 50%, 25%, 10%...
Demographics (section 2)
demographics_type2	optional	A second section header. For example: Languages
demographics2_footnotes	optional	Reference(s) for demographics section 2, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}}
demographics2_title1 to demographics2_title10	optional	Titles related to demographics_type2. For example: English, French, Arabic...
demographics2_info1 to demographics2_info10	optional	Information related to the "titles" for type2. For example: 50%, 25%, 10%...
Other information
Parameter name	Usage	Description
Time zone(s)
timezone1	optional
utc_offset1	optional	Plain text, e.g. "+05:00" or "-08:00". Auto-linked, so do not include references or additional text.
timezone1_DST	optional
utc_offset1_DST	optional
timezone2	optional	A second timezone field for larger areas such as a Province.
utc_offset2	optional
timezone2_DST	optional
utc_offset2_DST	optional
Postal code(s) & area code
postal_code_type	optional
postal_code	optional
postal2_code_type	optional
postal2_code	optional
area_code_type	optional	If left blank/not used template will default to "Area code(s)"
area_code	optional	Refers to the telephone dialing code for the settlement, not a geographic area code.
area_codes	optional	If more than one area code, use this
geocode	optional	See Geocode
iso_code	optional	See ISO 3166
registration_plate_type	optional	If left blank/not used template will default to "Vehicle registration"
registration_plate	optional	See Vehicle registration plate
Blank fields (section 1)
blank_name_sec1	optional	Fields used to display other information. The name is displayed in bold on the left side of the infobox.
blank_info_sec1	optional	The information associated with the blank_name heading. The info is displayed on right side of infobox, in the same row as the name. For an example, see: Warsaw
blank1_name_sec1 to blank7_name_sec1	optional	Up to 7 additional fields (8 total) can be displayed in this section
blank1_info_sec1 to blank7_info_sec1	optional
Blank fields (section 2)
blank_name_sec2	optional	For a second section of blank fields
blank_info_sec2	optional	Example: Beijing
blank1_name_sec2 to blank7_name_sec2	optional	Up to 7 additional fields (8 total) can be displayed in this section
blank1_info_sec2 to blank7_info_sec2	optional
Website, footnotes
website	optional	External link to official website, Use {{URL}}, thus: {{URL|example.com}}
module	optional	To embed infoboxes at the bottom of the infobox
footnotes	optional	Text to be displayed at the bottom of the infobox

Mapframe maps

• Basic parameters:
  • mapframe – Specify yes or no to show or hide the map, overriding the default. Default: no
  • mapframe-caption – Caption for the map. Default: blank (or if |mapframe-geomask= is set, "Location in geomask's label")
  • mapframe-custom – Use a custom map instead of the automatic mapframe. Specify either a {{maplink}} template, or another template that generates a mapframe map, or an image name. If used, the subsequent mapframe parameters will be ignored. Default: not specified
  • mapframe-id or id or qid – Id (Q-number) of Wikidata item to use. Default: item for current page
  • mapframe-coordinates or mapframe-coord or coordinates or coord – Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template, e.g. |coord={{Coord|12.34|N|56.78|E}}. Default: coordinates from Wikidata
  • mapframe-wikidata – Set to <syntaxhighlight lang="text" class="" style="" inline="1">yes</syntaxhighlight> to show shape/line features from the wikidata item, if any, when |coord= is set. Default: not specified
• Customise which features are displayed:
  • mapframe-shape – Turn off display of shape feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Use an inverse shape (geomask) instead of a regular shape by setting to <syntaxhighlight lang="text" class="" style="" inline="1">inverse</syntaxhighlight>. Default: not specified
  • mapframe-point – Turn off display of point feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Force point marker to be displayed by setting to <syntaxhighlight lang="text" class="" style="" inline="1">on</syntaxhighlight>. Default: not specified
  • mapframe-line – Turn off display of line feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Default: not specified
  • mapframe-geomask – Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for (P17), P131 for (P131)). Default: not specified
  • mapframe-switcher – set to <syntaxhighlight lang="text" class="" style="" inline="1">auto</syntaxhighlight> or <syntaxhighlight lang="text" class="" style="" inline="1">geomasks</syntaxhighlight> or <syntaxhighlight lang="text" class="" style="" inline="1">zooms</syntaxhighlight> to enable Template:Switcher-style switching between multiple mapframes. Default: not specified
    • <syntaxhighlight lang="text" class="" style="" inline="1">auto</syntaxhighlight> – switch geomasks found in (P276) and (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country.
    • <syntaxhighlight lang="text" class="" style="" inline="1">geomasks</syntaxhighlight> – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-geomask parameter
    • <syntaxhighlight lang="text" class="" style="" inline="1">zooms</syntaxhighlight> – switch between "zoomed in"/"zoomed midway"/"zoomed out", where "zoomed in" is the default zoom (with a minimum of <syntaxhighlight lang="text" class="" style="" inline="1">3</syntaxhighlight>), "zoomed out" is <syntaxhighlight lang="text" class="" style="" inline="1">1</syntaxhighlight>, and "zoomed midway" is the average
• Other optional parameters:
  • mapframe-frame-width or mapframe-width – Frame width. Default: 270
  • mapframe-frame-height or mapframe-height – Frame height. Default: 200
  • mapframe-shape-fill – Color used to fill shape features. Default: #606060
  • mapframe-shape-fill-opacity – Opacity level of shape fill, a number between 0 and 1. Default: 0.5
  • mapframe-stroke-color or mapframe-stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
  • mapframe-stroke-width – Width of line features, and outlines of shape features; default is "5". Default: 5
  • mapframe-marker – Marker symbol to use for coordinates; see mw:Help:Extension:Kartographer/Icons for options. Default: not specified (i.e. blank)
    • Can also be set to <syntaxhighlight lang="text" class="" style="" inline="1">blank</syntaxhighlight> to override any default marker symbol
  • mapframe-marker-color or mapframe-marker-colour – Background color for the marker. Default: #5E74F3
  • mapframe-geomask-stroke-color or mapframe-geomask-stroke-colour – Color of outline of geomask shape. Default: #555555
  • mapframe-geomask-stroke-width – Width of outline of geomask shape. Default: 2
  • mapframe-geomask-fill – Color used to fill outside geomask features. Default: #606060
  • mapframe-geomask-fill-opacity – Opacity level of fill outside geomask features, a number between 0 and 1. Default: 0.5
  • mapframe-zoom – Set the zoom level, from "1" (map of earth) to "18" (maximum zoom in), to be used if the zoom level cannot be determined automatically from object length or area. Default: 10
  • mapframe-length_km or mapframe-length_mi or mapframe-area_km2 or mapframe-area_mi2 – Determine zoom level by passing in object's length (in kilometres or miles) or area (in square kilometres or square miles). Default: not specified
  • mapframe-frame-coordinates or mapframe-frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default: derived from item coordinates

Examples

Example 1

Chicago
City
Clockwise from top: Downtown Chicago, the Chicago Theatre, the Chicago 'L', Navy Pier, Millennium Park, the Field Museum, and the Willis (formerly Sears) Tower
Flag Official seal of Chicago Seal
Etymology: Miami-Illinois: shikaakwa ("wild onion" or "wild garlic")
Nicknames:  The Windy City, The Second City, Chi-Town, Chi-City, Hog Butcher for the World, City of the Big Shoulders, The City That Works, and others found at List of nicknames for Chicago
Motto(s):  Latin: Urbs in Horto (City in a Garden), Make Big Plans (Make No Small Plans), I Will
Location in the Chicago metropolitan area and Illinois
Chicago Location in the United States
Coordinates: 41°50′15″N 87°40′55″W
Country	United States
State	Illinois
Counties	Cook, DuPage
Settled	1770s
Incorporated	March 4, 1837
Named for	Miami-Illinois: shikaakwa ("Wild onion")
Government
• Type	Mayor–council
• Mayor	Rahm Emanuel (D)
• Council	Chicago City Council
Area
• City	234.114 sq mi (606.35 km2)
• Land	227.635 sq mi (589.57 km2)
• Water	6.479 sq mi (16.78 km2)  3%
• Urban	2,123 sq mi (5,500 km2)
• Metro	10,874 sq mi (28,160 km2)
Elevation	594 ft (181 m)
Population  (2010)
• City	2,695,598
• Estimate  (2011)	2,707,120
• Rank	3rd US
• Density	11,892.4/sq mi (4,591.7/km2)
• Urban	8,711,000
• Urban density	4,100/sq mi (1,600/km2)
• Metro	9,461,105
• Metro density	870/sq mi (340/km2)
Demonym	Chicagoan
Time zone	UTC−06:00 (CST)
• Summer (DST)	UTC−05:00 (CDT)
Area codes	312, 773, 872
FIPS code	17-14000
GNIS feature ID	423587, 428803
Website	www.cityofchicago.org

<syntaxhighlight lang="wikitext" style="overflow:auto; white-space: pre-wrap;">

Chicago
City
Clockwise from top: Downtown Chicago, the Chicago Theatre, the Chicago 'L', Navy Pier, Millennium Park, the Field Museum, and the Willis (formerly Sears) Tower
Flag Official seal of Chicago Seal
Etymology: Miami-Illinois: shikaakwa ("wild onion" or "wild garlic")
Nicknames:  The Windy City, The Second City, Chi-Town, Chi-City, Hog Butcher for the World, City of the Big Shoulders, The City That Works, and others found at List of nicknames for Chicago
Motto(s):  Latin: Urbs in Horto (City in a Garden), Make Big Plans (Make No Small Plans), I Will
Location in the Chicago metropolitan area and Illinois
Chicago Location in the United States
Coordinates: 41°50′15″N 87°40′55″W
Country	United States
State	Illinois
Counties	Cook, DuPage
Settled	1770s
Incorporated	March 4, 1837
Named for	Miami-Illinois: shikaakwa ("Wild onion")
Government
• Type	Mayor–council
• Mayor	Rahm Emanuel (D)
• Council	Chicago City Council
Area
• City	234.114 sq mi (606.35 km2)
• Land	227.635 sq mi (589.57 km2)
• Water	6.479 sq mi (16.78 km2)  3%
• Urban	2,123 sq mi (5,500 km2)
• Metro	10,874 sq mi (28,160 km2)
Elevation	594 ft (181 m)
Population  (2010)
• City	2,695,598
• Estimate  (2011)	2,707,120
• Rank	3rd US
• Density	11,892.4/sq mi (4,591.7/km2)
• Urban	8,711,000
• Urban density	4,100/sq mi (1,600/km2)
• Metro	9,461,105
• Metro density	870/sq mi (340/km2)
Demonym	Chicagoan
Time zone	UTC−06:00 (CST)
• Summer (DST)	UTC−05:00 (CDT)
Area codes	312, 773, 872
FIPS code	17-14000
GNIS feature ID	423587, 428803
Website	www.cityofchicago.org

</syntaxhighlight>

References

---

Example 2

Detroit
City
Images from top to bottom, left to right: Downtown Detroit skyline, Spirit of Detroit, Greektown, Ambassador Bridge, Michigan Soldiers' and Sailors' Monument, Fox Theatre, and Comerica Park.
Flag Seal
Etymology: French: détroit (strait)
Nickname(s):  The Motor City, Motown, Renaissance City, The D, Hockeytown, The Automotive Capital of the World, Rock City, The 313
Motto(s):  Speramus Meliora; Resurget Cineribus (Latin: We Hope For Better Things; It Shall Rise From the Ashes)
Location within Wayne County and the state of Michigan
Detroit Location within the contiguous United States
Coordinates: 42°19′53″N 83°2′45″W
Country	United States
State	Michigan
County	Wayne
Founded	1701
Incorporated	1806
Government
• Type	Mayor–council
• Mayor	Mike Duggan (D)
• City Council	Members Charles Pugh – Council President Gary Brown – Council President Pro-Tem JoAnn Watson Kenneth Cockrel, Jr. Saunteel Jenkins Andre Spivey James Tate Brenda Jones Kwame Kenyatta
Area
• City	142.87 sq mi (370.03 km2)
• Land	138.75 sq mi (359.36 km2)
• Water	4.12 sq mi (10.67 km2)
• Urban	1,295 sq mi (3,350 km2)
• Metro	3,913 sq mi (10,130 km2)
Elevation	600 ft (200 m)
Population  (2011)
• City	706,585
• Rank	18th in U.S.
• Density	5,142/sq mi (1,985/km2)
• Urban	3,863,924
• Metro	4,285,832 (US: 13th)
• CSA	5,207,434 (US: 11th)
Demonym	Detroiter
Time zone	UTC−5 (EST)
• Summer (DST)	UTC−4 (EDT)
Area code	313
FIPS code	26-22000
GNIS feature ID	1617959, 1626181
Website	DetroitMI.gov

<syntaxhighlight lang="wikitext" style="overflow:auto; white-space: pre-wrap;">

Detroit
City
City of Detroit
Images from top to bottom, left to right: Downtown Detroit skyline, Spirit of Detroit, Greektown, Ambassador Bridge, Michigan Soldiers' and Sailors' Monument, Fox Theatre, and Comerica Park.
Flag Seal
Etymology: French: détroit (strait)
Nickname(s):  The Motor City, Motown, Renaissance City, The D, Hockeytown, The Automotive Capital of the World, Rock City, The 313
Motto(s):  Speramus Meliora; Resurget Cineribus (Latin: We Hope For Better Things; It Shall Rise From the Ashes)
Location within Wayne County and the state of Michigan
Detroit Location within the contiguous United States
Coordinates: 42°19′53″N 83°2′45″W
Country	United States
State	Michigan
County	Wayne
Founded	1701
Incorporated	1806
Government
• Type	Mayor-Council
• Mayor	Mike Duggan (D)
• City Council	Members Charles Pugh – Council President Gary Brown – Council President Pro-Tem JoAnn Watson Kenneth Cockrel, Jr. Saunteel Jenkins Andre Spivey James Tate Brenda Jones Kwame Kenyatta
Area
• City	142.87 sq mi (370.03 km2)
• Land	138.75 sq mi (359.36 km2)
• Water	4.12 sq mi (10.67 km2)
• Urban	1,295 sq mi (3,350 km2)
• Metro	3,913 sq mi (10,130 km2)
Elevation	600 ft (200 m)
Population  (2011)
• City	706,585
• Rank	18th in U.S.
• Density	5,142/sq mi (1,985/km2)
• Urban	3,863,924
• Metro	4,285,832 (US: 13th)
• CSA	5,207,434 (US: 11th)
Demonym	Detroiter
Time zone	UTC−5 (EST)
• Summer (DST)	UTC−4 (EDT)
Area code	313
FIPS code	26-22000
GNIS feature ID	1617959, 1626181
Website	DetroitMI.gov

</syntaxhighlight>

Supporting templates

The following is a list of sub-templates used by Infobox settlement. See the current list of all sub-templates for documentation, sandboxes, testcases, etc.

1. {{Infobox settlement/areadisp}}
2. {{Infobox settlement/densdisp}}
3. {{Infobox settlement/dunam}}
4. {{Infobox settlement/dunam/mag}}
5. {{Infobox settlement/impus}}
6. {{Infobox settlement/impus/mag}}
7. {{Infobox settlement/lengthdisp}}
8. {{Infobox settlement/link}}
9. {{Infobox settlement/metric}}
10. {{Infobox settlement/metric/mag}}
11. {{Infobox settlement/pref}}

Microformat

The HTML markup produced by this template includes an hCard microformat, which makes the place-name and location parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to an address book. Within the hCard is a Geo microformat, which additionally makes the coordinates (latitude & longitude) parsable, so that they can be, say, looked up on a map, or downloaded to a GPS unit. For more information about the use of microformats on Wikipedia, please see the microformat project.

Sub-templates

If the place or venue has "established", "founded", "opened" or similar dates, use {{start date}} for the earliest of those dates unless the date is before 1583 CE.

If it has a URL, use {{URL}}.

Please do not remove instances of these sub-templates.

Classes

hCard uses HTML classes including:

• adr
• agent
• category
• county-name
• extended-address
• fn
• label
• locality
• nickname
• note
• org
• region
• street-address
• uid
• url
• vcard

Geo is produced by calling {{coord}}, and uses HTML classes:

• geo
• latitude
• longitude

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

Precision

When giving coordinates, please use an appropriate level of precision. Do not use {{coord}}'s |name= parameter.

TemplateData

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

TemplateData for Infobox settlement

TemplateData

Infobox for human settlements (cities, towns, villages, communities) as well as other administrative districts, counties, provinces, etc. Template parameters This template has custom formatting. Parameter Description Type Status Common name name This is the usual name in English. If it's not specified, the infobox will use the 'official_name' as a title unless this too is missing, in which case the page name will be used. String suggested Official name official_name The official name in English, if different from 'name'. String suggested Native name native_name This will display under the name/official name. Example Distrito Federal de México String optional Native name language native_name_lang Use ISO 639-1 code, e.g. 'fr' for French. If there is more than one native name in different languages, enter those names using {{lang}} instead. Example zh String optional Other name other_name For places with other commonly used names like Bombay or Saigon. String optional Type of settlement settlement_type type Any type can be entered, such as 'City', 'Town', 'Village', 'Hamlet', 'Municipality', 'Reservation', etc. If set, will be displayed under the names, provided either 'name' or 'official_name' is filled in. Might also be used as a label for total population/area (defaulting to 'City'), if needed to distinguish from 'Urban', 'Rural' or 'Metro' (if urban, rural or metro figures are not present, the label is 'Total' unless 'total_type' is set). String optional Transliteration from language 1 translit_lang1 Will place the entry before the word 'transliteration(s)'. Can be used to specify a particular language, like in Dêlêg, or one may just enter 'Other', like in Gaza's article. String optional Transliteration type for language 1 translit_lang1_type The type of transliteration used for the first language. Example [[Hanyu pinyin]] Line optional Transliteration language 1 info translit_lang1_info Parameters 'translit_lang2_info1' ... 'translit_lang2_info6' are also available, but not documented here. String optional Transliteration language 2 translit_lang2 Will place a second transliteration. See Dêlêg. String optional Image image_skyline Primary image representing the settlement. Commonly a photo of the settlement’s skyline. File optional Image size imagesize Can be used to tweak the size of 'image_skyline' up or down. This can be helpful if an editor wants to make the infobox wider. If used, 'px' must be specified; default size is 250px. String optional Image alt text image_alt Alt (hover) text for the image, used by visually impaired readers who cannot see the image. String optional Image caption image_caption Will place a caption under 'image_skyline' (if present). Content optional Flag image image_flag Used for a flag. File optional Flag size flag_size Can be used to tweak the size of 'image_flag' up or down from 100px as desired. If used, 'px' must be specified; default size is 100px. String optional Flag alt text flag_alt Alt text for the flag. String optional Flag border? flag_border Set to 'no' to remove the border from the flag. Example no Boolean optional Flag link flag_link Link to the flag. String optional Official seal image image_seal An image of an official seal, if the place has one. File optional Seal size seal_size If used, 'px' must be specified; default size is 100px. String optional Seal alt text seal_alt Alt (hover) text for the seal. String optional Seal link seal_link Link to the seal. String optional Coat of arms/shield image image_shield Can be used for a place with a coat of arms. File optional Shield size shield_size If used, 'px' must be specified; default size is 100px. Example 200px String optional Shield alt text shield_alt Alternate text for the shield. String optional Shield link shield_link Can be used if a wiki article if known but is not automatically linked by the template. See Coquitlam, British Columbia's infobox for an example. String optional Blank emblem image image_blank_emblem Can be used if a place has an official logo, crest, emblem, etc. File optional Blank emblem type blank_emblem_type Caption beneath 'image_blank_emblem' to specify what type of emblem it is. Example Logo String optional Blank emblem size blank_emblem_size If used, 'px' must be specified; default size is 100px. Example 200px String optional Blank emblem alt text blank_emblem_alt Alt text for blank emblem. String optional Blank emblem link blank_emblem_link A link to the emblem of custom type. String optional Nickname nickname Well-known nickname(s). Example Sin City String optional Motto motto Will place the motto under the nicknames. String optional Anthem anthem Will place the anthem (song) under the nicknames. Example [[Hatikvah]] String optional Map image image_map A map of the region, or a map with the region highlighted within a parent region. File optional Map size mapsize If used, 'px' must be specified; default is 250px. String optional Map alt text map_alt Alternate (hover) text for the map. String optional Map caption map_caption Caption for the map displayed. Content optional Map 2 image image_map1 A secondary map image. The field 'image_map' must be filled in first. For an example, see [[Bloomsburg, Pennsylvania]]. Example File:Columbia County Pennsylvania Incorporated and Unincorporated areas Bloomsburg Highlighted.svg File optional Map 2 size mapsize1 If used, 'px' must be specified; default is 250px. Example 300px String optional Map 2 alt text map_alt1 Alt (hover) text for the second map. String optional Map 2 caption map_caption1 Caption of the second map. Content optional Pushpin map pushpin_map The name of a location map (e.g. 'Indonesia' or 'Russia'). The coordinates information (from the coordinates parameter) positions a pushpin coordinate marker and label on the map automatically. For an example, see Padang, Indonesia. Example Indonesia String optional Pushpin map size pushpin_mapsize Must be entered as only a number—do not use 'px'. The default value is 250. Example 200 Number optional Pushpin map alt text pushpin_map_alt Alt (hover) text for the pushpin map. String optional Pushpin map caption pushpin_map_caption Fill out if a different caption from 'map_caption' is desired. Example Map showing Bloomsburg in Pennsylvania String optional Pushpin label pushpin_label Label of the pushpin. Example Bloomsburg Line optional Pushpin label position pushpin_label_position The position of the label on the pushpin map relative to the pushpin coordinate marker. Valid options are 'left', 'right', 'top', 'bottom', and 'none'. If this field is not specified, the default value is 'right'. Default right Example left String optional Pushpin outside? pushpin_outside no description Line optional Pushpin relief pushpin_relief Set this to 'y' or any non-blank value to use an alternative relief map provided by the selected location map (if a relief map is available). Example y String optional Pushpin image pushpin_image Image to use for the pushpin. File optional Pushpin overlay pushpin_overlay Can be used to specify an image to be superimposed on the regular pushpin map. File optional Show mapframe map mapframe Specify yes or no to show or hide the map, overriding the default Default no Example yes String suggested Mapframe caption mapframe-caption Caption for the map. If mapframe-geomask is set, then the default is "Location in <<geomask's label>>" String optional Custom mapframe mapframe-custom Use a custom map instead of the automatic mapframe. Specify either a {{maplink}} template, or another template that generates a mapframe map, or an image name. If used, other mapframe parameters will be ignored. Template optional Mapframe Wikidata item mapframe-id id qid Id (Q-number) of Wikidata item to use. Default (item for current page) String optional Mapframe coordinates mapframe-coordinates mapframe-coord coordinates coord Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template. Default (coordinates from Wikidata) Example {{Coord|12.34|N|56.78|E}} Template optional Mapframe shapes from Wikidata mapframe-wikidata et to yes to show shape/line features from the wikidata item, if any, when coordinates are specified by parameter Example yes String optional Mapframe point feature mapframe-point Override display of mapframe point feature. Turn off display of point feature by setting to "none". Force point marker to be displayed by setting to "on" String optional Mapframe shape feature mapframe-shape Override display of mapframe shape feature. Turn off by setting to "none". Use an inverse shape (geomask) instead of a regular shape by setting to "inverse" String optional Mapframe width mapframe-frame-width mapframe-width Frame width in pixels Default 270 Number optional Mapframe height mapframe-frame-height mapframe-height Frame height in pixels Default 200 Number optional Mapframe shape fill mapframe-shape-fill Color used to fill shape features Default #606060 String optional Mapframe shape fill opacity mapframe-shape-fill-opacity Opacity level of shape fill, a number between 0 and 1 Default 0.5 Number optional Mapframe stroke color mapframe-stroke-color mapframe-stroke-colour Color of line features, and outlines of shape features Default #ff0000 String optional Mapframe stroke width mapframe-stroke-width Width of line features, and outlines of shape features Default 5 Number optional Mapframe marker mapframe-marker Marker symbol to use for coordinates; see [[mw:Help:Extension:Kartographer/Icons]] for options Example museum String optional Mapframe marker color mapframe-marker-color mapframe-marker-colour Background color for the marker Default #5E74F3 String optional Mapframe geomask mapframe-geomask Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for country, or P131 for located in the administrative territorial entity) Example Q100 Page name optional Mapframe geomask stroke color mapframe-geomask-stroke-color mapframe-geomask-stroke-colour Color of outline of geomask shape Default #555555 String optional Mapframe geomask stroke width mapframe-geomask-stroke-width Width of outline of geomask shape Default 2 Number optional Mapframe geomask fill mapframe-geomask-fill Color used to fill outside geomask features Default #606060 String optional Mapframe geomask fill opacity mapframe-geomask-fill-opacity Opacity level of fill outside geomask features, a number between 0 and 1 Default 0.5 Number optional Mapframe zoom mapframe-zoom Set the zoom level, from "1" to "18", to used if the zoom level cannot be determined automatically from object length or area Default 10 Example 12 Number optional Mapframe length (km) mapframe-length_km Object length in kilometres, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area Number optional Mapframe length (mi) mapframe-length_mi Object length in miles, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area Number optional Mapframe area (km^2) mapframe-area_km2 Object arean square kilometres, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area Number optional Mapframe area (mi^2) mapframe-area_mi2 Object area in square miles, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area Number optional Mapframe frame coordinates mapframe-frame-coordinates mapframe-frame-coord Alternate latitude and longitude coordinates for initial placement of map, using {{coord}} Example {{Coord|12.35|N|56.71|E}} Template optional Mapframe switcher mapframe-switcher Set to "auto" or "geomasks" or "zooms" to enable Template:Switcher-style switching between multiple mapframes. IF SET TO auto – switch geomasks found in location (P276) and located in the administrative territorial entity (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country. IF SET TO geomasks – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-geomask parameter. IF SET TO zooms – switch between "zoomed in"/"zoomed midway"/"zoomed out", where "zoomed in" is the default zoom (with a minimum of 3), "zoomed out" is 1, and "zoomed midway" is the average. String optional mapframe-line mapframe-line no description Unknown optional Coordinates coordinates Latitude and longitude. Use {{Coord}}. See the documentation for {{Coord}} for more details on usage. Example {{coord|41|50|15|N|87|40|55|W}} Template optional Coordinate pinpoint coor_pinpoint If needed, to specify more exactly where (or what) coordinates are given (e.g. 'Town Hall') or a specific place in a larger area (e.g. a city in a county). Example: Masovian Voivodeship. String optional Coordinates footnotes coordinates_footnotes Reference(s) for coordinates. Placed within <nowiki><ref> </ref></nowiki> tags, possibly using the citing format at {{Cite web}}. String optional Subdivision type 1 subdivision_type Almost always 'Country'. Example [[List of sovereign states|Country]] String optional Subdivision name 1 subdivision_name Depends on 'subdivision_type'. Use the name in text form, e.g., 'United States'. Per MOS:INFOBOXFLAG, flag icons or flag templates may be used in this field. String optional Subdivision type 2 subdivision_type1 Additional subdivisions; can be state/province, region, or county. String optional Subdivision name 2 subdivision_name1 Use the name in text form, e.g., 'Florida' or '[[Florida]]'. Per MOS:INFOBOXFLAG, flag icons or flag templates should not be used in this field. Example [[Connecticut]] String optional Subdivision type 3 subdivision_type2 Additional subdivisions; can be state/province, region, or county. String optional Subdivision name 3 subdivision_name2 Use the name in text form, e.g., 'Florida' or '[[Florida]]'. Per MOS:INFOBOXFLAG, flag icons or flag templates should not be used in this field. Example [[Florida]] String optional Subdivision type 4 subdivision_type3 Additional subdivisions; can be state/province, region, or county. String optional Subdivision name 4 subdivision_name3 Use the name in text form, e.g., 'Florida' or '[[Florida]]'. Per MOS:INFOBOXFLAG, flag icons or flag templates should not be used in this field. Example [[Utah]] String optional Subdivision type 5 subdivision_type4 Additional subdivisions; can be state/province, region, or county. String optional Subdivision name 5 subdivision_name4 Use the name in text form, e.g., 'Florida' or '[[Florida]]'. Per MOS:INFOBOXFLAG, flag icons or flag templates should not be used in this field. Example [[California]] String optional Subdivision type 6 subdivision_type5 Additional subdivisions; can be state/province, region, or county. String optional Subdivision name 6 subdivision_name5 Use the name in text form, e.g., 'Florida' or '[[Florida]]'. Per MOS:INFOBOXFLAG, flag icons or flag templates should not be used in this field. Example [[Vermont]] String optional Subdivision type 7 subdivision_type6 Additional subdivisions; can be state/province, region, or county. String optional Subdivision name 7 subdivision_name6 Use the name in text form, e.g., 'Florida' or '[[Florida]]'. Per MOS:INFOBOXFLAG, flag icons or flag templates should not be used in this field. Example [[Wyoming]] String optional First establishment event established_title Title of the first establishment event. Example First settled String optional First establishment date established_date Date of the first establishment event. Date optional Second establishment event established_title1 Title of the second establishment event. Example Incorporated as a town String optional Second establishment date established_date1 Date of the second establishment event. Date optional Third establishment event established_title2 Title of the third establishment event. Example Incorporated as a city String optional Third establishment date established_date2 Date of the third establishment event. Date optional Fourth establishment event established_title3 Title of the fourth establishment event. Example Incorporated as a county String optional Fourth establishment date established_date3 Date of the fourth establishment event. Date optional Extinction event title extinct_title For when a settlement ceases to exist. Example [[Sack of Rome]] String optional Extinction date extinct_date Date the settlement ceased to exist. String optional Founder founder Who the settlement was founded by. String optional Named for named_for The source of the name of the settlement (a person, a place, et cetera). Example [[Ho Chi Minh]] String optional Seat of government type seat_type The label for the seat of government (defaults to 'Seat'). Default Seat String optional Seat of government seat The seat of government. Example [[White House]] String optional Type of smaller subdivisions parts_type The label for the smaller subdivisions (defaults to 'Boroughs'). Default Boroughs String optional Parts style parts_style Set to 'list' to display as a collapsible list, 'coll' as a collapsed list, or 'para' to use paragraph style. Default is 'list' for up to 5 items, otherwise 'coll'. Example list String optional Smaller subdivisions parts Text or header of the list of smaller subdivisions. String optional Smaller subdivision 1 p1 The smaller subdivisions to be listed. Parameters 'p1' to 'p50' can also be used. String optional Government footnotes government_footnotes Reference(s) for government. Placed within <nowiki><ref> </ref></nowiki> tags, possibly using the citing format at {{Cite web}}. Content optional Government type government_type The place's type of government. Example [[Mayor–council government]] String optional Governing body governing_body Name of the place's governing body. Example Legislative Council of Hong Kong Page name optional Leader political party leader_party Political party of the place's leader. String optional Leader title leader_title First title of the place's leader, e.g. 'Mayor'. Example [[Governor (United States)|Governor]] String optional Leader's name leader_name Name of the place's leader. Example [[Jay Inslee]] String optional Leader title 1 leader_title1 First title of the place's leader, e.g. 'Mayor'. Example Mayor String optional Leader name 1 leader_name1 Additional names for leaders. Parameters 'leader_name1' .. 'leader_name4' are available. For long lists, use {{Collapsible list}}. String optional Total type total_type Specifies what total area and population figure refer to, e.g. 'Greater London'. This overrides other labels for total population/area. To make the total area and population display on the same line as the words ''Area'' and ''Population'', with no ''Total'' or similar label, set the value of this parameter to '&nbsp;'. String optional Unit preference unit_pref To change the unit order to 'imperial (metric)', enter 'imperial'. The default display style is 'metric (imperial)'. However, the template will swap the order automatically if the 'subdivision_name' equals some variation of the US or the UK. For the Middle East, a unit preference of dunam can be entered (only affects total area). All values must be entered in a raw format (no commas, spaces, or unit symbols). The template will format them automatically. Example imperial String optional Area footnotes area_footnotes Reference(s) for area. Placed within <nowiki><ref> </ref></nowiki> tags, possibly using the citing format at {{Cite web}}. String optional Link dunams? dunam_link If dunams are used, the default is to link the word ''dunams'' in the total area section. This can be changed by setting 'dunam_link' to another measure (e.g. 'dunam_link=water'). Linking can also be turned off by setting the parameter to something else (e.g., 'dunam_link=none' or 'dunam_link=off'). Example none Boolean optional Total area (km2) area_total_km2 Total area in square kilometers (symbol: km²). Value must be entered in raw format (no commas or spaces). Auto-converted to display square miles if 'area_total_sq_mi' is empty. Number optional Total area (sq. mi) area_total_sq_mi Total area in square miles (symbol: sq mi). Value must be entered in raw format (no commas or spaces). Auto-converted to display square kilometers if 'area_total_km2' is empty. Number optional Total area (hectares) area_total_ha Total area in hectares (symbol: ha). Value must be entered in raw format (no commas or spaces). Auto-converted to display acres if 'area_total_acre' is empty. Number optional Total area (acres) area_total_acre Total area in acres. Value must be entered in raw format (no commas or spaces). Auto-converted to display hectares if 'area_total_ha' is empty. Number optional Total area (dunams) area_total_dunam Total area in dunams, which is wikilinked. Used in Middle Eastern places like Israel, Gaza, and the West Bank. Value must be entered in raw format (no commas or spaces). Auto-converted to display square kilometers or hectares and square miles or acres if 'area_total_km2', 'area_total_ha', 'area_total_sq_mi', and 'area_total_acre' are empty. Examples: Gaza and Ramallah. Number optional Land area (sq. km) area_land_km2 Land area in square kilometers (symbol: km²). Value must be entered in raw format (no commas or spaces). Auto-converted to display square miles if 'area_land_sq_mi' is empty. Number optional Land area (sq. mi) area_land_sq_mi Land area in square miles (symbol: sq mi). Value must be entered in raw format (no commas or spaces). Auto-converted to display square kilometers if 'area_land_km2' is empty. Number optional Land area (hectares) area_land_ha The place's land area in hectares. Number optional Land area (dunams) area_land_dunam The place's land area in dunams. Number optional Land area (acres) area_land_acre The place's land area in acres. Number optional Water area (sq. km) area_water_km2 Water area in square kilometers (symbol: km²). Value must be entered in raw format (no commas or spaces). Auto-converted to display square miles if 'area_water_sq_mi' is empty. Number optional Water area (sq. mi) area_water_sq_mi Water area in square miles (symbol: sq mi). Value must be entered in raw format (no commas or spaces). Auto-converted to display square kilometers if 'area_water_km2' is empty. Number optional Water area (hectares) area_water_ha The place's water area in hectares. Number optional Water area (dunams) area_water_dunam The place's water area in dunams. Number optional Water area (acres) area_water_acre The place's water area in acres. Number optional Percent water area area_water_percent Percent of water without the %. Example 21 Number optional Urban area (sq. km) area_urban_km2 Area of the place's urban area in square kilometers. Number optional Urban area (sq. mi) area_urban_sq_mi Area of the place's urban area in square miles. Number optional Urban area (hectares) area_urban_ha Area of the place's urban area in hectares. Number optional Urban area (dunams) area_urban_dunam Area of the place's urban area in dunams. Number optional Urban area (acres) area_urban_acre Area of the place's urban area in acres. Number optional Urban area footnotes area_urban_footnotes Reference(s) for the urban area. Placed within <nowiki><ref> </ref></nowiki> tags, possibly using the citing format at {{Cite web}}. String optional Rural area (sq. km) area_rural_km2 Area of the place's rural area in square kilometers. Number optional Rural area (sq. mi) area_rural_sq_mi Area of the place's rural area in square miles. Number optional Rural area (hectares) area_rural_ha Area of the place's rural area in hectares. Number optional Rural area (dunams) area_rural_dunam Area of the place's rural area in dunams. Number optional Rural area (acres) area_rural_acre Area of the place's rural area in acres. Number optional Rural area footnotes area_rural_footnotes Reference(s) for the urban area. Placed within <nowiki><ref> </ref></nowiki> tags, possibly using the citing format at {{Cite web}}. String optional Metropolitan area (sq. km) area_metro_km2 Area of the place's metropolitan area in square kilometers. Number optional Metropolitan area (sq. mi) area_metro_sq_mi Area of the place's metropolitan area in square miles. Number optional Metropolitan area (hectares) area_metro_ha Area of the place's metropolitan area in hectares. Number optional Metropolitan area (dunams) area_metro_dunam Area of the place's metropolitan area in dunams. Number optional Metropolitan area (acres) area_metro_acre Area of the place's metropolitan area in acres. Number optional Metropolitan area footnotes area_metro_footnotes Reference(s) for the urban area. Placed within <nowiki><ref> </ref></nowiki> tags, possibly using the citing format at {{Cite web}}. String optional Area rank area_rank The settlement's area, as ranked within its parent sub-division. String optional First blank area section title area_blank1_title Title of the place's first custom area section. Example see [[London]] String optional Area blank 1 (sq. km) area_blank1_km2 Area of the place's first blank area section in square kilometers. Number optional Area blank 1 (sq. mi) area_blank1_sq_mi Area of the place's first blank area section in square miles. Number optional Area blank 1 (hectares) area_blank1_ha Area of the place's first blank area section in hectares. Number optional Area blank 1 (dunams) area_blank1_dunam Area of the place's first blank area section in dunams. Number optional Area blank 1 (acres) area_blank1_acre Area of the place's first blank area section in acres. Number optional Second blank area section title area_blank2_title Title of the place's second custom area section. String optional Area blank 2 (sq. km) area_blank2_km2 Area of the place's second blank area section in square kilometers. Number optional Area blank 2 (sq. mi) area_blank2_sq_mi Area of the place's second blank area section in square miles. Number optional Area blank 2 (hectares) area_blank2_ha Area of the place's third blank area section in hectares. Number optional Area blank 2 (dunams) area_blank2_dunam Area of the place's third blank area section in dunams. Number optional Area blank 2 (acres) area_blank2_acre Area of the place's third blank area section in acres. Number optional Area footnotes area_note A place for additional information such as the name of the source. Example <ref name="CenPopGazetteer2016">{{cite web|title=2016 U.S. Gazetteer Files|url=https://www2.census.gov/geo/docs/maps-data/data/gazetteer/2016_Gazetteer/2016_gaz_place_42.txt|publisher=United States Census Bureau|access-date=August 13, 2017}}</ref> Content optional Dimensions footnotes dimensions_footnotes Reference(s) for dimensions. Placed within <nowiki><ref> </ref></nowiki> tags, possibly using the citing format at {{Cite web}}. Content optional Length in km length_km Raw number entered in kilometers. Will automatically convert to display length in miles if 'length_mi' is empty. Number optional Length in miles length_mi Raw number entered in miles. Will automatically convert to display length in kilometers if 'length_km' is empty. Number optional Width in kilometers width_km Raw number entered in kilometers. Will automatically convert to display width in miles if 'length_mi' is empty. Number optional Width in miles width_mi Raw number entered in miles. Will automatically convert to display width in kilometers if 'length_km' is empty. Number optional Elevation in meters elevation_m Raw number entered in meters. Will automatically convert to display elevation in feet if 'elevation_ft' is empty. However, if a range in elevation (i.e. 5–50&nbsp;m) is desired, use the 'max' and 'min' fields below. Number optional Elevation in feet elevation_ft Raw number, entered in feet. Will automatically convert to display the average elevation in meters if 'elevation_m' field is empty. However, if a range in elevation (i.e. 50–500&nbsp;ft) is desired, use the 'max' and 'min' fields below. Number optional Elevation footnotes elevation_footnotes Reference(s) for elevation. Placed within <nowiki><ref> </ref></nowiki> tags, possibly using the citing format at {{Cite web}}. String optional Point of min elevation elevation_min_point The name of the point of lowest elevation in the place. Example [[Death Valley]] Line optional Minimum elevation (m) elevation_min_m The minimum elevation in meters. Number optional Minimum elevation (ft) elevation_min_ft The minimum elevation in feet. Number optional Minimum elevation rank elevation_min_rank The point of minimum elevation's rank in the parent region. Example 1st Line optional Min elevation footnotes elevation_min_footnotes Footnotes or citations for the minimum elevation. Content optional Point of max elevation elevation_max_point The name of the point of highest elevation in the place. Example [[Mount Everest]] Line optional Maximum elevation (m) elevation_max_m The maximum elevation in meters. Number optional Maximum elevation (ft) elevation_max_ft The maximum elevation in feet. Number optional Maximum elevation rank elevation_max_rank The point of maximum elevation's rank in the parent region. Example 2nd Line optional Max elevation footnotes elevation_max_footnotes Footnotes or citations for the maximum elevation. Content optional Population total population_total Actual population (see below for estimates) preferably consisting of digits only (without any commas). Number optional Population total figure's year population_as_of The year for the population total (usually a census year). Number optional Population footnotes population_footnotes Reference(s) for population; placed within <nowiki><ref> </ref></nowiki> tags. Content optional Population density (per square km) population_density_km2 The place's population density per square kilometer. Example auto String optional Population density (per square mi) population_density_sq_mi The place's population density per square mile. Example auto String optional Population estimate population_est Population estimate, e.g. for growth projections 4 years after a census. Example 331000000 Number optional Population estimate figure as of pop_est_as_of The year, or the month and year, of the population estimate. Date optional Population estimate footnotes pop_est_footnotes Reference(s) for population estimate; placed within <nowiki><ref> </ref></nowiki> tags. Example <ref name="USCensusEst2016"/> Content optional Urban population population_urban The place's urban population. Number optional Urban population footnotes population_urban_footnotes Reference(s) for urban population; placed within <nowiki><ref> </ref></nowiki> tags. Content optional Urban population density (per square km) population_density_urban_km2 The place's urban population density per square kilometer. Example auto String optional Urban population density (per square mi) population_density_urban_sq_mi The place's urban population density per square mile. Example auto String optional Rural population population_rural The place's rural population. Number optional Rural population footnotes population_rural_footnotes Reference(s) for rural population; placed within <nowiki><ref> </ref></nowiki> tags. Content optional Rural population density per sq. km population_density_rural_km2 The place's rural population density per square kilometer. Example auto Line optional Rural population density per sq. mi population_density_rural_sq_mi The place's rural population density per square mile. Example auto Line optional Metropolitan area population population_metro Population of the place's metropolitan area. Number optional Metropolitan area population footnotes population_metro_footnotes Reference(s) for metro population; placed within <nowiki><ref> </ref></nowiki> tags. String optional Metropolitan population density per sq. km population_density_metro_km2 The place's metropolitan area's population density per square kilometer. Example auto Number optional Metropolitan population density per sq. mi population_density_metro_sq_mi The place's metropolitan area's population density per square mile. Example auto Number optional Population rank population_rank The settlement's population, as ranked within its parent sub-division. String optional Population density rank population_density_rank The settlement's population density, as ranked within its parent sub-division. String optional Custom population type 1 title population_blank1_title Can be used for estimates. For an example, see Windsor, Ontario. Example See: [[Windsor, Ontario]] String optional Custom population type 1 population_blank1 The population value for 'blank1_title'. String optional Custom population type 1 density per sq. km population_density_blank1_km2 Population density per square kilometer, according to the 1st custom population type. String optional Custom population type 1 density per sq. mi population_density_blank1_sq_mi Population density per square mile, according to the 1st custom population type. String optional Custom population type 2 title population_blank2_title Can be used for estimates. For an example, see Windsor, Ontario. Example See: [[Windsor, Ontario]] String optional Custom population type 2 population_blank2 The population value for 'blank2_title'. String optional Custom population type 2 density per sq. km population_density_blank2_km2 Population density per square kilometer, according to the 2nd custom population type. String optional Custom population type 2 density per sq. mi population_density_blank2_sq_mi Population density per square mile, according to the 2nd custom population type. String optional Demonym population_demonym A demonym or gentilic is a word that denotes the members of a people or the inhabitants of a place. For example, a citizen in Liverpool is known as a Liverpudlian. Example Liverpudlian Line optional Population note population_note A place for additional information such as the name of the source. See Windsor, Ontario, for an example. Content optional Demographics type 1 demographics_type1 A sub-section header. Example Ethnicities String optional Demographics section 1 footnotes demographics1_footnotes Reference(s) for demographics section 1. Placed within <nowiki><ref> </ref></nowiki> tags, possibly using the citing format at {{Cite web}}. Content optional Demographics section 1 title 1 demographics1_title1 Titles related to demographics_type1. For example: 'White', 'Black', 'Hispanic'... Additional rows 'demographics1_title1' to 'demographics1_title5' are also available. String optional Demographics type 2 demographics_type2 A second sub-section header. Example Languages Line optional Demographics section 2 footnotes demographics2_footnotes Reference(s) for demographics section 2. Placed within <nowiki><ref> </ref></nowiki> tags, possibly using the citing format at {{Cite web}}. String optional Demographics section 2 title 1 demographics2_title1 Titles related to 'demographics_type1'. For example: 'English', 'French', 'Arabic'... Additional rows 'demographics2_title2' to 'demographics1_title5' are also available. String optional Demographics section 2 info 1 demographics2_info1 Information related to the titles. For example: '50%', '25%', '10%'... Additional rows 'demographics2_info2' to 'demographics2_info5' are also available. Content optional Timezone 1 timezone1 timezone The place's primary time-zone. Example [[Eastern Standard Time]] String optional UTC offset utc_offset The place's time-zone's offset from UTC. Example +8 String optional Timezone during DST timezone_DST The place's time-zone during daylight savings time, if applicable. Example [[Eastern Daylight Time]] String optional UTC offset during DST utc_offset_DST The place's time-zone's UTC offset during daylight savings time, if applicable. Example +9 String optional UTC offset 1 utc_offset1 The place's primary time-zone's offset from UTC. Example -5 String optional Timezone 1 (during DST) timezone1_DST The place's primary time-zone during daylight savings time, if applicable. Example [[Eastern Daylight Time]] String optional UTC offset 1 (during DST) utc_offset1_DST The place's primary time-zone's UTC offset during daylight savings time, if applicable. Example -6 String optional Timezone 2 timezone2 A second timezone field for larger areas such as a province. Example [[Central Standard Time]] String optional UTC offset 2 utc_offset2 The place's secondary time-zone's offset from UTC. Example -6 String optional Timezone 2 during DST timezone2_DST The place's secondary time-zone during daylight savings time, if applicable. Example [[Central Daylight Time]] String optional UTC offset 2 during DST utc_offset2_DST The place's secondary time-zone's offset from UTC during daylight savings time, if applicable. Example -7 String optional Postal code type postal_code_type Label used for postal code info, e.g. 'ZIP Code'. Defaults to 'Postal code'. Example [[Postal code of China|Postal code]] String optional Postal code postal_code The place's postal code/zip code. Example 90210 String optional Postal code 2 type postal2_code_type If applicable, the place's second postal code type. String optional Postal code 2 postal2_code A second postal code of the place, if applicable. Example 90007 String optional Area code area_code The regions' telephone area code. String optional Area code type area_code_type If left blank/not used, template will default to 'Area code(s)'. String optional Geocode geocode See [[Geocode]]. String optional ISO 3166 code iso_code See ISO 3166. String optional Registration/license plate info registration_plate See Vehicle registration plate. String optional Blank name section 1 blank_name_sec1 blank_name Fields used to display other information. The name is displayed in bold on the left side of the infobox. String optional Blank info section 1 blank_info_sec1 blank_info The information associated with the 'blank_name_sec1' heading. The info is displayed on the right side of the infobox in the same row as the name. For an example, see [[Warsaw]]. Content optional Blank 1 name section 1 blank1_name_sec1 Up to 7 additional fields 'blank1_name_sec1' ... 'blank7_name_sec1' can be specified. String optional Blank 1 info section 1 blank1_info_sec1 Up to 7 additional fields 'blank1_info_sec1' ... 'blank7_info_sec1' can be specified. Content optional Blank name section 2 blank_name_sec2 For a second section of blank fields. String optional Blank info section 2 blank_info_sec2 The information associated with the 'blank_name_sec2' heading. The info is displayed on right side of infobox, in the same row as the name. For an example, see [[Warsaw]]. Example Beijing Content optional Blank 1 name section 2 blank1_name_sec2 Up to 7 additional fields 'blank1_name_sec2' ... 'blank7_name_sec2' can be specified. String optional Blank 1 info section 2 blank1_info_sec2 Up to 7 additional fields 'blank1_info_sec2' ... 'blank7_info_sec2' can be specified. Content optional Official website in English website External link to official website. Use the {{URL}} template, thus: {{URL|example.com}}. String optional Footnotes footnotes Text to be displayed at the bottom of the infobox. Content optional Language 1 first transcription translit_lang1_info1 Transcription of type 1 in the first other language. Example {{lang|zh|森美兰}} Line optional Language 1 first transcription type translit_lang1_type1 Type of transcription used in the first language's first transcription. Example [[Chinese Language|Chinese]] Line optional Language 1 second transcription translit_lang1_info2 Transcription of type 1 in the first other language. Example {{lang|ta|நெகிரி செம்பிலான்}} Line optional Language 1 second transcription type translit_lang1_type2 Type of transcription used in the first language's first transcription. Example [[Tamil Language|Tamil]] Line optional Demographics section 1 info 1 demographics1_info1 Information related to the titles. For example: '50%', '25%', '10%'... Additional rows 'demographics1_info1' to 'demographics1_info5' are also available. Content optional

Calls and redirects

At least 3 other templates call this one.

Several templates redirect here.

Tracking categories

1. Category:Pages using infobox settlement with bad settlement type (3,597)
2. Category:Pages using infobox settlement with image map1 but not image map (30,081)
3. Category:Pages using infobox settlement with missing country (1,909)
4. Category:Pages using infobox settlement with no map (26,703)
5. Category:Pages using infobox settlement with no coordinates (42,778)
6. Category:Pages using infobox settlement with possible area code list (7,189)
7. Category:Pages using infobox settlement with possible demonym list (1,053)
8. Category:Pages using infobox settlement with possible motto list (1,361)
9. Category:Pages using infobox settlement with possible nickname list (741)
10. Category:Pages using infobox settlement with the wikidata parameter (0)
11. Category:Pages using infobox settlement with unknown parameters (1,591)
12. Category:Pages using infobox settlement with conflicting parameters (0)
13. Category:Pages using infobox settlement with ignored type (0)
14. Category:Templates calling Infobox settlement (3)

The above documentation is transcluded from Template:Infobox settlement/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template.