Template:GeoTemplate/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:GeoTemplate (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

The GeoTemplate can be invoked by using one of the coordinates templates. An external tool fills the template with the coordinates data as described on this page.

Contents

[edit] Parameters

GeoHack (the tool that fills GeoTemplate with working links) takes two inputs:

  • URL parameters: Coordinates are given in the format D_M_S_N_D_M_S_E, D_M_N_D_M_E, D_N_D_E, or D;D where D is degrees, M is Minutes, S is second, and NS/EW are the directions. They can be followed by coordinate parameters such as type, scale and region, separated by underscores. On Wikipedia the URL is generated by coordinate templates.
    For example, the wikitext {{coord|51|28|40|N|0|0|6|W|type:landmark_scale:2000_region:GB}} becomes params=51_28_40_N_0_0_6_W_type:landmark_scale:2000_region:GB in the URL.
  • The template page (contents of GeoTemplate) where variables are replaced with values computed from the data given in the URL. The rest of this page documents the available variables.

[edit] Position

GeoHack provides the following variables based on the given coordinates (51_28_40_N_0_0_6_W in the example above).

  • {ch1903easting}, {ch1903northing} - CH1903+ coordinate
  • {latdegabs}, {londegabs} - WGS84 Absolute integer degrees
  • {latdegdec}, {londegdec}, {londegneg} - WGS84 Total decimal degrees
  • {latdegint}, {londegint} - WGS84 Floored integer degrees
  • {latdeground}, {londeground} - WGS84 Rounded integer degrees
  • {latmindec}, {lonmindec} - WGS84 Decimal minutes
  • {latminint}, {lonminint} - WGS84 Integer minutes
  • {latNS}, {lonEW} - WGS84 Direction of absolute integer degrees
  • {latsecdec}, {lonsecdec} - WGS84 Decimal seconds
  • {latsecint}, {lonsecint} - WGS84 Integer seconds
  • {nztmeasting}, {nztmnorthing} - New Zealand Transverse Mercator coordinate
  • {osgb36ref} - Ordnance Survey Grid reference
  • {utmnorthing} {utmeasting} {utmzone} - UTM coordinate
  • {osgb36northing}, {osgb36easting} -
  • {utm33northing}, {utm33easting} -

[edit] Scaling

GeoHack accepts a scale parameter (scale:2000 in the example above) which it uses to provide scaling or zoom values for different mapping services.

name used by formula
{scale} Virtual Globe supplied in URL via scale or calculated based on type
{mmscale} Multimap closest scale value accepted by Multimap (see mapsources.php)
{span} Google Maps, WikiMapia scale * 1.0 / 1,000,000
{altitude} MSN Maps, Fourmilab, Swissinfo scale * 143 / 1,000,000
{zoom} MapQuest, Gule Sider integer(18.0 - log(scale))
{osmzoom} OpenStreetMap, Live Search Maps 18 - ( round(log($attr['scale'],2) - log(1693,2)) )

GeoHack accepts a type parameter (type:landmark in the example above) from which it will calculate a scale value when none is supplied. The following chart shows the types currently understood by GeoHack, the scale ratio associated with each, plus the additional variables calculated by GeoHack.

{type} ratio {scale} {mmscale} {span} {altitude} {zoom} {osmzoom}
country 1 : 10,000,000 10000000 10000000 10 1430 1 5
state 1 : 3,000,000 3000000 4000000 3 429 3 7
adm1st 1 : 1,000,000 1000000 1000000 1 143 4 9
adm2nd (default) 1 : 300,000 300000 200000 0.3 42 5 11
city, mountain, isle 1 : 100,000 100000 100000 0.1 14 6 12
airport 1 : 30,000 30000 25000 0.03 4 7 14
landmark 1 : 10,000 10000 10000 0.01 1 8 15

The default values can for each type can be overridden by also supplying a scale. For example, type:airport is assigned a {scale} of 30000, while type:airport_scale:10000 uses the supplied {scale} of 10000.

For detailed implementation see mapsources.php

[edit] Miscellaneous

  • {region}, {globe}, {page} - Look up page from Wikipedia. See if we have something in Wikipedia:Map sources or equivalent. A subpage can be specified
  • {pagename} - The value from the pagename key in the query (e.g. &pagename=Article) (URI scheme#Generic syntax) - FULLPAGENAMEE expected. When used with Template:Coor this returns the containing article name with whitespace replaced by underscores. For example: Bellevue Botanical Garden becomes Bellevue_Botanical_Garden.
  • {title} - The value from the title key in the query (e.g. &title=Name). If not given in the query, is the same as {pagename}.

[edit] Section coding

When the parameters contain a region or GeoHack finds the region with the coordinates, a matching section is moved to the location marked with the placeholder:

<div id="GEOTEMPLATE-LOCAL" />

The region sections are wrapped in an element where the XX of the id is the ISO 3166-1 alpha-2 code:

<div id="GEOTEMPLATE-XX">
 ...
</div>