Template:Infobox settlement
{{{official_name}}} |
---|
This template employs intricate features of template syntax. You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here. |
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.
Redirects and calls
At least 0 other templates call this one and many templates redirect here.
Usage
- 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.
- 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
{{Infobox settlement <!-- See Template:Infobox settlement for additional fields and descriptions --> | name = | native_name = | native_name_lang = <!-- ISO 639-2 code e.g. "fr" for French. If more than one, use {{lang}} instead --> | settlement_type = | image_skyline = | image_alt = | image_caption = | image_flag = | flag_alt = | image_seal = | seal_alt = | image_shield = | shield_alt = | nickname = | motto = | image_map = | map_alt = | map_caption = | pushpin_map = | pushpin_label_position = | pushpin_map_alt = | pushpin_map_caption = | latd = |latm = |lats = |latNS = | longd = |longm = |longs = |longEW = | coor_pinpoint = | coordinates_type = | coordinates_display = inline,title | coordinates_footnotes = | subdivision_type = Country | subdivision_name = | subdivision_type1 = | subdivision_name1 = | subdivision_type2 = | subdivision_name2 = | subdivision_type3 = | subdivision_name3 = | established_title = | established_date = | founder = | seat_type = | seat = | government_footnotes = | leader_party = | leader_title = | leader_name = | unit_pref = Metric<!-- or US or UK --> | area_footnotes = | area_total_km2 = | area_land_km2 = | area_water_km2 = | area_water_percent = | area_note = | elevation_footnotes = | elevation_m = | population_footnotes = | population_total = | population_as_of = | population_density_km2 = auto | population_demonym = | population_note = | timezone1 = | utc_offset1 = | timezone1_DST = | utc_offset1_DST = | postal_code_type = | postal_code = | area_code_type = | area_code = | iso_code = | website = <!-- {{URL|example.com}} --> | footnotes = }}
Using non-metric units
{{Infobox settlement <!-- See Template:Infobox settlement for additional fields and descriptions --> | name = | native_name = | native_name_lang = <!-- ISO 639-2 code e.g. "fr" for French. If more than one, use {{lang}} instead --> | settlement_type = | image_skyline = | image_alt = | image_caption = | image_flag = | flag_alt = | image_seal = | seal_alt = | image_shield = | shield_alt = | nickname = | motto = | image_map = | map_alt = | map_caption = | pushpin_map = | pushpin_label_position = | pushpin_map_alt = | pushpin_map_caption = | latd = |latm = |lats = |latNS = | longd = |longm = |longs = |longEW = | coor_pinpoint = | coordinates_type = | coordinates_display = inline,title | coordinates_footnotes = | subdivision_type = Country | subdivision_name = | subdivision_type1 = | subdivision_name1 = | subdivision_type2 = | subdivision_name2 = | subdivision_type3 = | subdivision_name3 = | established_title = | established_date = | founder = | seat_type = | seat = | government_footnotes = | leader_party = | leader_title = | leader_name = | unit_pref = US<!-- or UK or Metric --> | area_footnotes = | area_total_sq_mi = | area_land_sq_mi = | area_water_sq_mi = | area_water_percent = | area_note = | elevation_footnotes = | elevation_ft = | population_footnotes = | population_total = | population_as_of = | population_density_sq_mi= auto | population_demonym = | population_note = | timezone1 = | utc_offset1 = | timezone1_DST = | utc_offset1_DST = | postal_code_type = | postal_code = | area_code_type = | area_code = | iso_code = | website = <!-- {{URL|example.com}} --> | footnotes = }}
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.
{{Infobox settlement <!-- See Template:Infobox settlement for additional fields and descriptions --> | name = <!-- at least one of the first two fields must be filled in --> | official_name = | native_name = <!-- if different from the English name --> | native_name_lang = <!-- ISO 639-2 code e.g. "fr" for French. If more than one, use {{lang}} instead --> | other_name = | settlement_type = <!-- such as Town, Village, City, Borough etc. --> <!-- transliteration(s) --------> | translit_lang1 = | translit_lang1_type = | translit_lang1_info = | translit_lang1_type1 = | translit_lang1_info1 = | translit_lang1_type2 = | translit_lang1_info2 = <!-- etc., up to translit_lang1_type6 / translit_lang1_info6 --> | translit_lang2 = | translit_lang2_type = | translit_lang2_info = | translit_lang2_type1 = | translit_lang2_info1 = | translit_lang2_type2 = | translit_lang2_info2 = | translit_lang2_info2 = <!-- etc., up to translit_lang2_type6 / translit_lang2_info6 --> <!-- images, nickname, motto ---> | image_skyline = | imagesize = | image_alt = | image_caption = | image = <!-- other image (specify File: or Image: namespace) --> | image_flag = | flag_size = | flag_alt = | flag_link = | image_seal = | seal_size = | seal_alt = | seal_link = | image_shield = | shield_size = | shield_alt = | shield_link = | image_blank_emblem = | blank_emblem_type = <!-- defaults to Logo --> | blank_emblem_size = | blank_emblem_alt = | blank_emblem_link = | nickname = | motto = | anthem = <!-- maps and coordinates ------> | image_map = | mapsize = | map_alt = | map_caption = | image_map1 = | mapsize1 = | map_alt1 = | map_caption1 = | image_dot_map = | dot_mapsize = | dot_map_base_alt = | dot_map_alt = | dot_map_caption = | dot_x = |dot_y = | pushpin_map = <!-- name of a location map as per Template:Location_map --> | pushpin_label_position = <!-- position of the pushpin label: left, right, top, bottom, none --> | pushpin_label = <!-- only necessary if "name" or "official_name" are too long --> | pushpin_map_alt = | pushpin_mapsize = | pushpin_map_caption = | pushpin_map1 = | pushpin_label_position1 = | pushpin_label1 = <!-- only necessary if "name" or "official_name" are too long --> | pushpin_map_alt1 = | pushpin_mapsize1 = | pushpin_map_caption1 = | latd = |latm = |lats = |latNS = | longd = |longm = |longs = |longEW = | coor_pinpoint = <!-- to specify exact location of coordinates (was coor_type) --> | coordinates_region = <!-- ISO 3166-1 alpha-2 or ISO 3166-2 code for country/region containing the coordinates --> | coordinates_type = <!-- parameter list passed to Coord template, overrides coordinates_region --> | coordinates_display = inline,title | coordinates_format = dms | coordinates_footnotes = <!-- for references: use <ref> tags --> <!-- location ------------------> | subdivision_type = Country | subdivision_name = <!-- the name of the country --> | subdivision_type1 = | subdivision_name1 = | subdivision_type2 = | subdivision_name2 = <!-- etc., subdivision_type6 / subdivision_name6 --> <!-- established ---------------> | established_title = <!-- Settled --> | established_date = | established_title1 = <!-- Incorporated (town) --> | established_date1 = | established_title2 = <!-- Incorporated (city) --> | established_date2 = | established_title3 = | established_date3 = | extinct_title = | extinct_date = | founder = | named_for = <!-- seat, smaller parts -------> | seat_type = <!-- defaults to: Seat --> | seat = | parts_type = <!-- defaults to: Boroughs --> | parts_style = <!-- list, coll (collapsed list), para (paragraph format) --> | parts = <!-- parts text, or header for parts list --> | p1 = | p2 = <!-- etc., up to p50: for separate parts to be listed--> <!-- government type, leaders --> | government_footnotes = <!-- for references: use <ref> tags --> | government_type = | governing_body = | leader_party = | leader_title = | leader_name = <!-- add (no-break space) to disable automatic links --> | leader_title1 = | leader_name1 = <!-- etc., up to leader_title4 / leader_name4 --> <!-- display settings ---------> | total_type = <!-- to set a non-standard label for total area and population rows --> | unit_pref = <!-- enter: Imperial, to display imperial before metric --> <!-- area ----------------------> | area_footnotes = <!-- for references: use <ref> tags --> | area_magnitude = <!-- use only to set a special wikilink --> | area_total_km2 = <!-- ALL fields with measurements have automatic unit conversion --> | area_total_sq_mi = <!-- see table @ Template:Infobox settlement for details --> | area_total_dunam = <!-- used in Middle East articles only --> | area_land_km2 = | area_land_sq_mi = | area_water_km2 = | area_water_sq_mi = | area_water_percent = | area_urban_footnotes = <!-- for references: use <ref> tags --> | area_urban_km2 = | area_urban_sq_mi = | area_rural_footnotes = <!-- for references: use <ref> tags --> | area_rural_km2 = | area_rural_sq_mi = | area_metro_footnotes = <!-- for references: use <ref> tags --> | area_metro_km2 = | area_metro_sq_mi = | area_rank = | area_blank1_title = | area_blank1_km2 = | area_blank1_sq_mi = | area_blank2_title = | area_blank2_km2 = | area_blank2_sq_mi = | area_note = <!-- elevation -----------------> | elevation_footnotes = <!-- for references: use <ref> tags --> | elevation_m = | elevation_ft = | elevation_max_footnotes = <!-- for references: use <ref> tags --> | elevation_max_m = | elevation_max_ft = | elevation_min_footnotes = <!-- for references: use <ref> tags --> | elevation_min_m = | elevation_min_ft = <!-- population ----------------> | population_footnotes = <!-- for references: use <ref> tags --> | population_total = | population_as_of = | population_rank = | population_density_km2 = <!-- for automatic calculation of any density field, use: auto --> | population_density_sq_mi= | population_est = | pop_est_as_of = | population_urban = | population_density_urban_km2 = | population_density_urban_sq_mi = | population_rural = | population_density_rural_km2 = | population_density_rural_sq_mi = | population_metro = | population_density_metro_km2 = | population_density_metro_sq_mi = | population_density = | population_density_rank = | population_blank1_title = | population_blank1 = | population_density_blank1_km2 = | population_density_blank1_sq_mi= | population_blank2_title = | population_blank2 = | population_density_blank2_km2 = | population_density_blank2_sq_mi= | population_demonym = <!-- demonym, ie. Liverpudlian for someone from Liverpool --> | population_note = <!-- demographics (section 1) --> | demographics_type1 = | demographics1_footnotes = <!-- for references: use <ref> tags --> | demographics1_title1 = | demographics1_info1 = <!-- etc., up to demographics1_title5 / demographics1_info5 --> <!-- demographics (section 2) --> | demographics_type2 = | demographics2_footnotes = <!-- for references: use <ref> tags --> | demographics2_title1 = | demographics2_info1 = <!-- etc., up to demographics2_title5 / demographics2_info5 --> <!-- time zone(s) --------------> | timezone1 = | utc_offset1 = | timezone1_DST = | utc_offset1_DST = | timezone2 = | utc_offset2 = | timezone2_DST = | utc_offset2_DST = <!-- postal codes, area code ---> | postal_code_type = <!-- enter ZIP code, Postcode, Post code, Postal code... --> | postal_code = | postal2_code_type = <!-- enter ZIP code, Postcode, Post code, Postal code... --> | postal2_code = | area_code_type = <!-- defaults to: Area code(s) --> | area_code = | geocode = | iso_code = | registration_plate = <!-- twin cities ---------------> | twin1 = | twin1_country = | twin2 = | twin2_country = <!-- etc., up to twin9 / twin9_country --> <!-- blank fields (section 1) --> | blank_name_sec1 = | blank_info_sec1 = | blank1_name_sec1 = | blank1_info_sec1 = | blank2_name_sec1 = | blank2_info_sec1 = <!-- etc., up to blank7_name_sec1 / blank7_info_sec1 --> <!-- blank fields (section 2) --> | blank_name_sec2 = | blank_info_sec2 = | blank1_name_sec2 = | blank1_info_sec2 = | blank2_name_sec2 = | blank2_info_sec2 = <!-- etc., up to blank7_name_sec2 / blank7_info_sec2 --> <!-- website, footnotes --------> | website = <!-- {{URL|example.com}} --> | footnotes = }}
Parameter names and descriptions
Name and transliteration | ||
---|---|---|
Parameter name | Usage | Description |
name | required if official_name missing | The usual name in English |
official_name | required if name missing | The official name in English |
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. |
other_name | optional | For places with a former or more common name 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, provided that 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). |
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 |
Skyline image | ||
image_skyline | optional | Despite the name it can be any image that an editor wishes. |
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. If used, px must be specified; default size is 250px. |
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_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 | 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. Logo is the default type. See Kingston upon Hull's infobox for an example. |
blank_emblem_type | optional | To specify what type of emblem "image_blank_emblem" is. The default is Logo. |
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 and Motto | ||
nickname | optional | well-known nickname(s) |
motto | optional | Will place the motto under the nicknames |
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 | |
Dot map | ||
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 |
dot_mapsize | optional | To change the dot map size; default is 180px (px is optional). |
dot_map_base_alt | optional | |
dot_map_alt | optional | Alt text for the dot map. |
dot_map_caption | optional | For placing a caption under the dot map. |
dot_x dot_y |
optional | For manually superimposing the dot left/right and up/down on the map. |
Pushpin map(s), Coordinates | ||
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 |
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. |
pushpin_map_alt | optional | Alt text for pushpin map. |
pushpin_mapsize | optional | Must be entered as only a number—do not use px. The default value is 250. |
pushpin_map_caption | optional | Fill out if a different caption from map_caption is desired. |
pushpin_map1 | optional | Set of parameters for second pushpin map |
pushpin_label_position1 | optional | |
pushpin_map_alt1 | optional | |
pushpin_mapsize1 | optional | Must be entered as only a number—do not use px. |
pushpin_map_caption1 | optional | |
latd | optional | Latitude degrees. Can also be used for decimal degrees. |
latm | optional | Latitude minutes. Omit or leave blank if latd has a decimal value. |
lats | optional | Latitude seconds. Omit or leave blank if latd has a decimal value. |
latNS | optional | Latitude North or South (enter N or S). Omit or leave blank if latd has a decimal value. |
longd | optional | Longitude degrees. Can also be used for decimal degrees. |
longm | optional | Longitude minutes. Omit or leave blank if longd has a decimal value. |
longs | optional | Longitude seconds. Omit or leave blank if longd has a decimal value. |
longEW | optional | Longitude East or West (enter E or W). Omit or leave blank if longd has a decimal value. |
Coordinates display | ||
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 |
coordinates_region | optional | Can be used to override the default region: for the coordinates. Use either a two character ISO 3166-1 alpha-2 country code or an ISO 3166-2 region code. If coordinates_region is omitted or blank, region: will be set according to subdivision_name, using {{CountryAbbr}}. For example, subdivision_name = United Kingdom will generate coordinates with "region:GB". In addition, for Canada, India, and the United States, subdivision_name1 will be used to determine the region. For example: subdivision_name=Canada and subdivision_name1=Ontario will yield "region:CA-ON". |
coordinates_type | optional | Can be used to override the default coordinate parameters for the coordinates. May include type:, scale:, dim:, region:, and/or source:, joined by underscores ("_"). If coordinates_type is omitted or blank:
|
coordinates_display | optional | If the parameter is omitted or blank, the coordinates will be displayed in the infobox only. Any value will have the coordinates displayed in the article's title as well. |
coordinates_format | optional | If the parameter is omitted or blank, the coordinates format will match the format in which the coordinates are specified Set to dms to force degrees/minutes/seconds or dec to force decimal. |
coordinates_footnotes | optional | Reference(s) for coordinates, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}} |
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 or [[United States]], don't add flag icons or flag templates in this field. |
subdivision_type1 to subdivision_type6 |
optional | Can be State/Province, region, county. |
subdivision_name1 to subdivision_name6 |
optional | Use the name in text form, sample: Florida or [[Florida]]. Don't add flag icons or flag templates in this field. |
Established | ||
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 | |
extinct_title | optional | For when a settlement ceases to exist |
extinct_date | optional | |
founder | optional | The name of the settlement's founder |
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 | Example: Mayor-council 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 . |
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. |
Area | ||
area_footnotes | optional | Reference(s) for area, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}} |
area_magnitude | optional | Area magnitude of total_area in terms of m2. Should enter 1 E+6 for area of 1.0 km2. See 1 E+6 m² |
area_total_km2 | optional | Total area in square kilometers—symbol: km2, 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. |
area_total_sq_mi | optional | Total area in square miles—symbol: sq mi, which is wiki-linked. 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_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 |
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_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_percent | optional | percent of water without the "%" |
area_urban_km2 | optional | |
area_urban_sq_mi | optional | |
area_rural_km2 | optional | |
area_rural_sq_mi | optional | |
area_metro_km2 | optional | |
area_metro_sq_mi | optional | |
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_blank2_title | optional | |
area_blank2_km2 | optional | |
area_blank2_sq_mi | optional | |
area_note | optional | A place for additional information such as the name of the source. |
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 (i.e. 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 Leeds. |
elevation_max_m elevation_max_ft elevation_min_m elevation_min_ft |
optional | Used to give highest & lowest elevations, 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_footnotes | optional | Reference(s) for population, placed within <ref> </ref> tags |
population_as_of | optional | The year for the population total (usually a census year) |
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 |
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 citizens in Liverpool are known as Liverpudlians. |
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_title5 |
optional | Titles related to demographics_type1. For example: White, Black, Hispanic... |
demographics1_info1 to demographics1_info5 |
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_title5 |
optional | Titles related to demographics_type2. For example: English, French, Arabic... |
demographics2_info1 to demographics2_info5 |
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 | |
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 | |
geocode | optional | See Geocode |
iso_code | optional | See ISO 3166 |
registration_plate | optional | See Vehicle registration plate |
Twin cities | ||
twin1 to twin9 |
optional | Name of a twin city |
twin1_country to twin9_country |
optional | Country of the twin city |
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}} |
footnotes | optional | Text to be displayed at the bottom of the infobox |
Example
from Detroit -- Note Pipe characters are in front of the line of cell data, instead of at the end of the line, which simplify the spacing:
{{Infobox settlement <!-- See Template:Infobox settlement for additional fields and descriptions --> |official_name = Detroit |settlement_type = City |image_skyline = Thomaspaine'smontageofDetroit request2.jpg |imagesize = 270px |image_caption = ''Top: International skyline. Middle: [[List of buildings located along Woodward Avenue, Detroit|Woodward Avenue]], [[Renaissance Center]] (General Motors World Headquarters), Lobby of the [[Detroit Institute of Arts]] Bottom: [[Ambassador Bridge]], Old [[Wayne County Building]], [[One Detroit Center]]'' |image_flag = Flag of Detroit, Michigan.svg |image_seal = Detroit seal.jpg |nickname = The Motor City, Motown, The Renaissance City, The D, Hockeytown<!--5 is enough! DO NOT ADD ANYMORE. The article covers them!--> |motto = "Speramus Meliora; Resurget Cineribus"<br />([[Latin]] for, "We Hope For Better Things; It Shall Rise From the Ashes") |image_map = Wayne_County_Michigan_Incorporated_and_Unincorporated_areas_Detroit_highlighted.svg |mapsize = 250x200px |map_caption = Location in [[Wayne County, Michigan|Wayne County]], [[Michigan]] |latd = 42 |latm = 19 |lats = 53 |latNS = N |longd = 83 |longm = 02 |longs = 45 |longEW = W |coordinates_display = yes |coordinates_footnotes = <ref name="GNIS">{{cite gnis|1617959|Detroit|2009-07-27}}.</ref> |pushpin_map =USA |pushpin_map_caption = Location in the United States |subdivision_type = Country |subdivision_name = United States |subdivision_type1 = [[U.S. state|State]] |subdivision_name1 = [[Michigan]] |subdivision_type2 = [[List of counties in Michigan|County]] |subdivision_name2 = [[Wayne County, Michigan|Wayne]] |established_title = Founded |established_date = 1701 |established_title2 = Incorporation |established_date2 = 1806 |government_footnotes = <!-- for references: use <ref> tags --> |government_type = [[Mayor-council government|Mayor-Council]] |leader_title = [[List of mayors of Detroit, Michigan|Mayor]] |leader_name = [[Dave Bing]] |leader_party = D |leader_title1 = City Council |leader_name1 = {{Collapsible list |title = Members' List |frame_style = border:none; padding: 0; |title_style = <!-- (optional) --> |list_style = text-align:left;display:none; |1 = • [[Charles Pugh]] - Council President |2 = • [[Gary Brown (Detroit politician)|Gary Brown]] - Council President Pro-Tem |3 = • [[JoAnn Watson]] |4 = • [[Kenneth V. Cockrel, Jr.]] |5 = • [[Saunteel Jenkins]] |6 = • [[Andre Spivery]] |7 = • [[James Tate (Detroit politician)|James Tate]] |8 = • [[Brenda Jones (Detroit politician)|Brenda Jones]] |9 = • [[Kwame Kenyatta]] }} |area_footnotes = <!-- for references: use <ref> tags --> |area_magnitude = 1 E8 |area_total_sq_mi = 143.0 |area_land_sq_mi = 138.8 |area_water_sq_mi = 4.2 |area_urban_sq_mi = 1295 |area_metro_sq_mi = 3913 |elevation_footnotes = <ref name="GNIS" /> |elevation_ft = 600 |population_footnotes = <ref name=CensusCSA/> |population_as_of = 2008 |population_total = 912062 |population_rank = [[List of United States cities by population|11th in U.S.]] |population_urban = 3903377 |population_metro = 4425110 |population_blank1_title = [[Combined statistical area|CSA]] |population_blank1 = 5354225 |population_density_sq_mi= auto |population_demonym = Detroiter |population_note = |timezone = [[Eastern Time Zone (North America)|EST]] |utc_offset = −5 |timezone_DST = [[Eastern Daylight Time|EDT]] |utc_offset_DST = −4 |postal_code_type = |postal_code = |area_code = [[Area code 313|313]] |blank_name = [[Federal Information Processing Standard|FIPS code]] |blank_info = 26-22000 {{GR|2}} |blank1_name = [[Geographic Names Information System|GNIS]] feature ID |blank1_info = 1617959 <ref name="GNIS" /> |blank2_name = Major airport |blank2_info = [[Detroit Metropolitan Wayne County Airport]] (DTW) |website = {{URL|DetroitMI.gov}} |footnotes = }}
Microformat
The HTML mark up produced by this template includes an hCard microformat, which makes the place-name and location parsable by computers, either acting automatically to catalogue article across LIMSwiki, 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 geographic coordinates (latitude & longitude) parsable, so that they can be, say, looked up on a map, or downloaded to a Global Positioning System (GPS) unit. For more information about how microformats are being used on, for example, Wikipedia, see WikiProject Microformats.
If the place or venue has an "established", "founded", "opened" or similar date, use {{Start date}} (unless the date is before 1583 CE).
If it has a URL, use {{URL}}.
hCard uses HTML classes including:
- adr
- agent
- category
- county-name
- extended-address
- fn
- label
- locality
- nickname
- note
- org
- region
- street-address
- 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.
When giving coordinates, please don't be overly precise.
The above documentation is transcluded from Template:Infobox settlement/doc. (edit | history) Editors can experiment in this template's sandbox (create) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template. |