Skip to content

Commit

Permalink
Merge branch 'release-v1.7' of github.com:okfn/ckan into release-v1.7
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean Hammond committed Apr 26, 2012
2 parents 9308856 + a99df11 commit a7541d2
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 0 deletions.
3 changes: 3 additions & 0 deletions ckan/controllers/package.py
Expand Up @@ -480,6 +480,7 @@ def edit(self, id, data=None, errors=None, error_summary=None):
c.errors_json = json.dumps(errors)

self._setup_template_variables(context, {'id': id}, package_type=package_type)
c.related_count = len(c.pkg.related)

# TODO: This check is to maintain backwards compatibility with the old way of creating
# custom forms. This behaviour is now deprecated.
Expand Down Expand Up @@ -749,6 +750,8 @@ def resource_read(self, id, resource_id):
c.package['isopen'] = False
c.datastore_api = h.url_for('datastore_read', id=c.resource.get('id'),
qualified=True)

c.related_count = len(c.pkg.related)
return render('package/resource_read.html')

def resource_embedded_dataviewer(self, id, resource_id):
Expand Down
40 changes: 40 additions & 0 deletions doc/data-viewer.rst
@@ -0,0 +1,40 @@
===========
Data Viewer
===========

CKAN's resource page can provide a preview of the resource's data if it is of
an appropriate format. If the data is available through the CKAN `DataStore
<datastore.html>`_ API, or if the data is a ``csv`` or ``xls`` file; then `Recline's
<http://github.com/okfn/recline>`_ `Data Explorer`_ is used. If the data is
another webpage; a google doc; or an image; then it is embedded in an iframe
for viewing. Or if the data is text-like, then it's raw contents are
displayed.

Data Explorer
=============

The `Recline <http://github.com/okfn/recline>`_
Data Explorer provides a rich, queryable view of the data. The data can be filtered,
faceted, graphed and mapped. Furthermore, the grid, graph or map can then be
embedded into your own site using the **Embed** button, and copying the provided
html snippet into your webpage.

How It Works (Technically)
==========================

The relevant code for setting up the data viewer is found in ``application.js``.

All resources available through the `DataStore <datastore.html>`_ API are
available for viewing through the `Data Explorer`_. using recline's
``elasticsearch`` backend. If the datastore is not available, and the filetype
is normalized to ``csv`` or ``xls``, then a dataproxy is used to attempt to view
the data (using recline's ``dataproxy`` backend).

Embedding
---------

If a resource is viewable through the Data Explorer, then it is also embeddable
in third-party web pages. ``/dataset/{name}/resource/{resource_id}/embed``
provides a stripped-down page containing the data explorer. The data
explorer's state is passed through using the url's query parameters.

1 change: 1 addition & 0 deletions doc/index.rst
Expand Up @@ -56,6 +56,7 @@ Publishing Datasets
authorization
publisher-profile
geospatial
data-viewer

The CKAN API
============
Expand Down

0 comments on commit a7541d2

Please sign in to comment.