Template:Settlement/doc
This template should 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 Template:Country should be used. Available fields are described in the table below. For questions see the talk page.
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.
- Expression Error may also be caused when any coordinate parameter has a value, but one or more coordinate parametes 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.
{{Settlement <!-- See Template:Settlement for additional fields and descriptions --> |name = |settlement_type = |image_skyline = |imagesize = |image_alt = |image_caption = |image_flag = |flag_size = |flag_alt = |image_seal = |seal_size = |seal_alt = |image_shield = |shield_size = |shield_alt = |image_blank_emblem = |blank_emblem_type = |blank_emblem_size = |blank_emblem_alt = |nickname = |motto = |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 = |pushpin_label_position = |pushpin_map_alt = |pushpin_mapsize = |pushpin_map_caption = -->|latd = |latm = |lats = |latNS = |longd = |longm = |longs = |longEW = |coor_pinpoint = |coordinates_footnotes = |subdivision_type = |subdivision_name = |subdivision_type1 = |subdivision_name1 = |subdivision_type2 = |subdivision_name2 = |established_title = |established_date = |founder = |named_for = |seat_type = |seat = |government_footnotes = |government_type = |leader_title = |leader_name = |leader_title1 = |leader_name1 = |total_type = |unit_pref = |area_magnitude = |area_footnotes = |area_total_km2 = |area_total_sq_mi = |area_total_dunam = |area_land_km2 = |area_land_sq_mi = |area_water_km2 = |area_water_sq_mi = |area_water_percent = |elevation_footnotes = |elevation_m = |elevation_ft = |population_footnotes = |population_total = |population_as_of = |population_density_km2 = |population_density_sq_mi= |population_est = |pop_est_as_of = |population_note = |timezone1 = |utc_offset1 = |timezone1_DST = |utc_offset1_DST = |postal_code_type = |postal_code = |area_code_type = |area_code = |website = |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.
{{Settlement <!-- See Template: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 = <!-- 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_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 = <!-- 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_map_alt = |pushpin_mapsize = |pushpin_map_caption = |pushpin_map1 = |pushpin_label_position1 = |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_type = |coordinates_display = --><!-- display=inline,title --><!-- -->|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 = |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: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_km2 = |area_urban_sq_mi = |area_metro_km2 = |area_metro_sq_mi = |area_blank1_title = |area_blank1_km2 = |area_blank1_sq_mi = |area_blank2_title = |area_blank2_km2 = |area_blank2_sq_mi = <!-- 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_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_metro = |population_density_metro_km2 = |population_density_metro_sq_mi = |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_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 = <!-- 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., blank6_name_sec1 / blank6_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., blank6_name_sec2 / blank6_info_sec2 --> <!-- website, footnotes --------> |website = |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 italic markup ('' '') 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 or Metro (if urban and metro figures are not present, the label is Total unless total_type is set). | ||||||
Transliteration(s) | ||||||||
translit_lang1 | optional | Allows specification of transliterated names in or from other languages | ||||||
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 if called for | ||||||
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. Default size will be 250px | ||||||
imagesize | optional | Can be used to resize the image_skyline. | ||||||
image_alt | optional | Alt text for the image, used by visually-impaired readers who cannot see the image. | ||||||
image_caption | optional | Will place a caption under the image_skyline (if present) | ||||||
Flag image | ||||||||
image_flag | optional | The city flag. Default size:100px | ||||||
flag_size | optional | Resize the image_flag from 100px as desired. | ||||||
flag_alt | optional | Alt text for the flag. | ||||||
Seal image | ||||||||
image_seal | optional | If the place has an official seal. | ||||||
seal_size | optional | Resize the seal. Default is 100px. | ||||||
seal_alt | optional | Alt text for the seal. | ||||||
Coat of arms image | ||||||||
image_shield | optional | Can be used for a place with a coat of arms. | ||||||
shield_size | optional | Resize the arms. Default is 100px. | ||||||
shield_alt | optional | Alt text for the shield.
| ||||||
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. 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 | Default is 100px. Deprecated name =citylogo_size | ||||||
blank_emblem_alt | optional | Alt text for blank emblem. | ||||||
Nickname and Motto | ||||||||
nickname | optional | well-known nickname(s) | ||||||
motto | optional | Will place the motto under the nicknames | ||||||
Maps, Coordinates | ||||||||
Parameter name | Usage | Description | ||||||
Map images | ||||||||
image_map | optional | |||||||
mapsize | optional | 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. | ||||||
mapsize1 | optional | 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. | ||||||
dot_mapsize | optional | To change the dot map size; default is 180px. | ||||||
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. | ||||||
Coordinates | ||||||||
latd | optional | Latitude degrees. Can also be used for decimal degrees. | ||||||
latm | optional | Latitude minutes. Default is 00. | ||||||
lats | optional | Latitude seconds. Default is 00. | ||||||
latNS | optional | Latitude North or South (enter N or S). Default is N. | ||||||
longd | optional | Longitude degrees. Can also be used for decimal degrees. | ||||||
longm | optional | Longitude minutes. Default is 00. | ||||||
longs | optional | Longitude seconds. Default is 00. | ||||||
longEW | optional | Longitude East or West (enter E or W). Default is E. | ||||||
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). | ||||||
coordinates_footnotes | optional | Reference(s) for coordinates, placed within <ref> </ref> tags. | ||||||
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) | ||||||
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 | ||||||
leader_title | optional | First title of the place's leader, e.g. Mayor | ||||||
leader_name | optional | Tip: City leader names are not linked in CreationWiki; they are annotated as strings, not as pages. | ||||||
leader_title1 to leader_title4 |
optional | |||||||
leader_name1 to leader_name4 |
optional | |||||||
Geographic information | ||||||||
Unit conversion, if required, is handled automatically by Semantic MediaWiki. Areas, for example, are annotated, and tooltip dialog balloons will display those areas in all the units normally displayed in the wiki's language. | ||||||||
Parameter name | Usage | Description | ||||||
Display settings | ||||||||
total_type | optional | Specifies what "total" area and population figure refer to. This overrides other labels for total population/area. Without this, the "total" label defaults to "Total" or "City." | ||||||
Area | ||||||||
area_footnotes | optional | Reference(s) for area, placed within <ref> </ref> tags | ||||||
area_total | optional | Total area | ||||||
area_land | optional | - valign=top | area_water2 | optional | - valign=top | area_water_percent | optional | percent of water without the "%" |
area_urban_ | optional | Urban area | ||||||
area_metro_km2 | optional | Metro area | ||||||
area_blank1_title | optional | A specialized area designator. As many as two are allowed. | ||||||
area_blank1 | optional | |||||||
area_blank2_title | optional | |||||||
area_blank2 | optional | |||||||
Elevation | ||||||||
elevation_footnotes | optional | Reference(s) for elevation, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}} | ||||||
elevation | optional | Raw number entered in meters. The semantic engine will convert this to feet; the "feet" value will appear in the tooltip balloon. | ||||||
elevation_max_footnotes elevation_min_footnotes |
optional | Same as above, but for the "max" and "min" elevations. See Leeds. | ||||||
elevation_max elevation_min |
optional | Used to give highest & lowest elevations, instead of just a single value. | ||||||
Population, Demographics | ||||||||
The density fields are to be entered in SI units; the tooltip balloon will show the value in Imperialunits. To calculate density with respect to the total area automatically, type auto in place of any density value. | ||||||||
Parameter name | Usage | Description | ||||||
Population | ||||||||
population_footnotes | optional | Reference(s) for population, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}} | ||||||
population_total | optional | Actual population (see below for estimates) | ||||||
population_as_of | optional | The year for the population total (usually a census year) | ||||||
population_density | optional | |||||||
population_est | optional | Population estimate. | ||||||
pop_est_as_of | optional | The year or month & year of the population estimate | ||||||
population_urban | optional | |||||||
population_density_urban | optional | |||||||
population_metro | optional | |||||||
population_density_metro | optional | |||||||
population_blank1_title | optional | Can be used for estimates. Example: Windsor, Ontario | ||||||
population_blank1 | optional | The population value for blank1_title | ||||||
population_density_blank1 | optional | |||||||
population_blank2_title | optional | |||||||
population_blank2 | optional | |||||||
population_density_blank2 | optional | |||||||
population_note | optional | A place for additional information such as the name of the source. | ||||||
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 | |||||||
Blank fields (section 1) | ||||||||
blank_name_sec1 | optional | Fields used to display other information such as Car plates, Demonym, etc. 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 blank6_name_sec1 |
optional | Up to 6 additional fields (7 total) can be displayed in this section | ||||||
blank1_info_sec1 to blank6_info_sec1 |
optional | |||||||
Blank fields (section 2) | ||||||||
blank_name_sec2 | optional | For a second section of blank fields | ||||||
blank_info_sec2 | optional | |||||||
blank1_name_sec2 to blank6_name_sec2 |
optional | Up to 6 additional field (7 total) can be displayed in this section | ||||||
blank1_info_sec2 to blank6_info_sec2 |
optional | |||||||
Website, Footnotes | ||||||||
website | optional | External link to official website. Must be a valid URI. | ||||||
footnotes | optional | Text to be displayed at the bottom of the infobox |