CatalogueRevamping
/
spatial-d4science
14
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
spatial-d4science/doc/previews.rst

76 lines
2.9 KiB
ReStructuredText
Raw Normal View History

[#39] New docs Completely revised and restructured docs to be built with Sphinx. Structured in logic areas, with a big cleanup and nice formatting. Revised install instructions. Added the okfn-sphinx-theme submodule to have a consistent look and feel with the core CKAN docs, although core docs are using an older revision.
2013-09-08 20:42:39 +02:00
============================
Previews for Spatial Formats
============================
The extension includes some plugins that implement the IResourcePreview_
interface, allowing to preview spatial resource files. They are based in
popular Javascript mapping libraries and should be really easy to extend and
adapt to your own needs.
GeoJSON Preview
---------------
.. image:: _static/preview-geojson.png
The GeoJSON previewer is based on Leaflet_. It will render GeoJSON_ files on a
map and add a popup showing the features properties, for those resources that
typo
2013-11-07 19:05:44 +01:00
have a format of ``geojson`` or ``gjson``.
[#39] New docs Completely revised and restructured docs to be built with Sphinx. Structured in logic areas, with a big cleanup and nice formatting. Revised install instructions. Added the okfn-sphinx-theme submodule to have a consistent look and feel with the core CKAN docs, although core docs are using an older revision.
2013-09-08 20:42:39 +02:00
[#98] Minor tweaks to @u10313335 PR * Keep old entry points for preview plugins so people does not need to do python setup.py develop * Version checks should be done including the min_version parameter, otherwise they will fail for 2.4, 2.5... * No need to define different methods for different interfaces. If running eg 2.3, the IResourcePreview interface methods will simply be ignored. * Simplified same domain checking * Add note about these being eventually migrated to ckanext-geoviews * Added docs
2015-04-02 12:28:06 +02:00
To enable the GeoJSON previewer you need to add the ``geojson_view`` plugin
[#39] New docs Completely revised and restructured docs to be built with Sphinx. Structured in logic areas, with a big cleanup and nice formatting. Revised install instructions. Added the okfn-sphinx-theme submodule to have a consistent look and feel with the core CKAN docs, although core docs are using an older revision.
2013-09-08 20:42:39 +02:00
to your ini file. This plugin also requires the `resource_proxy`_
plugin (Make sure you load the ``resource_proxy`` plugin before any other
from the spatial extension)::
[#98] Minor tweaks to @u10313335 PR * Keep old entry points for preview plugins so people does not need to do python setup.py develop * Version checks should be done including the min_version parameter, otherwise they will fail for 2.4, 2.5... * No need to define different methods for different interfaces. If running eg 2.3, the IResourcePreview interface methods will simply be ignored. * Simplified same domain checking * Add note about these being eventually migrated to ckanext-geoviews * Added docs
2015-04-02 12:28:06 +02:00
ckan.plugins = resource_proxy geojson_view
[#39] New docs Completely revised and restructured docs to be built with Sphinx. Structured in logic areas, with a big cleanup and nice formatting. Revised install instructions. Added the okfn-sphinx-theme submodule to have a consistent look and feel with the core CKAN docs, although core docs are using an older revision.
2013-09-08 20:42:39 +02:00
[#98] Minor tweaks to @u10313335 PR * Keep old entry points for preview plugins so people does not need to do python setup.py develop * Version checks should be done including the min_version parameter, otherwise they will fail for 2.4, 2.5... * No need to define different methods for different interfaces. If running eg 2.3, the IResourcePreview interface methods will simply be ignored. * Simplified same domain checking * Add note about these being eventually migrated to ckanext-geoviews * Added docs
2015-04-02 12:28:06 +02:00
.. note:: If using CKAN < 2.3, use `geojson_preview`
[#39] New docs Completely revised and restructured docs to be built with Sphinx. Structured in logic areas, with a big cleanup and nice formatting. Revised install instructions. Added the okfn-sphinx-theme submodule to have a consistent look and feel with the core CKAN docs, although core docs are using an older revision.
2013-09-08 20:42:39 +02:00
WMS Preview
-----------
.. image:: _static/preview-wms.png
[#52] Add note about WMS urls for preview
2014-01-09 18:49:37 +01:00
The WMS previewer is based on OpenLayers_. When the plugin is enabled, if
[#39] New docs Completely revised and restructured docs to be built with Sphinx. Structured in logic areas, with a big cleanup and nice formatting. Revised install instructions. Added the okfn-sphinx-theme submodule to have a consistent look and feel with the core CKAN docs, although core docs are using an older revision.
2013-09-08 20:42:39 +02:00
datasets contain a resource that has ``wms`` format, the resource page will
load a simple map viewer that will attempt to load the remote service layers,
[#52] Add note about WMS urls for preview
2014-01-09 18:49:37 +01:00
based on the GetCapabilities response. In order for the proxy to get correct
response, the URL of the resource must be a full GetCapabilities request, not
just the main WMS service endpoint, for example:
http://vmap0.tiles.osgeo.org/wms/vmap0?SERVICE=WMS&REQUEST=GetCapabilities&VERSION=1.1.1
[#39] New docs Completely revised and restructured docs to be built with Sphinx. Structured in logic areas, with a big cleanup and nice formatting. Revised install instructions. Added the okfn-sphinx-theme submodule to have a consistent look and feel with the core CKAN docs, although core docs are using an older revision.
2013-09-08 20:42:39 +02:00
[#98] Minor tweaks to @u10313335 PR * Keep old entry points for preview plugins so people does not need to do python setup.py develop * Version checks should be done including the min_version parameter, otherwise they will fail for 2.4, 2.5... * No need to define different methods for different interfaces. If running eg 2.3, the IResourcePreview interface methods will simply be ignored. * Simplified same domain checking * Add note about these being eventually migrated to ckanext-geoviews * Added docs
2015-04-02 12:28:06 +02:00
To enable the WMS previewer you need to add the ``wms_view`` plugin to your
[#39] New docs Completely revised and restructured docs to be built with Sphinx. Structured in logic areas, with a big cleanup and nice formatting. Revised install instructions. Added the okfn-sphinx-theme submodule to have a consistent look and feel with the core CKAN docs, although core docs are using an older revision.
2013-09-08 20:42:39 +02:00
ini file. This plugin also requires the `resource_proxy`_
plugin (Make sure you load the ``resource_proxy`` plugin before any other
from the spatial extension::
[#98] Minor tweaks to @u10313335 PR * Keep old entry points for preview plugins so people does not need to do python setup.py develop * Version checks should be done including the min_version parameter, otherwise they will fail for 2.4, 2.5... * No need to define different methods for different interfaces. If running eg 2.3, the IResourcePreview interface methods will simply be ignored. * Simplified same domain checking * Add note about these being eventually migrated to ckanext-geoviews * Added docs
2015-04-02 12:28:06 +02:00
ckan.plugins = resource_proxy wms_view
.. note:: If using CKAN < 2.3, use `geojson_preview`
[#39] New docs Completely revised and restructured docs to be built with Sphinx. Structured in logic areas, with a big cleanup and nice formatting. Revised install instructions. Added the okfn-sphinx-theme submodule to have a consistent look and feel with the core CKAN docs, although core docs are using an older revision.
2013-09-08 20:42:39 +02:00
.. note:: Please note that the WMS previewer included in ckanext-spatial is
just a proof of concept and has important limitations, and is
just intended as a bootstrap for developers willing to build a more
sophisticated one.
Some projects that have built more advanced map viewers and
integrated them with CKAN include:
* Data.gov.uk (http://data.gov.uk):
- https://github.com/datagovuk/ckanext-dgu
- https://github.com/datagovuk/ckanext-os
* Catalog.data.gov (http://catalog.data.gov):
- https://github.com/okfn/ckanext-geodatagov
- https://github.com/chilukey/viewer
.. _IResourcePreview: http://docs.ckan.org/en/latest/writing-extensions.html#ckan.plugins.interfaces.IResourcePreview
.. _resource_proxy: http://docs.ckan.org/en/latest/data-viewer.html#viewing-remote-resources-the-resource-proxy
.. _Leaflet: http://leafletjs.org
.. _GeoJSON: http://geojson.org
.. _OpenLayers: http://openlayers.org