Updated PluginArchitecture (markdown)

tmcw 2011-12-09 13:10:48 -08:00
parent 4a3aca33aa
commit 2bf4fb613d

@ -10,45 +10,47 @@ All current plugins are located in source:trunk/plugins/input/
| **Name**| **Availability**|**Status**|**Build by Default**|**Notes**| | **Name**| **Availability**|**Status**|**Build by Default**|**Notes**|
|:-------:|:---------------:|:--------:|:------------------:|:-------:| |:-------:|:---------------:|:--------:|:------------------:|:-------:|
| *[postgis](/wiki:PostGIS/)*| 0.2.0| Stable| yes| support for accessing geospatial data through [wiki:PostGIS], the spatial database extension for [PostgreSQL](http://en.wikipedia.org/wiki/PostgreSQL)| | *[postgis](PostGIS)*| 0.2.0| Stable| yes| support for accessing geospatial data through [wiki:PostGIS], the spatial database extension for [PostgreSQL](http://en.wikipedia.org/wiki/PostgreSQL)|
| *[raster](/wiki:Raster/)*| 0.2.0| Stable| yes| stripped or tiled raster TIFF image dataset support| | *[raster](Raster)*| 0.2.0| Stable| yes| stripped or tiled raster TIFF image dataset support|
| *[shape](/wiki:Shape/)*| 0.2.0| Stable| yes| vector SHP ([ESRI Shapefile](http://en.wikipedia.org/wiki/Shapefile)) parsing| | *[shape](Shape)*| 0.2.0| Stable| yes| vector SHP ([ESRI Shapefile](http://en.wikipedia.org/wiki/Shapefile)) parsing|
| *[gdal](/wiki:GDAL/)*| 0.5.0| Beta| no| support for [GDAL](http://en.wikipedia.org/wiki/GDAL) datasets| | *[gdal](GDAL/)*| 0.5.0| Beta| no| support for [GDAL](http://en.wikipedia.org/wiki/GDAL) datasets|
| *[ogr](/wiki:OGR/)* | 0.6.0| Beta| no| support for [OGR](http://en.wikipedia.org/wiki/GDAL) datasets| | *[ogr](OGR)* | 0.6.0| Beta| no| support for [OGR](http://en.wikipedia.org/wiki/GDAL) datasets|
| *[osm](/wiki:OsmPlugin/)*| 0.6.0| Beta| no| support for reading OpenStreetMap (OSM) xml datasets| | *[osm](OsmPlugin)*| 0.6.0| Beta| no| support for reading OpenStreetMap (OSM) xml datasets|
| *[sqlite](/wiki:SQLite/)*| 0.6.0| Beta| no| support for [SQLite](http://en.wikipedia.org/wiki/SQLite) / [Spatialite](http://www.gaia-gis.it/spatialite) sql vector format| | *[sqlite](SQLite)*| 0.6.0| Beta| no| support for [SQLite](http://en.wikipedia.org/wiki/SQLite) / [Spatialite](http://www.gaia-gis.it/spatialite) sql vector format|
| *[occi](/wiki:OCCI/)*| 0.6.0| Beta| no| support for oracle spatial 10g (versions 10.2.0.x) ([Oracle Spatial](http://en.wikipedia.org/wiki/Oracle_Spatial)) sql vector format| | *[occi](OCCI)*| 0.6.0| Beta| no| support for oracle spatial 10g (versions 10.2.0.x) ([Oracle Spatial](http://en.wikipedia.org/wiki/Oracle_Spatial)) sql vector format|
| *[kismet](/wiki:Kismet/)*| SVN| Alpha| no| support for [Kismet](http://www.kismetwireless.net/) GPS; shows little WLAN nodes on the map| | *[kismet](Kismet)*| SVN| Alpha| no| support for [Kismet](http://www.kismetwireless.net/) GPS; shows little WLAN nodes on the map|
| *[rasterlite](/wiki:Rasterlite/)*| SVN| Experimental| no| support for [Rasterlite](http://www.gaia-gis.it/spatialite) sqlite raster with wavelet compression| | *[rasterlite](Rasterlite)*| SVN| Experimental| no| support for [Rasterlite](http://www.gaia-gis.it/spatialite) sqlite raster with wavelet compression|
| *[geos](/wiki:GEOS/)*| SVN| Experimental| no| support for inline WKT geometries using [GEOS](http://trac.osgeo.org/geos/) library| | *[geos](GEOS)*| SVN| Experimental| no| support for inline WKT geometries using [GEOS](http://trac.osgeo.org/geos/) library|
*Note*: When compiling Mapnik from source only the PostGIS, Raster, and Shape plugins will be compiled by default. *Note*: When compiling Mapnik from source only the PostGIS, Raster, and Shape plugins will be compiled by default.
To request additional plugins to be compiled and installed make sure you have the required dependencies and then specify the list of plugins for SCons to build: To request additional plugins to be compiled and installed make sure you have the required dependencies and then specify the list of plugins for SCons to build:
#!sh ```sh
# attempt to build all plugins possible # attempt to build all plugins possible
$ python scons/scons.py INPUT_PLUGINS='all' $ python scons/scons.py INPUT_PLUGINS='all'
# build just the postgis plugin: # build just the postgis plugin:
$ python scons/scons.py INPUT_PLUGINS='postgis' $ python scons/scons.py INPUT_PLUGINS='postgis'
```
= Querying plugins = = Querying plugins =
If you compiled Mapnik with DEBUG=True, then the list of plugins registered by the python bindings will during initial import: If you compiled Mapnik with DEBUG=True, then the list of plugins registered by the python bindings will during initial import:
```
Python 2.5.1 (r251:54863, Jan 17 2008, 19:35:17) Python 2.5.1 (r251:54863, Jan 17 2008, 19:35:17)
>>> import mapnik >>> import mapnik
registered datasource : gdal registered datasource : gdal
registered datasource : raster registered datasource : raster
registered datasource : shape registered datasource : shape
```
Otherwise, get a listing of available plugins with this command: Otherwise, get a listing of available plugins with this command:
```sh
$ python -c "from mapnik import DatasourceCache as c; print ','.join(c.plugin_names())" $ python -c "from mapnik import DatasourceCache as c; print ','.join(c.plugin_names())"
These are the registered datasource plugins that Mapnik's python binding currently knows about. These are the registered datasource plugins that Mapnik's python binding currently knows about.
```
*TODO:* Propose icons at OSM *TODO:* Propose icons at OSM