Template:Infobox Settlement/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:Infobox Settlement (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.
Warning Before making any changes to the template, please first try and compare your changes in the test template: Template:Infobox Settlement/sandbox. Thank you.
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.

Contents

[edit] 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.


  • Complete Empty Syntax --- For questions see the talk page.


  • Basic Empty Syntax --- For questions see the talk page.


[edit] Table

[edit] Name and motto
Field 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
other_name optional For places with a former or more common name like Bombay or Saigon
native_name optional This will display under the name/official name
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   (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

[edit] Images and maps
These variables are only used for generating categories for this article
Field Name Usage Description
image_skyline optional Despite the name it can be any image that an editor wishes. Default size will be 250px
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.
image_caption optional Will place a caption under the image_skyline (if present)
image_flag optional Used for a flag. Default size:100px
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
image_shield optional Can be used for a place with a coat of arms.
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
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
blank_emblem_type optional To specify what type of emblem "image_blank_emblem" is. The default is Logo.
blank_emblem_size optional Deprecated name =citylogo_size
blank_emblem_link optional Deprecated name =logo_link
image_map optional
mapsize optional
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
map_caption1 optional
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.
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 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_mapsize optional Must be entered as only a number—no need for px. The default value is 250.
pushpin_map_caption optional Fill out if a different caption from map_caption is desired.

[edit] Location, subdivisions, government and established information
Field Name Usage Description
subdivision_type optional almost always "Country"
subdivision_name optional Depends on the subdivision_type
subdivision_type1
to
subdivision_type4		 optional Can be State/Province, region, county.
subdivision_name1
to
subdivision_name4		 optional
seat_type optional The label for the seat of government (defaults to Seat).
seat optional The seat of government.
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, etc. optional (maximum p50) The smaller subdivisions to be listed. Example: Springfield
government_footnotes optional If a reference(s) is available this where to put them using the <ref> </ref> 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.
leader_title optional First title of the place's leader, e.g. Mayor
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 "&nbsp;" to disable the link
leader_title1
to
leader_title4		 optional
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
named_for optional The source of the name of the settlement (a person, a place, et cetera)

[edit] 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.
Field Name Usage Description
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_footnotes optional If reference(s) are available, this is where to put them, possibly using a citing format such as {{Cite web}}, within <ref> </ref> tags.
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²
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_total_km2 optional Total area in square kilometers—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
area_land_km2 optional Land area in square kilometers—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
area_water_km2 optional Water area in square kilometers—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
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 comms or spaces. Auto-converted to display square kilometers if area_total_km2 is empty.
Deprecated name =TotalArea_sq_mi
area_land_sq_mi optional Land area in square miles—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
area_water_sq_mi optional Water area in square miles—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 <ref> </ref> tags.
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_ft field to over-ride the automatic conversion.
Deprecated name =elevation
elevation_ft optional Raw number, entered in feet. Will automatically convert to display 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.
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
coor_type optional If needed, to specify more exactly which coordinates are given (e.g. Town Hall).
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.
longd optional
longm optional
longs optional
longEW optional

[edit] Population information
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.
Field Name Usage Description
population_as_of optional
population_footnotes optional If reference(s) are available, this is where to put them, possibly using a citing format such as {{Cite web}}, within <ref> </ref> tags.
population_total optional
population_density_km2 optional Deprecated name =population_density
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
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.
population_note optional A place for additional information such as the name of the source. See Windsor, Ontario for example.

[edit] Other information
Field Name Usage Description
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
blank_info optional This is where the information for the blank_name would go. Example see: Warsaw.
blank1_name
to
blank6_name		 optional
blank1_info
to
blank6_info		 optional
twin1
to
twin7		 optional Name of a twin city
twin1_country
to
twin7_country		 optional Country of the twin city
footnotes optional
website optional

[edit] 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 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.

hCard uses HTML classes including:

  • "adr"
  • "county-name"
  • "fn"
  • "label"
  • "locality"
  • "nickname"
  • "note"
  • "org"
  • "region"
  • "street-address"
  • "vcard"

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

  • "geo"
  • "latitude"
  • "longitude"

Please do not rename or remove these classes.

When giving coordinates, please don't be overly precise.

[edit] 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:

{{Infobox Settlement
 | official_name = City of Detroit
 | nickname = Motor City, Motown, Rock City, The D
 | motto = "Speramus Meliora; Resurget Cineribus"<br />([[Latin]] for, "We Hope For Better Things; It Shall Rise From the Ashes")
 | image_skyline = DetroitSkyline.jpg
 | image_flag = Detroit flag.png
 | image_seal = Detroit Seal.png
 | image_map = Wayne County Michigan Incorporated and Unincorporated areas Detroit highlighted.svg
 | map_caption = Location in [[Wayne County, Michigan|Wayne County]], [[Michigan]]
 | subdivision_type = [[Countries of the world|Country]]
 | subdivision_type1 = [[U.S. state|State]]
 | subdivision_type2 = [[List of counties in Michigan|County]]
 | subdivision_name = [[United States]]
 | subdivision_name1 = [[Michigan]]
 | subdivision_name2 = [[Wayne County, Michigan|Wayne County]]
 | established_title = Founded
 | established_date = [[1701]]
 | established_title2 = Incorporation
 | established_date2 = [[1806]]
 | government_type = [[Mayor-council government|Strong Mayor-Council]]
 | leader_title =[[List of mayors of Detroit, Michigan|Mayor]]
 | leader_name =[[Kwame Kilpatrick]] (D)
 | area_magnitude = 1 E8
 | area_total_sq_mi =143.0
 | area_total_km2 = 370.2
 | area_land_sq_mi = 138.8
 | area_land_km2 = 359.4
 | area_water_sq_mi = 4.2
 | area_water_km2 = 10.8
 | area_urban_sq_mi = 1295
 | area_urban_km2 = 3354
 | area_metro_km2 = 10135
 | area_metro_sq_mi = 3913
 | population_as_of=2006
 | population_footnotes =<ref>{{cite web
                         | url  = http://www.census.gov/popest/estimates.php
                         | title= US Census July 1, 2006 est}}</ref>
 | population_total = 871121
 | population_urban = 3903377
 | population_metro = 4468966
 | population_density_sq_mi = 6856
 | population_density_km2 = 2647
 | timezone = [[Eastern Time Zone (North America)|EST]]
 | utc_offset = -5
 | timezone_DST = [[Eastern Daylight Time|EDT]]
 | utc_offset_DST = -4
 | latd = 42 | latm = 19 | lats = 53.76 | latNS = N
 | longd = 83 | longm = 2 | longs = 51 | longEW = W
 | elevation_footnotes=<ref name=elevation>{{cite web
                                      | url  ={{Gnis3|1617959}}
                                      | title=USGS detail on Detroit
                                      | accessdate=2007-02-18 }}</ref>
 | elevation_ft = 600
 | elevation_m = 183
 | website = http://www.detroitmi.gov
 | footnotes =
}}