Changeset 1220

Show
Ignore:
Timestamp:
11/02/07 17:58:22 (1 year ago)
Author:
sgillies
Message:

Improve readme

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • PleiadesGeocoder/trunk/README.txt

    r403 r1220  
    22================ 
    33 
    4 A geocoder for Plone locations based on geopy. A geocoder converts text 
    5 locations such as "Fort Collins, Colorado" to spatial coordinates. Other 
    6 geocoding backends could be supported in the future. 
     4Provides basic geospatial capabilities for Plone, specifically: 
     5 
     6* Geospatial annotation of content based on emerging standards. Point, line, 
     7and polygon annotations are possible. 
     8 
     9* Serialization of annotated content to Atom (+GeoRSS_) or KML, which enables 
     10content to be marshaled into Google Earth, GMaps, or OpenLayers maps.  
     11 
     12* A geocoding tool based on geopy. 
    713 
    814See http://icon.stoa.org/trac/pleiades/wiki/PleiadesGeocoder for more 
    …… 
    1218 
    1319 
    14 DEPENDENCIES 
     20Dependencies 
    1521------------ 
    1622 
    …… 
    3339-------------------------- 
    3440 
    35 1. Checkout PleiadesGeocoder 
     411. Checkout PleiadesGeocoder:: 
    3642 
    3743   $ svn co http://icon.stoa.org/svn/pleiades/PleiadesGeocoder/trunk \ 
    …… 
    4248 
    4349 
    44 Usage 
    45 ----- 
     50Geospatial Annotation 
     51--------------------- 
    4652 
    47 The immediate use of the portal_geocoder is to geocode site user *location* 
    48 strings, which users can set through their preferences form, and set spatial 
    49 coordinates for users. Geocoded users can then be mapped using the 
    50 complementary PleiadesOpenLayers product: 
     53Content objects that provide 
     54Products.PleiadesGeocoder.interfaces.IGeoreferenceable and have registered 
     55adapters to Products.PleiadesGeocoder.interfaces.IGeoItemSimple can be 
     56annotated via the edit_geo_form. See for example: 
    5157 
    52 http://icon.stoa.org/trac/pleiades/wiki/PleiadesOpenLayers 
     58http://pleiades.stoa.org/batlas/65/edit_geo_form 
     59 
     60PleiadesGeocoder marks all AT content types as providers of IGeoreferenceable 
     61and IGeoItemSimple. In Python, content objects can be geo-annotated like so: 
     62 
     63.. code-block:: python 
     64 
     65  >>> ob = app['plone']['batlas']['65'] 
     66  >>> coordinates = (((28.54268, 38.08102, 0.0), ...)) 
     67  >>> geoitem.setGeoInterface('Polygon', coordinates) 
     68  >>> geoitem.geom_type 
     69  'Polygon' 
     70  >>> geoitem.coords 
     71  (((28.54268, 38.08102, 0.0), ...)) 
     72 
     73 
     74KML and GeoRSS views 
     75-------------------- 
     76 
     77Annotated objects that provide 
     78Products.PleiadesGeocoder.interfaces.IGeoserializable have GeoRSS and KML 
     79representations via georss and kml views. See for example: 
     80 
     81http://pleiades.stoa.org/batlas/65/georss 
     82http://pleiades.stoa.org/batlas/65/kml 
     83 
     84Furthermore, folderish objects containing geo-annotated content that provide 
     85that same interface have similiar views. See 
     86 
     87http://pleiades.stoa.org/batlas/georss 
     88http://pleiades.stoa.org/batlas/kml 
     89 
     90PleiadesGeocoder marks all AT folders and topics as providers of 
     91IGeoserializable. 
     92 
     93 
     94Geocoding Tool 
     95-------------- 
     96 
     97Currently, geocoding aims at one of Plone's standard metadata fields: location. 
     98This field is for strings like:: 
     99 
     100  "Chapel Hill, NC" 
     101  "London, England" 
     102   
     103Our current functionality focuses on site members. PleiadesGeocoder adds a new 
     104string property named 'spatialCoordinates' to your memberdata property sheet, 
     105and overrides the default personalize.py script.  On any update of member 
     106location, the portal_geocoder tool will attempt to find the proper coordinates 
     107by using the Google geocoding service. The coordinates are then stored in the 
     108member's 'spatialCoordinates' property. 
     109 
     110Views of a site's geocoded members can be had at the URLs: 
     111 
     112${portal_url}/Members/georss 
     113${portal_url}/Members/kml 
     114 
     115 
     116Support 
     117------- 
     118 
     119Please subscribe to the pleiades-software_ email list. The archives may be 
     120viewed online without subscription. 
    53121 
    54122 
    …… 
    64132U.S. National Endowment for the Humanities (http://www.neh.gov). 
    65133 
     134.. _GeoRSS: http://georss.org 
     135.. _pleiades-software: http://icon.stoa.org/trac/pleiades/wiki/PleiadesSoftwareList 
     136