Template:Geobox Settlement
From Wikipedia, the free encyclopedia
Not much changes for the common user, most field names, logic, functionality are kept. However, the Geoboxes offer more functions and versatility. There are no more specific templates for each feature but just one master template that can handle all type data. Nonetheless, the code is much more efficient and the Geoboxes render much faster (the average pre-expand size is 3-4 times smaller) and thus the switch is highly recomended.
To convert from Geobox 1 to Geobox 2 simply replace the template call, e.g. {{Geobox Settlement becomes {{Geobox|Settlement. Or there is a semi-automatic tool.
{{Geobox Settlement}}
This is an infobox template for cities, towns, villages, hamlets and any other types of human settlements. It belongs to the Geobox series of templates, which are designated to be used for various geography related articles. They all use the same layout, internal logic and coherently named fields and provide some automated tasks such as unit conversion and automated located dot placement into a blank map. All templates can have a name on top, picture below, then section on Country, Region etc. followed by fields which are specific for every geographic feature, with a map at the bottom.
Contents |
[edit] General instructions
[edit] How to fill out
- Copy the appropriate blank template into the edited page and fill in appropriate fields. Do not re-use a template from another page.
- Do not erase empty fields, other editors might supply the missing data. The empty fields are not displayed and don't hinder anything.
[edit] General field behavior
- There exist base fields whose output can be modified or extended by adding additional fields, these always bear the name of the base field plus the name of the additional field starting with an underscore ("_"). The additional fields are not present in the blank templates, their existence is nonetheless marked in the field list of every Geobox. Following additional fields are defined for all base fields:
-
- _type - for redefining the default label, e.g. the default label for the region field is Region, adding region_type it can be changed to display Province, Department …. N.B.: keep the text short, it is always displayed on one line, if it is too long, the left column of the geobox is too wide.
-
- _note - any sort of note which is printed after the field value, it can be even a reference, though the author of Geoboxes discourages from doing so as the implementation of <ref></ref> tags is very poor. The note is printed in a bit different font, currently implemented as 90% italics.
-
- _label : puts the HTML title property on the item (the text displays on hover).
- Some fields might contain multiple values, these are not to be put in a single field and separated by commas but using numbered additional fields (e.g. for the country field there also exist country1, country2, country3 …. The additional "indexed" fields are usually not present in the blank templates.
- The fields that link to existing articles don't need to be put between [[ and ]] markup, this is added automatically if the page exists. However, the markup can be used when the text of the link is different form the link itslef, e.g. [[Amazon|Solimões]].
- All figures can be in either metric (default) or imperial (miles, feet etc) units; the Geoboxes display both, automatically calculating imperial figures from metric or metric from imperial ones. Unformated numbers (i.e. without commas) must be entered, otherwise the auto-conversion produces an error. The output is "nicely" formatted. Following additional fields can be used:
- _imperial - for input in imperial/customary units
- _round - for changing the rounding precision of auto-converison, it's the position from the decimal point to which the figure is rounded, negative values can be used when the input figure is rounded/approximate, default value is 0
- _unit - for changing the default unit, appropropriate unit abbreviation should be used; the default unit for e.g. area is usually sqaure kilometre (or square mile respectively), this can be changed to ha for hectare, acre for acre etc.
The last two additoinal fields are defined for every field using any units, if there is a set of similar fields, e.g. for area (area, area_land, area_water etc., the _round and _unit fields of the basic one are applied on all of them if they aren't specifically set)
- geobox_width - width of the Geobox in pixels (without px, just the figure), it can be used when there are more Geoboxes or images stacked below each other and the same width is desirable; not in blank templates
[edit] Specific fields
- Coordinates can be entered in two ways:
-
- using separate _d, _m, _s…fields, _s and _m can be dropped out, the coordinate display template is adjusted accordingly
- using just _d field and a decimal number, the hemispehere can be defined by either _NS, _EW fields or by using negative figures for western and southern hemisphere (these two systems mustn't be combined)
- For every location type which can be described in coordinates, there exist two additional fields
- _type (named coordinates_type for the main location), which can contain any paramteres that are passed to the mapping service, especially the scale of the map, the possible parameters are described here: Wikipedia:WikiProject_Geographical_coordinates#Parameters.
- _format (named coordinates_format for the main location) to override how the coordinates are diplayed, if the input is decimal the output is decimal too, if the input is DMS so is the output, the possible values are self-explanatory dms and dec
Both _type and _format fields can be defined for every location with coordinates separately or by the general coordinates_type and coordinates_format fields
- The map field should be used for a location map of the feature, i.e. where it is located within a country. The location map can be of three types:
-
- Self-contained location map. As in e.g. Greater Fatra.
- Semi-automated locator dot. The map field contains background map, whereas locator_x and locator_y contain relative coordinates of the locator dot (as a percent of the map width, inserted without the % symbol), this system can be used when the map is not (or cannnot be) calibrated for the automated locator dot.
- Fully automated locator dot. If coordinates of the location are defined in the Geobox and a calibrated map exists the locator dot is placed automatically based on the coordinates (map_locator field defines the appropriate map calibration). As in e.g. Ostrá. The same locator calibration can be used for all maps derived form one base map, e.g. Lysá hora and Plasy share the same calibration though the background map is different. The existing calibrations are listed here: Geobox location.
[edit] Help
- If anything doesn't work as it should, feel free to contact me, the author of the Geobox system, either on my userpage or here at the talkpage or at the appropriate Geobox talkpage. Caroig 22:40, 2 March 2007 (UTC)
[edit] Other names
The following names redirect here, please use the most appropriate name when placing this template on an article (Geobox Settlement may be used as well): Geobox Borough, Geobox City, Geobox Neighborhood, Geobox Town, Geobox Township, Geobox Village.
[edit] Field instructions
| field | explanation | additional fields (default values in brackets) |
|---|---|---|
| Name | ||
| name | name of the settlement (if left blank, article title will be used) | |
| native_name | native name if different from the English one, it is printed in brackets | |
| other_name, other_name1 … | other names, can be used for names in other languages (then preferable in the {{lang-xx|}} style) | |
| category | category of the settlement: City, Town, Village, Hamlet, Sietch ;-) etc. | _note |
| Image | ||
| image | a representative photograph of the settlement | |
| image_size | photograph size in pixels (set to 256 if left blank), without px | |
| image_caption | photograph caption | |
| Symbols | ||
| flag | official settlement flag or banner | _type (Flag), _note |
| flag_size | flag size in pixels (set to 120 if left blank), without px | |
| symbol | official seal, shield, coat-of arms etc., | _type (Coat of arms), _note |
| symbol_size | flag size in pixels (set to 120 if left blank), without px | |
| Etymology & nickname & motto | ||
| etymology | etymology (origin) of the settlement name, do not enter lengthy prose, examples:
|
_type (Name origin), _label, _note |
| nickname, nickname1 ... | settlement nickname(s) | |
| motto, motto1 ... | settlement motto(es) | |
| Country etc. | ||
| country, country1 … | country/countries in which the settlement lies | _type (County/Countries), _label, _note |
| state, state1 … | state/states in which the settlement lies | _type (State/States), _label, _note |
| region, region1 … | region/regions in which the settlement lies | _type (Region/Regions), _label, _note |
| district, district1 … | district/districts in which the settlement lies | _type (District/Districts), _label, _note |
| Subdivisions | ||
| part_type | type of administrative subdivisons (default: Municipalities) | part_label |
| part_count | number of administrative subdivisions | |
| part, part1 … | names of administrative subdivisions parts, they are displayed within a folding section which is hidden on page load | _note |
| Geography | ||
| area, area_land, area_water, area_urban, area_metro | appropriate area in km² (for mi² use area_imperial, area_land_imperial, area_water_imperial, area_urban_imperial, area_metro_imperial) | _unit (sqkm/sqmi), _round (0), _note, _label … |
| location | place for which coordinates and elevation are provided, can be a square, park, street etc. | _type (Center), _note, _label |
| lat_d, lat_m, lat_s, lat_NS, long_d, long_m, long_s, long_EW |
latitude and longitude degrees, minutes, seconds and hemispheres (N or S and W or E) | coordinates_label, coordinates_note, coordinates_type |
| elevation(_imperial) | center location elevation in metres | _type (Elevation), _note, _label |
| highest | highest point name | _type (Highest point), _label, _note |
| highest_location | descriptive location of the highest point | _type (location), _label, _note |
| highest_lat_d … * | highest point latitude and longitude in degrees, minutes, seconds and hemispheres (use N/S and W/E) | highest_coordinates_note |
| highest_elevation(_imperial) | highest point elevation in metres | _type, _label, _note |
| lowest | lowest point name | _type (Lowest point), _label, _note |
| lowest_location | descriptive location of the lowest point | _type (location), _label, _note |
| lowest_lat_d … * | lowest point latitude and longitude in degrees, minutes, seconds and hemispheres (use N/S and W/E) | lowest_coordinates_note |
| lowest_elevation(_imperial) | lowest point elevation in metres | _note |
| Population | ||
| population_as_of, population_urban_as_of, population_metro_as_of | year or date to which population figures relate | |
| population, population_urban, population_metro | appropriate population figure, , unformatted numbers must be used as they are used for calculations, they get formatted on output | _type, _note, _label |
| population_density, population_density_urban, population_density_metro | appropriate population density figure in /km² (for /mi² use population_density_imperial, population_density_urban_imperial, population_density_metro_imperial), if value auto is assigned the density is calculated from appopriate area and population figures | _unit (sqkm/sqmi), _round (0), _note |
| Government | ||
| government | government type | _type, _label, _note |
| established, etablished1 … | establishment/foundation date, numbered fields can contain year of status upgrade, incorporation, enlargement etc. | _type (Founded), _note, _label |
| mayor, mayor1 … or leader, leader1 … |
These fields can be named with mayor or leader. If only one name is provided, it may be easiest to use the mayor field, as leader_type is set to Mayor by default) | _type (Mayor), _note, _label |
| Various codes | ||
| timezone, utc_offset | timezone name and its UTC offset | _note |
| timezone_DST, utc_offset_DST | summer/daylight saving timezone name and its UTC offset | _note |
| postal_code=code, area_code=code1, code2 … | Various identification codes, first two are aliased as Postal code and Area code (phone) | _type (Postal code, Area code, Code 2…), _note, _label |
| Free fields | ||
| free, free1 … | free fields for any type of infromation, do not get wikilinked | _type, _label, _note |
| Map | ||
| map, map1 | map showing the location of the mountain, without Image: | |
| map_size, map1_size | optional map size (if not defined default value 256px is used), without px | |
| map_caption, map1_caption | optional map caption | |
| map_locator_x, map_locator_y, map1_locator_x, map1_locator_y | locator dot position in percents of the map width | |
| map_locator, map1_locator | locator template name Category:Geobox location, only the name without Geobox location | |
| map_first | if assigned any value the map is printed at the top and the image at the bottom of the Geobox | |
| Website | ||
| website | official website | _type (Website), _label, _note |
| Footnotes | ||
| footnotes | any type of footnotes, do not get wikilinked | |
[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. 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"
- "vcard"
Please do not rename or remove these classes.
[edit] Blank templates
| Simple templates (small towns) | |
|---|---|
| Metric values | Imperial values |
{{Geobox Settlement
<!-- *** Name section *** -->
| name =
| native_name =
| other_name =
| other_name1 =
| category = Town
<!-- *** Image *** -->
| image =
| image_size =
| image_caption =
<!-- *** Symbols *** -->
| flag =
| flag_size =
| symbol =
| symbol_size =
<!-- *** Etymology & nickname & motto *** -->
| etymology =
| nickname =
| motto =
<!-- *** Country etc. *** -->
| country =
| state =
| region =
| district =
<!-- *** Municipal parts *** -->
| part_type =
| part_count =
| part =
| part1 =
<!-- *** Geography *** -->
| area =
| location =
| lat_d =
| lat_m =
| lat_s =
| lat_NS =
| long_d =
| long_m =
| long_s =
| long_EW =
| elevation =
<!-- *** Population *** -->
| population_as_of =
| population =
| population_density =
<!-- *** Government *** -->
| established_type =
| established =
| mayor =
<!-- *** Various codes *** -->
| timezone =
| utc_offset =
| timezone_DST =
| utc_offset_DST =
| postal_code =
| postal_code_type =
| area_code =
| area_code_type =
| code2_type =
| code2 =
<!-- *** Free fields *** -->
| free_type =
| free =
| free1_type =
| free1 =
<!-- *** Map section *** -->
| map =
| map_size =
| map_caption =
| map_locator =
| map_locator_x =
| map_locator_y =
<!-- *** Website *** -->
| website =
}}
|
{{Geobox Settlement
<!-- *** Name section *** -->
| name =
| native_name =
| other_name =
| other_name1 =
| category = Town
<!-- *** Image *** -->
| image =
| image_size =
| image_caption =
<!-- *** Symbols *** -->
| flag =
| flag_size =
| symbol =
| symbol_size =
<!-- *** Etymology & nickname & motto *** -->
| etymology =
| nickname =
| motto =
<!-- *** Country etc. *** -->
| country =
| state =
| region =
| district =
<!-- *** Municipal parts *** -->
| part_type =
| part_count =
| part =
| part1 =
<!-- *** Geography *** -->
| area_imperial =
| location =
| lat_d =
| lat_m =
| lat_s =
| lat_NS =
| long_d =
| long_m =
| long_s =
| long_EW =
| elevation_imperial =
<!-- *** Population *** -->
| population_as_of =
| population =
| population_density_imperial =
<!-- *** Government *** -->
| established_type =
| established =
| mayor =
<!-- *** Various codes *** -->
| timezone =
| utc_offset =
| timezone_DST =
| utc_offset_DST =
| postal_code =
| postal_code_type =
| area_code =
| area_code_type =
| code2_type =
| code2 =
<!-- *** Free fields *** -->
| free_type =
| free =
| free1_type =
| free1 =
<!-- *** Map section *** -->
| map =
| map_size =
| map_caption =
| map_locator =
| map_locator_x =
| map_locator_y =
<!-- *** Website *** -->
| website =
}}
|
| Complete templates (cities) | |
| Metric values | Imperial values |
{{Geobox Settlement
<!-- *** Name section *** -->
| name =
| native_name =
| other_name =
| other_name1 =
| category = City
<!-- *** Image *** -->
| image =
| image_size =
| image_caption =
<!-- *** Symbols *** -->
| flag =
| flag_size =
| symbol =
| symbol_size =
<!-- *** Etymology & nickname & motto *** -->
| etymology =
| nickname =
| motto =
<!-- *** Country etc. *** -->
| country =
| state =
| region =
| district =
<!-- *** Municipal parts *** -->
| part_type =
| part_count =
| part =
| part1 =
<!-- *** Geography *** -->
| area =
| area_land =
| area_water =
| area_urban =
| area_metro =
| location =
| lat_d =
| lat_m =
| lat_s =
| lat_NS =
| long_d =
| long_m =
| long_s =
| long_EW =
| highest_name =
| highest location =
| highest_lat_d =
| highest_lat_m =
| highest_lat_s =
| highest_lat_NS =
| highest_long_d =
| highest_long_m =
| highest_long_s =
| highest_long_EW =
| highest_elevation =
| lowest_name =
| lowest_location =
| lowest_lat_d =
| lowest_lat_m =
| lowest_lat_s =
| lowest_lat_NS =
| lowest_long_d =
| lowest_long_m =
| lowest_long_s =
| lowest_long_EW =
| lowest_elevation =
<!-- *** Population *** -->
| population_as_of =
| population =
| population_urban =
| population_metro =
| population_density =
| population_density_urban =
| population_density_metro =
<!-- *** Government *** -->
| government =
| established_type =
| established =
| established1_type =
| established1 =
| government_type =
| leader_type =
| leader =
| leader1_type1 =
| leader1 =
<!-- *** Various codes *** -->
| timezone =
| utc_offset =
| timezone_DST =
| utc_offset_DST =
| postal_code =
| postal_code_type =
| area_code =
| area_code_type =
| code2_type =
| code2 =
<!-- *** Free fields *** -->
| free_type =
| free =
| free1_type =
| free1 =
<!-- *** Map section *** -->
| map =
| map_size =
| map_caption =
| map_locator =
| map_locator_x =
| map_locator_y =
<!-- *** Website *** -->
| website =
<!-- *** Footnotes *** -->
| footnotes =
}}
|
{{Geobox Settlement
<!-- *** Name section *** -->
| name =
| native_name =
| other_name =
| other_name1 =
| category = City
<!-- *** Image *** -->
| image =
| image_size =
| image_caption =
<!-- *** Symbols *** -->
| flag =
| flag_size =
| symbol =
| symbol_size =
<!-- *** Etymology & nickname & motto *** -->
| etymology =
| nickname =
| motto =
<!-- *** Country etc. *** -->
| country =
| state =
| region =
| district =
<!-- *** Municipal parts *** -->
| part_type =
| part_count =
| part =
| part1 =
<!-- *** Geography *** -->
| area_imperial =
| area_land_imperial =
| area_water_imperial =
| area_urban_imperial =
| area_metro_imperial =
| location =
| lat_d =
| lat_m =
| lat_s =
| lat_NS =
| long_d =
| long_m =
| long_s =
| long_EW =
| highest_name =
| highest location =
| highest_lat_d =
| highest_lat_m =
| highest_lat_s =
| highest_lat_NS =
| highest_long_d =
| highest_long_m =
| highest_long_s =
| highest_long_EW =
| highest_elevation_imperial =
| lowest_name =
| lowest_location =
| lowest_lat_d =
| lowest_lat_m =
| lowest_lat_s =
| lowest_lat_NS =
| lowest_long_d =
| lowest_long_m =
| lowest_long_s =
| lowest_long_EW =
| lowest_elevation_imperial =
<!-- *** Population *** -->
| population_as_of =
| population =
| population_urban =
| population_metro =
| population_density_imperial =
| population_density_urban_imperial =
| population_density_metro_imperial =
<!-- *** Government *** -->
| government =
| established_type =
| established =
| established1_type =
| established1 =
| government_type =
| leader =
| leader_type =
| leader1_name =
| leader1_type =
<!-- *** Various codes *** -->
| timezone =
| utc_offset =
| timezone_DST =
| utc_offset_DST =
| postal_code =
| postal_code_type =
| area_code =
| area_code_type =
| code2_type =
| code2 =
<!-- *** Free fields *** -->
| free_type =
| free =
| free1_type =
| free1 =
<!-- *** Map section *** -->
| map =
| map_size =
| map_caption =
| map_locator =
| map_locator_x =
| map_locator_y =
<!-- *** Website *** -->
| website =
<!-- *** Footnotes *** -->
| footnotes =
}}
|
