Add embed hint to datapreviews
[ckanext-datagovau.git] / README.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
This CKAN Extension customises a CKAN instance for the hosting of data.gov.au.

It comprises:

* A CKAN Extension "plugin" at ``ckanext/datagovau/plugin.py`` which, when
  loaded, overrides various settings in the core ``ini``-file to provide:
  * 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 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

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

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

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``
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``