GeoFormAlchemy 0.1

GeoFormAlchemy is a FormAlchemy extension that makes it possible to generate forms for model classes that use the geometry types of GeoAlchemy.<br /><br />Installation<br /><br />Installing using easy_install:<br /><br />easy_install geoformalchemy<br /><br />Manual installation for development:<br /><br />Download the source code as archive or clone the GIT repository:<br /><br />git clone http://github.com/camptocamp/GeoFormAlchemy.git GeoFormAlchemy<br /><br />Then run the setup:<br /><br />cd GeoFormAlchemy/GeoFormAlchemy<br />python setup.py develop<br /><br />Usage in Pylons applications<br /><br />GeoFormAlchemy includes a Paster Pylons template that builds upon FormAlchemy's administration interface for Pylons.<br /><br />If you want to use GeoFormAlchemy in your Pylons application, run paster create with the GeoFormAlchemy template:<br /><br />$ paster create -t geo_fa your_app<br />[..]<br />Enter admin_controller (Add formalchemy's admin controller) [False]: True<br />Enter template_engine (mako/genshi/jinja2/etc: Template language) ['mako']: mako<br />Enter sqlalchemy (True/False: Include SQLAlchemy 0.5 configuration) [False]: True<br />[..]<br /><br />Then the GeoFormAlchemy extension has to be activated. Open the file your_app/forms/__init__.py and add the following lines at the end of the file:<br /><br /># [..]<br /><br />from geoformalchemy.base import GeometryFieldRenderer<br />from geoalchemy import geometry<br />FieldSet.default_renderers[geometry.Geometry] = GeometryFieldRenderer<br /><br />GeoFormAlchemy is now set up and a map will be displayed in the forms for your geometry fields. Note that you will have to tell FormAlchemy for which model classes it should create forms. To do so import your model classes in the file your_app/model/__init__.py. For more information please refer to the FormAlchemy documentation.<br /><br />Configuration<br /><br />Field modifications<br /><br />The rendering of geometry fields can be customized with additional options. For example the following statement called on the field the_geom of the custom FieldSet changes the background map (inside the file your_app/forms/__init__.py):<br /><br />Place = FieldSet(model.places.Place)<br />Place.the_geom.set(options=[<br /> ('map_srid', 900913),<br /> ('base_layer', 'new OpenLayers.Layer.OSM("OSM")')<br />])<br /><br />The following options are available in GeoFormAlchemy:<br /><br />default_lat and default_lon<br /> If the geometry is None or when creating a new geometry, the map is centered at (default_lon, default_lat). Otherwise the map is centered at the centroid of the geometry.<br />zoom<br /> The zoom-level on start-up.<br />map_width and map_height<br /> The size of the DIV container in which the map is displayed.<br />base_layer<br /><br /> The OpenLayers layer which will be used as background map, for example:<br /><br /> ('base_layer', 'new OpenLayers.Layer.OSM("OSM")')<br /><br />map_srid<br /><br /> If the map uses a different CRS than the geometries, the geometries will be reprojected to this CRS. For example:<br /><br /> ('map_srid', 900913)<br /><br />openlayers_lib<br /><br /> The path to the OpenLayers javascript library, for example if OpenLayers.js is located at your_app/public/js/lib/OpenLayers.js use the following path:<br /><br /> ('openlayers_lib', '/js/lib/OpenLayers.js')<br /><br />show_map (default: True)<br /> If show_map is set to False, the geometry will be displayed as WKT string inside a text input field.<br /><br />Template files<br /><br />If you want to change the look of your forms, you can modify the template files used by FormAlchemy and GeoFormAlchemy. The template files are located in the folder your_app/templates/forms.<br /><br />GeoFormAlchemy uses the template files map_js.mako and map.mako. In map.mako you can set most of the options that you can also use as field modification. But unlike to field modifications, the options set in the template file are used for the geometry fields of all models, whereas the options set as field modification are only used for the field they were set on.<br /><br />< %<br /># default configuration options that will be used when<br /># no field options were set<br /><br />options = {}<br />options['default_lon'] = 10<br />options['default_lat'] = 45<br />options['zoom'] = 4<br />options['map_width'] = 512<br />options['map_height'] = 256<br />options['base_layer'] = 'new OpenLayers.Layer.WMS("WMS", "http://labs.metacarta.com/wms/vmap0", {layers: "basic"})'<br />options['openlayers_lib'] = 'http://openlayers.org/api/OpenLayers.js'<br /><br />% ><br /><br />If you want to customize the OpenLayers map, for example to add a further OpenLayers control or to add a second background layer, modify the file map_js.mako.<br /><br /><br />#md5=9dd6043d7566fb993dd2e6af009ee82f

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	039new,  Background,  Create,  False,  Field,  Fields,  Files,  Formalchemy,  Forms,  Geoformalchemy,  Geometry,  Import,  Model,  Openlayers,  Options,  Pylons,  Template
Users rating:	0/10