Extension:GeoData

MediaWiki extensions manual - list

GeoData Release status: experimental
Implementation	API, Parser function
Description	Adds geographical coordinates storage and retrieval functionality
Author(s)	Max Semenik (MaxSemTalk)
MediaWiki	1.19+
Database changes	yes
License	WTFPL 2.0
Download	Download snapshot (Git master) Git [?]: repo summary • tree • code changes SVN [?]: checkout-url • tree • code changes log
Hooks used LoadExtensionSchemaUpdates ParserFirstCallInit UnitTestsList ArticleDeleteComplete LinksUpdate
Check usage (experimental)

The GeoData extension allows articles to specify their geographical coordinates and publishes these coordinates via the HTTP API.

Usage

This extension adds a new parser function, {{#coordinates:}}, that saves coordinates to the database. Function's input format is made as compatible as possible with GeoHack.

Glossary

• Coordinates - see here
• Globe - terrestrial body on which the coordinate resides. By default, Earth is assumed. Internally, globe is represented as lowercase strings. The following globes are supported: earth, mercury, venus, moon, mars, phobos, deimos, ganymede, callisto, io, europa, mimas, enceladus, tethys, dione, rhea, titan, hyperion, iapetus, phoebe, miranda, ariel, umbriel, titania, oberon, triton and pluto. Globes not mentioned in this list will be assumed to have generic characteristics: longitude range 0-360°, Eastern longitude is positive. Longitude sign for known globes is taken according to IAU's conventions.
• dim - approximate size (or size's order of magnitude) of an object. Used by GeoData to restrict search and by Geohack for determining appropriate map zoom.
• Primary vs. secondary coordinates: primary coordinates define article subject's location, while secondary coordinates are other coordinates mentioned in the article. There can be only one primary coordinate per article, but as many secondaries as you like barring technical restrictions.

Parser function

Function format:

{{#coordinates:latitude|longitude|[primary|][GeoHack parameters|][extra parameters]}}

Note: Empty parameters (e.g. || or | |) are always ignored.

• latitude and longitude can be specified in several formats:
  • Direct signed input in degrees, e.g. 37.786971|-122.399677, which corresponds to 37° 47′ 13.1″ N, 122° 23′ 58.84″ W.
  • Degrees/minutes or degrees/minutes/seconds, e.g. 37|47.2183|-122|23.9807 or 37|47|13.1|-122|23|58.84.
  • Either of the above, but with sign specified by N/E/S/W letters:

    37.786971|N|122.399677|W

    37|47.2183|N|122|23.9807|W

    37|47|13.1|N|-122|23|58.84|W

Note: You should use either negative sign or N/E/S/W, but not both

• primary keyword specifies that these coordinates are primary (see #Glossary).
• Extra parameters are any combination of the following named parameters:
  • dim: approximate size of the object.
  • scale: Scale of map display for this object, e.g. scale of 300 is 1:300. Gets converted into dim internally using formula dim = scale / 10. If both scale and dim are set, dim has precendence.
  • globe, see #Glossary.
  • name: name of this point, up to 255 bytes (UTF-8).
  • region: ISO 3166-1 alpha-2 country code (e.g. US or RU) or an ISO 3166-2 region code (e.g. US-FL or RU-MOS). This parameter is always capitalised internally.
  • type: type of object with these coordinates, can be one of the following: country, satellite, state, adm1st, adm2nd, adm3rd, city, isle, mountain, river, waterbody, event, forest, glacier, airport, railwaystation, edu, pass, camera, landmark.

type	Description	Dim
country	(e.g. "type:country")	1,000,000
satellite	geo-stationary satellites	1,000,000
adm1st	Administrative unit of country, 1st level (province, state), e.g. U.S. states	1,000,000
adm2nd	Administrative unit of country, 2nd level, e.g. US county	30,000
adm3rd	Administrative unit of country, 3rd level	10,000
city(pop)	cities, towns, villages, hamlets, suburbs, subdivisions, neighborhoods, and other human settlements (including unincorporated and/or abandoned ones) with known population (optional population in braces is ignored)	10,000
airport	airports and airbases	3,000
mountain	peaks, mountain ranges, hills, submerged reefs, and seamounts	10,000
isle	islands and isles	10,000
waterbody	bays, fjords, lakes, reservoirs, ponds, lochs, loughs, meres, lagoons, estuaries, inland seas, and waterfalls	10,000
forest	forests and woodlands	5,000
river	rivers, canals, creeks, brooks, and streams, including intermittent ones	10,000
glacier	glaciers and icecaps	5,000
event	one-time or regular events and incidents that occurred at a specific location, including battles, earthquakes, festivals, and shipwrecks	5,000
edu	schools, colleges, and universities	1,000
pass	mountain passes	1,000
railwaystation	stations, stops, and maintenance areas of railways and trains, including railroad, metro, rapid transit, underground, subway, elevated railway, etc.	1,000
landmark	buildings (including churches, factories, museums, theatres, and power plants but excluding schools and railway stations), caves, cemeteries, cultural landmarks, geologic faults, headlands, intersections, mines, ranches, roads, structures (including antennas, bridges, castles, dams, lighthouses, monuments, and stadiums), tourist attractions, valleys, and other points of interest	1,000
	Default dim: if no type is used or the type is unknown to this extension	1,000

• GeoHack parameters: one or more pairs in format parameter:value, delimited by underscores (_) or spaces (e.g. dim:1000_type:city). No spaces are allowed between parameter and colon or between colon and value. The parameters are the same as extra parameters above. If a parameter exists in both GeoHack parameters and extra parameters, extra parameters always have precendence. This input is needed only for compatibilty with preexisting {{coord}} templates - if your wiki is only designing a geographical coordinates template, it is best if you not used raw GeoHack parameters at all.

Usage

This extension adds a new parser function,

API

GeoData has two API modules that perform search around a given point and coordinates for a given article(s).

list=geosearch

Searches for articles around the given point (determined either by coordinates or by article name).

Parameters:

gscoord

Coordinate around which to search: two floating-point values separated by pipe (|)

gspage

Title of page around which to search

gsradius

Search radius in meters (10-10000). This parameter is required.

gsmaxdim

Restrict search to objects no larger than this, in meters

gslimit

Maximum number of pages to return. No more than 500 (5000 for bots) allowed. Default: 10.

gsglobe

Globe to search on (by default earth).

gsnamespace

Namespace(s) to search. Default: main namespace.

gsprop

What additional coordinate properties to return. Values (separate with '|'): type, name, country, region.

gsprimary

Whether to return only primary coordinates (yes), secondary (no) or both (yes|no). Default: yes.

Example:

• Search around the point with coordinates 37° 47′ 13.1″ N, 122° 23′ 58.84″ W:
  • api.php?action=query&list=geosearch&gsradius=10000&gscoord=37.786971|-122.399677

<?xml version="1.0"?>
<api>
  <query>
    <geosearch>
      <gs pageid="286442" ns="0" title="Wikimedia Foundation" lat="37.787" lon="-122.4" dist="0.3" primary="" />
      <gs pageid="283855" ns="0" title="Chinatown, San Francisco" lat="37.7947" lon="-122.407" dist="1087.3" primary="" />
      <gs pageid="167267" ns="0" title="City Lights Bookstore" lat="37.7976" lon="-122.407" dist="1331" primary="" />
      <gs pageid="258568" ns="0" title="Asian Art Museum of San Francisco" lat="37.7803" lon="-122.417" dist="1661.5" primary="" />
      <gs pageid="67167" ns="0" title="North Beach, San Francisco" lat="37.8003" lon="-122.41" dist="1745.3" primary="" />
      <gs pageid="250933" ns="0" title="Coit Tower" lat="37.8024" lon="-122.406" dist="1797.9" primary="" />
      <gs pageid="219250" ns="0" title="Roman Catholic Archdiocese of San Francisco" lat="37.7856" lon="-122.424" dist="2157.6" primary="" />
      <gs pageid="268254" ns="0" title="San Francisco LGBT Community Center" lat="37.7718" lon="-122.424" dist="2729.9" primary="" />
      <gs pageid="130498" ns="0" title="USS Pampanito (SS-383)" lat="37.8099" lon="-122.416" dist="2942.4" primary="" />
      <gs pageid="263996" ns="0" title="The Fillmore" lat="37.7841" lon="-122.433" dist="2956.9" primary="" />
    </geosearch>
  </query>
</api>

prop=coordinates

Returns coordinates of the given page(s)

Parameters:

colimit

How many coordinates to return.

cocontinue

When more results are available, use this to continue.

coprop

What additional coordinate properties to return. Values (separate with '|'): type, name, country, region.

coprimary

Whether to return only primary coordinates (yes), secondary (no) or both (yes|no). Default: yes.

Examples:

• Get a list of coordinates of the Wikimedia Foundation article:
  • api.php?action=query&prop=coordinates&titles=Wikimedia%20Foundation

<?xml version="1.0"?>
<api>
  <query>
    <pages>
      <page pageid="286442" ns="0" title="Wikimedia Foundation">
        <coordinates>
          <co lat="37.787" lon="-122.4" primary="" />
        </coordinates>
      </page>
    </pages>
  </query>
</api>

Enumerating pages with or without coordinates

GeoData extends two core API modules, list=allpages and list=categorymembers. The extended modules are called geopages and geopagesincategory. It adds two mutually exclusive parameters, withcoordinates and withoutcoordinates.

Installation

Note: Currently, only MySQL 5 or later is supported.

1. Download the files from SVN or download a snapshot (select your version of MediaWiki) and place the files under $IP/extensions/GeoData
2. Add to the end of LocalSettings.php:
   require_once("$IP/extensions/GeoData/GeoData.php");
3. Add the required tables to the database; on the command line, enter:
   
   php maintenance/update.php
   (Note: Your designated database user needs to have CREATE rights on your MediaWiki database.)
4. Installation can now be verified through Special:Version on your wiki
   

Language:	English