Template:Infobox settlement/doc

This template can be used to produce an Infobox for human settlements (cities, towns, villages, communities) as well as other administrative districts, counties, provinces, etc. - in fact, any subdivision below the level of a country, for which Infobox Country should be used. Available fields are described in the table below.

Usage
'''Please verify that adding the template does not overlay, or get overlaid by, other templates on the article. Please test your changes with several skins and several browsers, and several browser window sizes.'''


 * Important: Please enter all numeric values in a raw, unformatted fashion. References 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.

Complete Empty Syntax
For questions see the talk page.

Basic Empty Syntax
For questions see the talk page.

Table
{| class="wikitable" style="background: white" ! colspan=3 style="background: orange;" |

Name and motto
! Field Name ! Usage ! Description ! colspan=3 style="background: orange;" |
 * - style="background: whitesmoke;"
 * - valign=top
 * name || required if official_name missing || The usual name in English
 * - valign=top
 * official_name || required if name missing || The official name in English
 * - valign=top
 * other_name || optional || For places with a former or more common name like Bombay or Saigon
 * - valign=top
 * native_name || optional ||This will display under the name/official name
 * native_name_lang || optional ||Use [|ISO 639-2] code, e.g. "fr" for French. If there is more than one native name, in different languages, enter those names using lang, instead.
 * 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, provided that name is filled in. Might also be used as a label for total population/area (defaulting to City), if needed to distinguish from Urban or Metro (if urban and metro figures are not present, the label is Total unless total_type is set).
 * total_type || optional ||Specifies what "total" area and population figure refer to, e.g. Greater London. This overrides other labels for total population/area. For no label, can be set to &nbsp&#59; (this precise value also causes the total population to be displayed on the same line as the word Population).
 * nickname || optional || well-known nickname(s)
 * motto || optional ||Will place the motto under the nicknames
 * 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 || optional ||
 * translit_lang1_info || optional ||
 * translit_lang2 || optional ||Will place a second transliteration. See Dêlêg
 * translit_lang2_type || optional ||
 * translit_lang2_info || optional ||
 * 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 || optional ||
 * translit_lang1_info || optional ||
 * translit_lang2 || optional ||Will place a second transliteration. See Dêlêg
 * translit_lang2_type || optional ||
 * translit_lang2_info || optional ||
 * translit_lang2 || optional ||Will place a second transliteration. See Dêlêg
 * translit_lang2_type || optional ||
 * translit_lang2_info || optional ||
 * translit_lang2_info || optional ||
 * translit_lang2_info || optional ||

Images and maps
! Field Name ! Usage ! Description ! colspan=3 style="background: orange;" |
 * colspan=3 | These variables are only used for generating categories for this article
 * - style="background: whitesmoke;"
 * - style="background: whitesmoke;"
 * - valign=top
 * image_skyline || optional || Despite the name it can be any image that an editor wishes. Default size will be 250px
 * - valign=top
 * imagesize || optional || Can be used to tweak the size of the image_skyline up or down. This can can helpful if an editor want to make the infobox wider.
 * - valign=top
 * image_caption || optional || Will place a caption under the image_skyline (if present)
 * - valign=top
 * image_flag || optional || Used for a flag. Default size:100px
 * - valign=top
 * flag_size  || optional || Can be used to tweak the size of the image_flag up or down from 100px as desired.
 * flag_link  || optional ||
 * image_seal || optional ||If the place has an official seal.
 * seal_link  || optional ||
 * seal_size || optional ||Default is 100px.
 * - valign=top
 * image_shield  || optional || Can be used for a place with a coat of arms.
 * - valign=top
 * 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.
 * shield_size || optional ||Default is 100px.
 * - valign=top
 * image_blank_emblem || optional || Can be used if a place has an official logo, crest, emblem, etc.  Logo is the default type.  See Kingston upon Hull's infobox for an example. Deprecated name =city_logo 
 * - valign=top
 * blank_emblem_type || optional || To specify what type of emblem "image_blank_emblem" is. The default is Logo.
 * - valign=top
 * blank_emblem_size  || optional ||Default is 100px. Deprecated name =citylogo_size 
 * - valign=top
 * blank_emblem_link  || optional || Deprecated name =logo_link 
 * image_map || optional ||
 * mapsize || optional ||Default is 250px.
 * map_caption || optional ||
 * - valign=top
 * image_map1 || optional ||A secondary map image. The field image_map must be filled in first.  Example see: Bloomsburg, Pennsylvania.
 * mapsize1 || optional ||Default is 250px.
 * map_caption1 || optional ||
 * - valign=top
 * image_dot_map || optional ||A field for manually superimposing a dot over a blank map using an "X" & "Y" system. Blank maps, if available, can be found over at Wikimedia Commons.  Example see: Rainbow Lake, Alberta
 * - valign=top
 * dot_mapsize || optional || To change the dot map size; default is 180px.
 * - valign=top
 * dot_map_caption || optional || For placing a caption under the dot map.
 * - valign=top
 * dot_x dot_y || optional ||For manually superimposing the dot left/right and up/down on the map.
 * - valign=top
 * pushpin_map || optional ||The name of a location map as per Template:Location map (eg. Indonesia or Russia). The coordinate fields (eg. latd and longd) position a pushpin coordinate marker and label on the map automatically. Example see: Padang, Indonesia
 * - valign=top
 * 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.
 * - valign=top
 * pushpin_mapsize || optional ||Must be entered as only a number&mdash;no need for px. The default value is 250.
 * - valign=top
 * pushpin_map_caption || optional ||Fill out if a different caption from map_caption is desired.
 * - valign=top
 * dot_x dot_y || optional ||For manually superimposing the dot left/right and up/down on the map.
 * - valign=top
 * pushpin_map || optional ||The name of a location map as per Template:Location map (eg. Indonesia or Russia). The coordinate fields (eg. latd and longd) position a pushpin coordinate marker and label on the map automatically. Example see: Padang, Indonesia
 * - valign=top
 * 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.
 * - valign=top
 * pushpin_mapsize || optional ||Must be entered as only a number&mdash;no need for px. The default value is 250.
 * - valign=top
 * pushpin_map_caption || optional ||Fill out if a different caption from map_caption is desired.

Location, subdivisions, government and established information
! Field Name ! Usage ! Description ! colspan=3 style="background: orange;" |
 * - style="background: whitesmoke;"
 * subdivision_type || optional || almost always "Country"
 * subdivision_name || optional ||Depends on the subdivision_type
 * - valign=top
 * subdivision_type1 to subdivision_type4 || optional ||Can be State/Province, region, county.
 * - valign=top
 * subdivision_name1 to subdivision_name4 || optional ||
 * - valign=top
 * seat_type || optional ||The label for the seat of government (defaults to Seat).
 * seat || optional ||The seat of government.
 * - valign=top
 * parts_type || optional ||The label for the smaller subdivisions (defaults to Boroughs).
 * - valign=top
 * 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.
 * - valign=top
 * parts || optional ||Text or header of the list of smaller subdivisions.
 * - valign=top
 * p1, p2, etc. || optional ||(maximum p50) The smaller subdivisions to be listed. Example: Warsaw
 * - valign=top
 * government_footnotes || optional ||If a reference(s) is available this where to put them using the tags and possibly the citing format at Cite web within the ref tags.
 * government_type || optional || Example:
 * leader_party || optional || Political party of the place's leader.
 * - valign=top
 * leader_title || optional || First title of the place's leader, e.g. Mayor
 * - valign=top
 * leader_name  || optional || Tip: Names are automatically wiki-linked if an article exists; if the target is not the intended one, insert a character such as "&amp;nbsp;" to disable the link
 * - valign=top
 * leader_title1 to leader_title4 || optional ||
 * - valign=top
 * leader_name1 to leader_name4 || optional || For long lists use Collapsible list. See Halifax for an example.
 * established_title || optional || Example: First settled
 * established_date  || optional ||
 * established_title1  || optional ||Example: Incorporated (town)
 * established_date1 || optional ||
 * established_title2  || optional ||Example: Incorporated (city)
 * established_date2 || optional ||
 * established_title3  || optional ||
 * established_date3 || optional ||
 * founder || optional || The name of the settlement's founder
 * - valign=top
 * named_for || optional || The source of the name of the settlement (a person, a place, et cetera)
 * established_date1 || optional ||
 * established_title2  || optional ||Example: Incorporated (city)
 * established_date2 || optional ||
 * established_title3  || optional ||
 * established_date3 || optional ||
 * founder || optional || The name of the settlement's founder
 * - valign=top
 * named_for || optional || The source of the name of the settlement (a person, a place, et cetera)
 * established_date3 || optional ||
 * founder || optional || The name of the settlement's founder
 * - valign=top
 * named_for || optional || The source of the name of the settlement (a person, a place, et cetera)
 * - valign=top
 * named_for || optional || The source of the name of the settlement (a person, a place, et cetera)

Geographic information
! Field Name ! Usage ! Description ! colspan=3 style="background: orange;" |
 * colspan=3 | 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.
 * - style="background: whitesmoke;"
 * - style="background: whitesmoke;"
 * - valign=top
 * 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 USA 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.
 * - valign=top
 * area_footnotes || optional ||If reference(s) are available, this is where to put them, possibly using a citing format such as Cite web, within tags.
 * - valign=top
 * area_magnitude || optional || Area magnitude of total_area in terms of m². Should enter 1 E+6 for area of 1.0 km². See 1 E+6 m²
 * - valign=top
 * 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 and square miles if area_total_km2 and area_total_sq_mi are empty. Examples: Gaza and Ramallah
 * - valign=top
 * area_total_km2 || optional || Total area in square kilometers&mdash;symbol: km², which is wiki-linked. Value must be entered in raw format, no commas or spaces. Auto-converted to display square miles if area_total_sq_mi is empty. Deprecated name =area_total 
 * - valign=top
 * area_land_km2 || optional || Land area in square kilometers&mdash;symbol: km². Value must be entered in raw format, no comms or spaces. Auto-converted to display square miles if area_land_sq_mi is empty. Deprecated name =area_land
 * - valign=top
 * area_water_km2 || optional ||Water area in square kilometers&mdash;symbol: km². Value must be entered in raw format, no comms or spaces. Auto-converted to display square miles if area_water_sq_mi is empty. Deprecated name =area_water
 * - valign=top
 * area_total_sq_mi || optional ||Total area in square miles&mdash;symbol: sq mi, which is wiki-linked. Value must be entered in raw format, no comms or spaces. Auto-converted to display square kilometers if area_total_km2 is empty. Deprecated name =TotalArea_sq_mi
 * - valign=top
 * area_land_sq_mi  || optional ||Land area in square miles&mdash;symbol: sq mi. Value must be entered in raw format, no comms or spaces. Auto-converted to display square kilometers if area_land_km2 is empty. Deprecated name =LandArea_sq_mi 
 * - valign=top
 * area_water_sq_mi || optional ||Water area in square miles&mdash;symbol: sq mi. Value must be entered in raw format, no comms or spaces. Auto-converted to display square kilometers if area_water_km2 is empty. Deprecated name =WaterArea_sq_mi 
 * area_water_percent || optional || percent of water without the "%"
 * area_urban_km2 || optional || Deprecated name =area_urban 
 * area_urban_sq_mi || optional || Deprecated name =UrbanArea_sq_mi 
 * area_metro_km2  || optional || Deprecated name =area_metro 
 * area_metro_sq_mi || optional || Deprecated name =MetroArea_sq_mi
 * area_blank1_title || optional || Example see London
 * area_blank1_km2 || optional ||
 * area_blank1_sq_mi || optional ||
 * area_blank2_title || optional ||
 * area_blank2_km2 || optional ||
 * area_blank2_sq_mi || optional ||
 * elevation_footnotes || optional ||If reference(s) are available, this is where to put them, possibly using a citing format such as Cite web, within tags.
 * - valign=top
 * 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, the editor must enter a converted range in the elevation_m field to over-ride the automatic conversion. use the "max" and "min" fields below Deprecated name =elevation 
 * - valign=top
 * 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 (i.e. 50–500 ft ) is desired, the editor must enter a converted range in the elevation_m field to over-ride the automatic conversion. use the "max" and "min" fields below
 * - valign=top
 * elevation_max_m, elevation_max_ft, elevation_min_m, elevation_min_ft|| optional ||Used to give highest and/or lowest elevations, if available, instead of just a single value. Example: Halifax Regional Municipality
 * - valign=top
 * 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: Masovian Voivodeship Deprecated name =coor_type 
 * coordinates_type || optional ||If needed, to specify region, type and scale in accordance with how it is done at coord, i.e. .  See Birmingham or Pie Town for examples.
 * coordinates_display || optional || =inline,title is used to set Geobox coor title= parameter which in turn sets Coord display=inline,title parameter, causing coordinates to display in an article's title bar upper-right corner. It is recommended that this be done for an article's "main" coordinates, usually those in the Infobox, so that they are accessible to other services like Google Earth, Google Maps, Wikipedia-World and other such services, for more information see: Manual of Style (dates and numbers), Coord/doc, and About the Google Earth Geographic Web Layer.  If a "competing" template also has coordinates in the title bar and cannot be "turned off", then either the inline,title parameter value can be omitted or coordinates_display= parameter field can be omitted to "turn it off".
 * latd || optional ||Latitude degrees. Can also be used for decimal degrees.
 * latm  || optional ||Latitude minutes
 * lats || optional ||Latitude seconds
 * latNS || optional ||Latitude North or South (enter N or S).
 * longd || optional ||Longitude degrees. Can also be used for decimal degrees.
 * longm || optional ||Longitude minutes
 * longs || optional ||Longitude seconds
 * longEW || optional ||Longitude East or West (enter E or W).
 * - valign=top
 * 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: Masovian Voivodeship Deprecated name =coor_type 
 * coordinates_type || optional ||If needed, to specify region, type and scale in accordance with how it is done at coord, i.e. .  See Birmingham or Pie Town for examples.
 * coordinates_display || optional || =inline,title is used to set Geobox coor title= parameter which in turn sets Coord display=inline,title parameter, causing coordinates to display in an article's title bar upper-right corner. It is recommended that this be done for an article's "main" coordinates, usually those in the Infobox, so that they are accessible to other services like Google Earth, Google Maps, Wikipedia-World and other such services, for more information see: Manual of Style (dates and numbers), Coord/doc, and About the Google Earth Geographic Web Layer.  If a "competing" template also has coordinates in the title bar and cannot be "turned off", then either the inline,title parameter value can be omitted or coordinates_display= parameter field can be omitted to "turn it off".
 * latd || optional ||Latitude degrees. Can also be used for decimal degrees.
 * latm  || optional ||Latitude minutes
 * lats || optional ||Latitude seconds
 * latNS || optional ||Latitude North or South (enter N or S).
 * longd || optional ||Longitude degrees. Can also be used for decimal degrees.
 * longm || optional ||Longitude minutes
 * longs || optional ||Longitude seconds
 * longEW || optional ||Longitude East or West (enter E or W).
 * latNS || optional ||Latitude North or South (enter N or S).
 * longd || optional ||Longitude degrees. Can also be used for decimal degrees.
 * longm || optional ||Longitude minutes
 * longs || optional ||Longitude seconds
 * longEW || optional ||Longitude East or West (enter E or W).
 * longm || optional ||Longitude minutes
 * longs || optional ||Longitude seconds
 * longEW || optional ||Longitude East or West (enter E or W).
 * longEW || optional ||Longitude East or West (enter E or W).
 * longEW || optional ||Longitude East or West (enter E or W).

Population information
! Field Name ! Usage ! Description ! colspan=3 style="background: orange;" |
 * colspan=3 | 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 automatically, type auto in place of any density value.
 * - style="background: whitesmoke;"
 * - style="background: whitesmoke;"
 * population_as_of  || optional ||
 * - valign=top
 * population_footnotes || optional ||If reference(s) are available, this is where to put them, possibly using a citing format such as Cite web, within tags.
 * population_total || optional ||
 * - valign=top
 * population_density_km2 || optional || Deprecated name =population_density
 * - valign=top
 * population_density_sq_mi || optional || Deprecated name =population_density_mi2
 * population_metro || optional ||
 * population_density_metro_km2 || optional ||
 * population_density_metro_sq_mi || optional || Deprecated name =population_density_metro_mi2
 * population_urban  || optional ||
 * population_density_urban_km2 || optional ||
 * population_density_urban_sq_mi || optional || Deprecated name =population_density_urban_mi2
 * 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 ||
 * - valign=top
 * population_demonym || Not currently available || A demonym or gentilic is a word that denotes the members of a people or the inhabitants of a place. For example citizens in Liverpool are known as Liverpudlians.
 * - valign=top
 * population_note || optional ||A place for additional information such as the name of the source. See Windsor, Ontario for example.
 * 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 ||
 * - valign=top
 * population_demonym || Not currently available || A demonym or gentilic is a word that denotes the members of a people or the inhabitants of a place. For example citizens in Liverpool are known as Liverpudlians.
 * - valign=top
 * population_note || optional ||A place for additional information such as the name of the source. See Windsor, Ontario for example.
 * population_density_blank2_sq_mi || optional ||
 * - valign=top
 * population_demonym || Not currently available || A demonym or gentilic is a word that denotes the members of a people or the inhabitants of a place. For example citizens in Liverpool are known as Liverpudlians.
 * - valign=top
 * population_note || optional ||A place for additional information such as the name of the source. See Windsor, Ontario for example.
 * population_note || optional ||A place for additional information such as the name of the source. See Windsor, Ontario for example.

Other information
! Field Name ! Usage ! Description
 * - style="background: whitesmoke;"
 * timezone || optional ||
 * utc_offset || optional ||
 * timezone_DST || optional ||
 * utc_offset_DST || optional ||
 * postal_code_type || optional ||
 * postal_code || optional ||
 * area_code || optional ||
 * blank_name || optional ||Can be used for additional information such as car plates
 * - valign=top
 * blank_info || optional || This is where the information for the blank_name would go. Example see: Warsaw.
 * - valign=top
 * blank1_name to blank6_name || optional ||
 * - valign=top
 * blank1_info to blank6_info || optional ||
 * - valign=top
 * twin1 to twin7 || optional || Name of a twin city
 * twin1_country to twin7_country || optional || Country of the twin city
 * footnotes || optional ||
 * website || optional ||
 * blank1_name to blank6_name || optional ||
 * - valign=top
 * blank1_info to blank6_info || optional ||
 * - valign=top
 * twin1 to twin7 || optional || Name of a twin city
 * twin1_country to twin7_country || optional || Country of the twin city
 * footnotes || optional ||
 * website || optional ||
 * footnotes || optional ||
 * website || optional ||
 * website || optional ||


 * }

Usage Example
from Detroit, Michigan -- Note Pipe characters are in front of the line of cell data, instead of at the end of the line, which simplify the spacing:

bg:Шаблон:Селище ca:Plantilla:Infotaula de municipi cs:Šablona:Infobox sídla světa da:Skabelon:Infoboks by dsb:Pśedłoga:Infokašćik Město es:Plantilla:Infobox City eo:Ŝablono:Urbokadro hsb:Předłoha:Město lv:Veidne:Infobox Settlement hu:Sablon:Infobox város ia:Patrono:Infobox Settlement mk:Шаблон:Инфокутија Град ja:Template:Infobox City ka:თარგი:ინფოდაფა დასახლება ko:틀:도시 정보 no:Mal:Infoboks by pt:Predefinição:Infobox Cidade ro:Format:Infobox Localitate ru:Шаблон:НП simple:Template:Infobox City sl:Predloga:Infopolje Naselje fi:Malline:Kaupunki2 sv:Mall:Ortsfakta th:แม่แบบ:กล่องข้อมูล เมือง tr:Şablon:Kent bilgi kutusu uk:Шаблон:Картка:Місто vi:Tiêu bản:Tóm tắt về thành phố zh:Template:Infobox City