gitphp 0.2.9.1 :: ckanext-datagovau.git/commitdiff

Add embed hint to datapreviews

2 files changed: (show all)
README.rst
ckanext/datagovau/templates/dataviewer/snippets/data_preview.html (new)

file:a/README.rst -> file:b/README.rst

file:b/ckanext/datagovau/templates/dataviewer/snippets/data_preview.html (new)

	<div class="module-content ckanext-datapreview">
	{% if embed %}
	{# images can be embedded directly #}
	<img src="{{ resource_url }}"></img>
	{% else %}
	<div class="data-viewer-error js-hide">
	<p class="text-error">
	<i class="icon-info-sign"></i>
	{{ _('This resource can not be previewed at the moment.') }}
	<a href="#" data-toggle="collapse" data-target="#data-view-error">
	{{ _('Click here for more information.') }}
	</a>
	</p>
	<p id="data-view-error" class="collapse"></p>
	<p>
	<a href="{{ raw_resource_url }}" class="btn btn-large resource-url-analytics" target="_blank">
	<i class="icon-large icon-download"></i>
	{{ _('Download resource') }}
	</a>
	</p>
	</div>
	<iframe src="{{ resource_url }}" frameborder="0" width="100%" data-module="data-viewer">
	<p>{{ _('Your browser does not support iframes.') }}</p>
	</iframe>
	{% endif %}
	</div>
	<div class="embedhint" style="padding-left: 15px;">
	<h4>Embed this visualisation in your own website...</h4>
	Copy the HTML in the box below and you can display this visualisation on your own website.<br/>
	<textarea style="width:97%"><iframe src="{{ resource_url }}" frameborder="0" width="100%" height="600px"></iframe></textarea>
	</div>

This CKAN Extension customises a CKAN instance for the hosting of data.gov.au.	This CKAN Extension customises a CKAN instance for the hosting of data.gov.au.

It comprises:	It comprises:

* A CKAN Extension "plugin" at ``ckanext/datagovau/plugin.py`` which, when	* A CKAN Extension "plugin" at ``ckanext/datagovau/plugin.py`` which, when
loaded, overrides various settings in the core ``ini``-file to provide:	loaded, overrides various settings in the core ``ini``-file to provide:
* A path to local customisations of the core templates	* A path to local customisations of the core templates to include AGLS/Dublin Core minimum metadata
* A custom Package edit form that defaults to cc-by licence	* A custom Package edit form that defaults to cc-by licence
* A custom n3/rdf output format	* A custom n3/rdf output format
	* Replaces links with http/https protocol independent versions
	* Provides HTML to users to embed data previews on their own website

* A cut down licenses.json file	* A cut down licenses.json file

Installation	Installation
============	============

To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``)::	To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``)::

pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau	pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau

Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file.	Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file.

To add the cut down licenses.json set ``licenses_group_url = http://%(ckan.site_url)/licenses.json``	To add the cut down licenses.json set ``licenses_group_url = http://%(ckan.site_url)/licenses.json``
or copy ``ckanext/datagovau/theme/public/licenses.json`` to the same folder as your CKAN config ini file	or copy ``ckanext/datagovau/theme/public/licenses.json`` to the same folder as your CKAN config ini file
and set ``licenses_group_url = file://%(here)s/licenses.json``	and set ``licenses_group_url = file://%(here)s/licenses.json``