Add embed hint to datapreviews
[ckanext-datagovau.git] / README.rst
Alex Sadleir 1 This CKAN Extension customises a CKAN instance for the hosting of data.gov.au.
2
3 It comprises:
4
5 * A CKAN Extension "plugin" at ``ckanext/datagovau/plugin.py`` which, when
rgrp 6 loaded, overrides various settings in the core ``ini``-file to provide:
CKAN data.gov.au 7 * A path to local customisations of the core templates to include AGLS/Dublin Core minimum metadata
Alex Sadleir 8 * A custom Package edit form that defaults to cc-by licence
Alex Sadleir 9 * A custom n3/rdf output format
CKAN data.gov.au 10 * Replaces links with http/https protocol independent versions
11 * Provides HTML to users to embed data previews on their own website
12
Alex Sadleir 13 * A cut down licenses.json file
14
Seb Bacon 15 Installation
16 ============
17
18 To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``)::
19
Alex Sadleir 20 pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau
John Glover 21
Alex Sadleir 22 Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file.
John Glover 23
Alex Sadleir 24 To add the cut down licenses.json set ``licenses_group_url = http://%(ckan.site_url)/licenses.json``
25 or copy ``ckanext/datagovau/theme/public/licenses.json`` to the same folder as your CKAN config ini file
26 and set ``licenses_group_url = file://%(here)s/licenses.json``
27
John Glover 28
29