Template:Infobox settlement/doc

Usage
For questions see the talk page.
 * 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.
 * Empty Syntax

Table
{| class="wikitable" style="background-color: white;"
 * colspan=3 style="background-color: orange;" |This table is still under construction.

Name and motto

 * style="background-color: whitesmoke;" | Field Name
 * style="background-color: whitesmoke;" | Usage
 * style="background-color: whitesmoke;" | Description
 * - valign=top
 * official_name || required || 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 official name in parentheses as such: Warsaw (Warszawa)
 * - valign=top
 * settlement_type || optional ||Any type of settlement can be entered, such as towns or villages (Leave blank for the default&mdash;City). Examples: see Town, Village, Hamlet, Governorate, Reservation.
 * - valign=top
 * nickname || optional ||For a well known nickname(s).
 * - valign=top
 * motto || optional ||Will place the motto under the nicknames
 * colspan=3 style="background-color: orange;" |
 * colspan=3 style="background-color: orange;" |
 * colspan=3 style="background-color: orange;" |

Images and maps

 * colspan=3 | These variables are only used for generating categories for this article
 * style="background-color: whitesmoke;" | Field Name
 * style="background-color: whitesmoke;" | Usage
 * style="background-color: whitesmoke;" | Description
 * - 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.
 * - valign=top
 * flag_link  || optional ||
 * - valign=top
 * image_seal || optional ||If the place has an official seal.
 * - valign=top
 * seal_link  || optional ||
 * - valign=top
 * seal_size || optional ||
 * - 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.
 * - valign=top
 * shield_size || optional ||
 * - valign=top
 * city_logo || optional || If a place has an official logo
 * - valign=top
 * logo_link  || optional ||
 * - valign=top
 * image_map || optional ||
 * - valign=top
 * mapsize || optional ||
 * - valign=top
 * 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.
 * - valign=top
 * mapsize1 || optional ||
 * - valign=top
 * 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.
 * colspan=3 style="background-color: orange;" |
 * pushpin_map_caption || optional ||Fill out if a different caption from map_caption is desired.
 * colspan=3 style="background-color: orange;" |
 * colspan=3 style="background-color: orange;" |

Government and Established information

 * style="background-color: whitesmoke;" | Field Name
 * style="background-color: whitesmoke;" | Usage
 * style="background-color: whitesmoke;" | Description
 * - valign=top
 * subdivision_type || optional ||This field is almost always "Country".
 * - valign=top
 * 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
 * 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.
 * - valign=top
 * government_type || optional || Example:
 * - 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 "& 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.
 * - valign=top
 * established_title || optional || Example: First settled
 * - valign=top
 * established_date  || optional ||
 * - valign=top
 * established_title2  || optional ||Example: Incorporated (town)
 * - valign=top
 * established_date2 || optional ||
 * - valign=top
 * established_title3  || optional ||Example: Incorporated (city)
 * - valign=top
 * established_date3 || optional ||
 * colspan=3 style="background-color: orange;" |
 * colspan=3 style="background-color: orange;" |
 * colspan=3 style="background-color: orange;" |

Geographic information

 * 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 vise-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 should enter both values in their respective fields.
 * style="background-color: whitesmoke;" | Field Name
 * style="background-color: whitesmoke;" | Usage
 * style="background-color: whitesmoke;" | Description
 * - valign=top
 * unit_pref || optional ||If the editor would like to change the unit order to imperial (metric) they should enter imperial. The default is metric (imperial). However, template will swap the unit order automatically if the subdivision_name equals same variation of the U.S. 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 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.
 * - 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_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 
 * - valign=top
 * area_water_percent || optional || Enter the percent of water without the "%"
 * - valign=top
 * area_urban_km2 || optional || Deprecated name =area_urban 
 * - valign=top
 * area_urban_sq_mi || optional || Deprecated name =UrbanArea_sq_mi 
 * - valign=top
 * area_metro_km2  || optional || Deprecated name =area_metro 
 * - valign=top
 * area_metro_sq_mi || optional || Deprecated name =MetroArea_sq_mi 
 * - valign=top
 * area_blank1_title || optional || Example see London
 * - valign=top
 * area_blank1_km2 || optional ||
 * - valign=top
 * area_blank1_sq_mi || optional ||
 * - valign=top
 * area_blank2_title || optional ||
 * - valign=top
 * area_blank2_km2 || optional ||
 * - valign=top
 * area_blank2_sq_mi || optional ||
 * - valign=top
 * elevation_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.
 * - 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_ft field to over-ride the automatic conversion. Deprecated name =elevation 
 * - valign=top
 * 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.
 * - valign=top
 * 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.


 * - valign=top
 * latd || optional ||Latitude degrees. Can also be used for decimal degrees.
 * - valign=top
 * latm  || optional ||Latitude minutes
 * - valign=top
 * lats || optional ||Latitude seconds
 * - valign=top
 * latNS || optional ||Latitude North or South.
 * - valign=top
 * longd || optional ||
 * - valign=top
 * longm || optional ||
 * - valign=top
 * longs || optional ||
 * - valign=top
 * longEW || optional ||
 * colspan=3 style="background-color: orange;" |
 * colspan=3 style="background-color: orange;" |

Population infomation

 * 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 vise-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 should enter both values in their respective fields.
 * style="background-color: whitesmoke;" | Field Name
 * style="background-color: whitesmoke;" | Usage
 * style="background-color: whitesmoke;" | Description
 * - valign=top
 * population_as_of  || optional ||
 * - valign=top
 * population_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.
 * - valign=top
 * 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
 * - valign=top
 * population_metro || optional ||
 * - valign=top
 * population_density_metro_km2 || optional ||
 * - valign=top
 * population_density_metro_sq_mi || optional || Deprecated name =population_density_metro_mi2
 * - valign=top
 * population_urban  || optional ||
 * - valign=top
 * population_density_urban_km2 || optional ||
 * - valign=top
 * population_density_urban_sq_mi || optional || Deprecated name =population_density_urban_mi2
 * - valign=top
 * population_blank1_title || optional || Can be used for estimates. Example: Windsor, Ontario
 * - valign=top
 * population_blank1 || optional || The population value for blank1_title
 * - valign=top
 * population_density_blank1_km2 || optional ||
 * - valign=top
 * population_density_blank1_sq_mi || optional ||
 * - valign=top
 * population_blank2_title || optional ||
 * - valign=top
 * population_blank2 || optional ||
 * - valign=top
 * population_density_blank2_km2 || optional ||
 * - valign=top
 * population_density_blank2_sq_mi || optional ||
 * - valign=top
 * population_note || optional ||A place for additional infomation such as the name of the source. See Windsor, Ontario for example.
 * colspan=3 style="background-color: orange;" |
 * population_note || optional ||A place for additional infomation such as the name of the source. See Windsor, Ontario for example.
 * colspan=3 style="background-color: orange;" |
 * colspan=3 style="background-color: orange;" |

Other infomation

 * style="background-color: whitesmoke;" | Field Name
 * style="background-color: whitesmoke;" | Usage
 * style="background-color: whitesmoke;" | Description
 * - valign=top
 * timezone || optional ||
 * - valign=top
 * utc_offset || optional ||
 * - valign=top
 * timezone_DST || optional ||
 * - valign=top
 * utc_offset_DST || optional ||
 * - valign=top
 * postal_code_type || optional ||
 * - valign=top
 * postal_code || optional ||
 * - valign=top
 * area_code || optional ||
 * - valign=top
 * 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 || optional ||
 * - valign=top
 * blank1_info || optional ||
 * - valign=top
 * footnotes || optional ||
 * - valign=top
 * website || optional ||
 * website || optional ||


 * }

Usage Example
from San Jose, California--Note Pipe characters are in front of the line of cell data, instead of at the end of the line, which makes it easier to include both sq km and sq mi for area cells (as well as simplifying the spacing):

da:Skabelon:Infoboks by es:Plantilla:Infobox City hu:Sablon:Infobox város ja:Template:Infobox City no:Mal:Infoboks_by pt:Predefinição:Infobox Cidade ro:Format:Infobox City simple:Template:Infobox City sl:Predloga:Infopolje Naselje fi:Malline:Kaupunki2 sv:Mall:Ortsfakta vi:Tiêu bản:Tóm tắt về thành phố zh:Template:Infobox City