Template:Infobox settlement/doc: Difference between revisions
Created page with "{{Documentation subpage}} <!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see Wikipedia:Wikidata)--> {{Intricate template}} {{Au..." |
|||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
==Usage== | ==Usage== | ||
Line 1,115: | Line 1,107: | ||
|} | |} | ||
<!-- End of parameter name/description table --> | <!-- End of parameter name/description table --> | ||
==Supporting templates== | ==Supporting templates== |
Latest revision as of 13:28, 14 September 2021
This is a documentation subpage for Template:Infobox settlement. It contains usage information, categories and other content that is not part of the original template 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.
- 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 | 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 = | etymology = | nickname = | motto = | image_map = | map_alt = | map_caption = | pushpin_map = | pushpin_map_alt = | pushpin_map_caption = | pushpin_label_position = | coordinates = <!-- {{coord|latitude|longitude|type:city|display=inline,title}} --> | coor_pinpoint = | 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 = | government_type = | governing_body = | leader_party = | leader_title = | leader_name = | leader_title1 = | leader_name1 = | leader_title2 = | leader_name2 = | leader_title3 = | leader_name3 = | leader_title4 = | leader_name4 = | unit_pref = Metric <!-- ALL fields with measurements have automatic unit conversion --> <!-- for references: use <ref> tags --> | area_footnotes = | area_urban_footnotes = <!-- <ref> </ref> --> | area_rural_footnotes = <!-- <ref> </ref> --> | area_metro_footnotes = <!-- <ref> </ref> --> | area_magnitude = <!-- <ref> </ref> --> | area_note = | area_water_percent = | area_rank = | area_blank1_title = | area_blank2_title = <!-- square kilometers --> | area_total_km2 = | area_land_km2 = | area_water_km2 = | area_urban_km2 = | area_rural_km2 = | area_metro_km2 = | area_blank1_km2 = | area_blank2_km2 = <!-- hectares --> | area_total_ha = | area_land_ha = | area_water_ha = | area_urban_ha = | area_rural_ha = | area_metro_ha = | area_blank1_ha = | area_blank2_ha = | length_km = | width_km = | dimensions_footnotes = | elevation_footnotes = | elevation_m = | population_footnotes = | population_as_of = | population_total = | population_density_km2 = auto | population_note = | population_demonym = | 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 | 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 = | etymology = | nickname = | motto = | image_map = | map_alt = | map_caption = | pushpin_map = | pushpin_map_alt = | pushpin_map_caption = | pushpin_label_position = | coordinates = <!-- {{coord|latitude|longitude|type:city|display=inline,title}} --> | coor_pinpoint = | 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 --> <!-- ALL fields with measurements have automatic unit conversion --> <!-- for references: use <ref> tags --> | area_footnotes = | area_urban_footnotes = <!-- <ref> </ref> --> | area_rural_footnotes = <!-- <ref> </ref> --> | area_metro_footnotes = <!-- <ref> </ref> --> | area_magnitude = <!-- use only to set a special wikilink --> | area_note = | area_water_percent = | area_rank = | area_blank1_title = | area_blank2_title = <!-- square miles --> | area_total_sq_mi = | area_land_sq_mi = | area_water_sq_mi = | area_urban_sq_mi = | area_rural_sq_mi = | area_metro_sq_mi = | area_blank1_sq_mi = | area_blank2_sq_mi = <!-- acres --> | area_total_acre = | area_land_acre = | area_water_acre = | area_urban_acre = | area_rural_acre = | area_metro_acre = | area_blank1_acre = | area_blank2_acre = | length_mi = | width_mi = | dimensions_footnotes = | elevation_footnotes = | elevation_ft = | population_footnotes = | population_as_of = | population_total = | population_density_sq_mi= auto | population_note = | population_demonym = | 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 = }}
Short version
{{Infobox settlement | 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 = | etymology = | nickname = | coordinates = <!-- {{Coord}} --> | population_total = | subdivision_type = Country | subdivision_name = | subdivision_type1 = | subdivision_name1 = | subdivision_type2 = | subdivision_name2 = | website = <!-- {{URL|example.com}} --> }}
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 | 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 = <!-- 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_border = | flag_link = | image_seal = | seal_size = | seal_alt = | seal_link = | seal_type = | 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 = | etymology = | nickname = | nicknames = | motto = | mottoes = | anthem = <!-- maps and coordinates --> | image_map = | mapsize = | map_alt = | map_caption = | image_map1 = | mapsize1 = | map_alt1 = | map_caption1 = | pushpin_map = <!-- name of a location map as per Template:Location_map --> | pushpin_mapsize = | pushpin_map_alt = | pushpin_map_caption = | pushpin_map_caption_notsmall = | pushpin_label = <!-- only necessary if "name" or "official_name" are too long --> | pushpin_label_position = <!-- position of the pushpin label: left, right, top, bottom, none --> | pushpin_outside = | pushpin_relief = | pushpin_image = | pushpin_overlay = | coordinates = <!-- {{Coord}} --> | coor_pinpoint = <!-- to specify exact location of coordinates (was coor_type) --> | coordinates_footnotes = <!-- for references: use <ref> tags --> | grid_name = <!-- name of a regional grid system --> | grid_position = <!-- position on the regional grid system --> <!-- 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 = <!-- Founded --> | established_date = <!-- requires established_title= --> | established_title1 = <!-- Incorporated (town) --> | established_date1 = <!-- requires established_title1= --> | established_title2 = <!-- Incorporated (city) --> | established_date2 = <!-- requires established_title2= --> | established_title3 = | established_date3 = <!-- requires established_title3= --> | established_title4 = | established_date4 = <!-- requires established_title4= --> | established_title5 = | established_date5 = <!-- requires established_title5= --> | established_title6 = | established_date6 = <!-- requires established_title6= --> | established_title7 = | established_date7 = <!-- requires established_title7= --> | extinct_title = | extinct_date = | founder = | named_for = <!-- seat, smaller parts --> | seat_type = <!-- defaults to: Seat --> | seat = | seat1_type = <!-- defaults to: Former seat --> | seat1 = | 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 --> | dunam_link = <!-- If dunams are used, this specifies which dunam to link. --> | area_total_km2 = <!-- ALL fields with measurements have automatic unit conversion --> | area_total_sq_mi = <!-- see table @ Template:Infobox settlement for details --> | area_total_ha = | area_total_acre = | area_total_dunam = <!-- used in Middle East articles only --> | area_land_km2 = | area_land_sq_mi = | area_land_ha = | area_land_acre = | area_land_dunam = <!-- used in Middle East articles only --> | area_water_km2 = | area_water_sq_mi = | area_water_ha = | area_water_acre = | area_water_dunam = <!-- used in Middle East articles only --> | area_water_percent = | area_urban_footnotes = <!-- for references: use <ref> tags --> | area_urban_km2 = | area_urban_sq_mi = | area_urban_ha = | area_urban_acre = | area_urban_dunam = <!-- used in Middle East articles only --> | area_rural_footnotes = <!-- for references: use <ref> tags --> | area_rural_km2 = | area_rural_sq_mi = | area_rural_ha = | area_rural_acre = | area_rural_dunam = <!-- used in Middle East articles only --> | area_metro_footnotes = <!-- for references: use <ref> tags --> | area_metro_km2 = | area_metro_sq_mi = | area_metro_ha = | area_metro_acre = | area_metro_dunam = <!-- used in Middle East articles only --> | area_rank = | area_blank1_title = | area_blank1_km2 = | area_blank1_sq_mi = | area_blank1_ha = | area_blank1_acre = | area_blank1_dunam = <!-- used in Middle East articles only --> | area_blank2_title = | area_blank2_km2 = | area_blank2_sq_mi = | area_blank2_ha = | area_blank2_acre = | area_blank2_dunam = <!-- used in Middle East articles only --> | area_note = <!-- dimensions --> | dimensions_footnotes = <!-- for references: use <ref> tags --> | length_km = | length_mi = | width_km = | width_mi = <!-- elevation --> | elevation_footnotes = <!-- for references: use <ref> tags --> | elevation_m = | elevation_ft = | elevation_point = <!-- for denoting the measurement point --> | elevation_max_footnotes = <!-- for references: use <ref> tags --> | elevation_max_m = | elevation_max_ft = | elevation_max_point = <!-- for denoting the measurement point --> | elevation_max_rank = | elevation_min_footnotes = <!-- for references: use <ref> tags --> | elevation_min_m = | elevation_min_ft = | elevation_min_point = <!-- for denoting the measurement point --> | elevation_min_rank = <!-- population --> | population_footnotes = <!-- for references: use <ref> tags --> | population_as_of = | population_total = | pop_est_footnotes = | pop_est_as_of = | population_est = | population_rank = | population_density_km2 = <!-- for automatic calculation of any density field, use: auto --> | population_density_sq_mi= | population_urban_footnotes = | population_urban = | population_density_urban_km2 = | population_density_urban_sq_mi = | population_rural_footnotes = | population_rural = | population_density_rural_km2 = | population_density_rural_sq_mi = | population_metro_footnotes = | 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, e.g. Liverpudlian for someone from Liverpool --> | population_demonyms = | population_note = <!-- demographics (section 1) --> | demographics_type1 = | demographics1_footnotes = <!-- for references: use <ref> tags --> | demographics1_title1 = | demographics1_info1 = <!-- etc., up to demographics1_title7 / demographics1_info7 --> <!-- demographics (section 2) --> | demographics_type2 = | demographics2_footnotes = <!-- for references: use <ref> tags --> | demographics2_title1 = | demographics2_info1 = <!-- etc., up to demographics2_title10 / demographics2_info10 --> <!-- time zone(s) --> | timezone1 = | utc_offset1 = | timezone1_DST = | utc_offset1_DST = | timezone1_location = | timezone2 = | utc_offset2 = | timezone2_DST = | utc_offset2_DST = | timezone2_location = <!-- 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 = | area_codes = | geocode = | iso_code = | registration_plate_type = | registration_plate = | code1_name = | code1_info = | code2_name = | code2_info = <!-- 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 | optional | This is the usual name in English. If it's not specified, the infobox will use the official_name as a title unless this too is missing, in which case the page name will be used. |
official_name | optional | The official name in English if different from name |
native_name | optional | Name in the local language, if different from name, and if not English. 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. 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 be helpful if an editor wants 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_border | optional | Set to 'no' to remove the border from 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 seal_type |
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, motto | ||
etymology | optional | origin of name |
nickname | optional | well-known nickname |
nicknames | optional | if more than one well-known nickname, use this |
motto | optional | Will place the motto under the nicknames |
mottoes | optional | if more than one mottoe, use this |
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 | |
Pushpin map(s), coordinates | ||
pushpin_map | optional | The name of a location map as per Template:Location map (e.g. Indonesia or Russia). The coordinate fields (from |coordinates= ) position a pushpin coordinate marker and label on the map automatically. Example: Padang, Indonesia. To show multiple pushpin maps, provide a list of maps separated by #, e.g., California#USA
|
pushpin_mapsize | optional | Must be entered as only a number—do not use px. The default value is 250. Equivalent to width parameter in Template:Location map.
|
pushpin_map_alt | optional | Alt text for pushpin map; used by screen readers, see WP:ALT. Equivalent to alt parameter in Template:Location map.
|
pushpin_map_caption | optional | Fill out if a different caption from map_caption is desired. Equivalent to caption parameter in Template:Location map.
|
pushpin_map_caption_notsmall | optional | |
pushpin_label | optional | The text of the label to display next to the identifying mark; a wikilink can be used. If not specified, the label will be the text assigned to the name or official_name parameters (if |pushpin_label_position=none , no label is displayed).Equivalent to label parameter in Template:Location map.
|
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. Equivalent to position parameter in Template:Location map.
|
pushpin_outside | optional | Equivalent to outside parameter in Template:Location map.
|
pushpin_relief | optional | Set this to y or any non-blank value to use an alternative relief map provided by the selected location map (if a relief map is available). Equivalent to relief parameter in Template:Location map.
|
pushpin_image | optional | Allows the use of an alternative map; the image must have the same edge coordinates as the location map template. Equivalent to AlternativeMap parameter in Template:Location map.
|
pushpin_overlay | optional | Can be used to specify an image to be superimposed on the regular pushpin map. Equivalent to overlay_image parameter in Template:Location map.
|
coordinates | optional | Latitude and longitude. Use {{Coord}}. See the documentation for {{Coord}} for more details on usage. |
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_footnotes | optional | Reference(s) for coordinates, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}} |
grid_name grid_position |
optional | Name of a regional grid system and position on the regional grid |
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 , flag icons or flag templates can be used 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]] . Flag icons or flag templates can be used in this field per WP:MOSFLAG.
|
Established | ||
established_title | optional | Example: Founded |
established_date | optional | Requires established_title= |
established_title1 | optional | Example: Incorporated (town) [Note that "established_title1" is distinct from "established_title"; you can think of "established_title" as behaving like "established_title0".] |
established_date1 | optional | [See note for "established_title1".] Requires established_title1= |
established_title2 | optional | Example: Incorporated (city) |
established_date2 | optional | Requires established_title2= |
established_title3 | optional | |
established_date3 | optional | Requires established_title3= |
established_title4 | optional | |
established_date4 | optional | Requires established_title4= |
established_title5 | optional | |
established_date5 | optional | Requires established_title5= |
established_title6 | optional | |
established_date6 | optional | Requires established_title6= |
established_title7 | optional | |
established_date7 | optional | Requires established_title7= |
extinct_title | optional | For when a settlement ceases to exist |
extinct_date | optional | Requires extinct_title= |
founder | optional | Who the settlement was founded by |
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 | Examples: Mayor-council government, Council–manager government, City commission 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 | Setting this to any non-empty value will create a link to the appropriate order of magnitude of area page (e.g. 1 E+6 m²). |
dunam_link | optional | If dunams are used, the default is to link the word dunams in the total area section. This can be changed by setting dunam_link to another measure (e.g. dunam_link=water ). Linking can also be turned off by setting the parameter to something else (e.g. dunam_link=none or dunam_link=off ).
|
area_total_km2 | optional | Total 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_total_sq_mi is empty. |
area_total_ha | optional | Total area in hectares—symbol: ha. Value must be entered in raw format, no commas or spaces. Auto-converted to display acres if area_total_acre is empty. |
area_total_sq_mi | optional | Total 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_total_km2 is empty. |
area_total_acre | optional | Total area in acres. Value must be entered in raw format, no commas or spaces. Auto-converted to display hectares if area_total_ha 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 or hectares and square miles or acreds if area_total_km2, area_total_ha, area_total_sq_mi, and area_total_acre 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_land_ha | optional | similar to area_total_ha
|
area_land_dunam | optional | similar to area_total_dunam
|
area_land_acre | optional | similar to area_total_acre
|
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_ha | optional | similar to area_total_ha
|
area_water_dunam | optional | similar to area_total_dunam
|
area_water_acre | optional | similar to area_total_acre
|
area_water_percent | optional | percent of water without the "%" |
area_urban_km2 | optional | |
area_urban_sq_mi | optional | |
area_urban_ha | optional | similar to area_total_ha
|
area_urban_dunam | optional | similar to area_total_dunam
|
area_urban_acre | optional | similar to area_total_acre
|
area_rural_km2 | optional | |
area_rural_sq_mi | optional | |
area_rural_ha | optional | similar to area_total_ha
|
area_rural_dunam | optional | similar to area_total_dunam
|
area_rural_acre | optional | similar to area_total_acre
|
area_metro_km2 | optional | |
area_metro_sq_mi | optional | |
area_metro_ha | optional | similar to area_total_ha
|
area_metro_dunam | optional | similar to area_total_dunam
|
area_metro_acre | optional | similar to area_total_acre
|
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_blank1_ha | optional | similar to area_total_ha
|
area_blank1_dunam | optional | similar to area_total_dunam
|
area_blank1_acre | optional | similar to area_total_acre
|
area_blank2_title | optional | |
area_blank2_km2 | optional | |
area_blank2_sq_mi | optional | |
area_blank2_ha | optional | similar to area_total_ha
|
area_blank2_dunam | optional | similar to area_total_dunam
|
area_blank2_acre | optional | similar to area_total_acre
|
area_note | optional | A place for additional information such as the name of the source. |
Dimensions | ||
dimensions_footnotes | optional | Reference(s) for dimensions, placed within <ref> </ref> tags, possibly using the citing format at {{Cite web}} |
length_km | optional | Raw number entered in kilometers. Will automatically convert to display length in miles if length_mi is empty. |
length_mi | optional | Raw number entered in miles. Will automatically convert to display length in kilometers if length_km is empty. |
width_km | optional | Raw number entered in kilometers. Will automatically convert to display width in miles if length_mi is empty. |
width_mi | optional | Raw number entered in miles. Will automatically convert to display width in kilometers if length_km is empty. |
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 (e.g. 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_max_rank elevation_min_m elevation_min_ft elevation_min_rank |
optional | Used to give highest & lowest elevations and rank, 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_as_of | optional | The year for the population total (usually a census year) |
population_footnotes | optional | Reference(s) for population, placed within <ref> </ref> tags |
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 |
pop_est_footnotes | optional | Reference(s) for population estimate, placed within <ref> </ref> tags |
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, a citizen in Liverpool is known as a Liverpudlian. |
population_demonyms | optional | If more than one demonym, use this |
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_title7 |
optional | Titles related to demographics_type1. For example: White, Black, Hispanic... |
demographics1_info1 to demographics1_info7 |
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_title10 |
optional | Titles related to demographics_type2. For example: English, French, Arabic... |
demographics2_info1 to demographics2_info10 |
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 | |
area_codes | optional | If more than one area code, use this |
geocode | optional | See Geocode |
iso_code | optional | See ISO 3166 |
registration_plate_type | optional | If left blank/not used template will default to "Vehicle registration" |
registration_plate | optional | See Vehicle registration plate |
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 |
short_description | optional | specify custom short description; if not specified, one will be automatically generated, e.g. "Place in Israel". |
Supporting templates
The following is a list of sub-templates used by Infobox settlement. See the current list of all sub-templates for documentation, sandboxes, testcases, etc.
- {{Infobox settlement/areadisp}}
- {{Infobox settlement/densdisp}}
- {{Infobox settlement/dunam}}
- {{Infobox settlement/dunam/mag}}
- {{Infobox settlement/impus}}
- {{Infobox settlement/impus/mag}}
- {{Infobox settlement/lengthdisp}}
- {{Infobox settlement/link}}
- {{Infobox settlement/metric}}
- {{Infobox settlement/metric/mag}}
- {{Infobox settlement/pref}}
Microformat
TemplateData
Extended content
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.
TemplateData for Infobox settlement An Infobox for human settlements (cities, towns, villages, communities) as well as other administrative districts, counties, provinces, et cetera
|
Calls and redirects
At least 0 other templates call this one.
Several templates redirect here, but the only redirect in article space is Template:Infobox Settlement having around 6700 transclusions, oldest article from 2008, most recent from 2009. More than 5000 of these articles are bot generated and related to Poland. [1]
Tracking categories
- Category:Pages using infobox settlement with a dot map (0)
- Category:Pages using infobox settlement with bad settlement type (0)
- Category:Pages using infobox settlement with imprecise region codes (0)
- Category:Pages using infobox settlement with missing country (0)
- Category:Pages using infobox settlement with possible area code list (0)
- Category:Pages using infobox settlement with possible demonym list (0)
- Category:Pages using infobox settlement with possible motto list (0)
- Category:Pages using infobox settlement with possible nickname list (0)
- Category:Pages using infobox settlement with the image parameter (0)
- Category:Pages using infobox settlement with the wikidata parameter (0)
- Category:Pages using infobox settlement with unknown parameters (0)
- Category:Templates calling Infobox settlement (0)