| This CKAN Extension demonstrates some common patterns for customising a CKAN instance. | This CKAN Extension customises a CKAN instance for the hosting of data.gov.au. |
| It comprises: | It comprises: |
| * A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when | * A custom Package edit form that defaults to cc-by licence |
| loaded, overrides various settings in the core ``ini``-file to provide: | * 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 path to local customisations of the core templates and stylesheets | This extension is complemented by ckanext-agls for AGLS metadata, ckanext-googleanalytics for Google Analytics tracking of API usage and ckanext-dga-stats for the customised site statistics page. |
| * A "stream filter" that replaces arbitrary strings in rendered templates | |
| * A "route" to override and extend the default behaviour of a core CKAN page | |
| * A custom Pylons controller for overriding some core CKAN behaviour | |
| * A custom Package edit form | |
| * Some simple template customisations | |
| 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-example#egg=ckanext-example | pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau |
| Then activate it by setting ``ckan.plugins = example`` 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`` | |
| 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`` | |
| Orientation | |
| =========== | |
| * Examine the source code, starting with ``ckanext/example/plugin.py`` | |
| * To understand the nuts and bolts of this file, which is a CKAN | |
| *Extension*, read in conjunction with the "Extension | |
| documentation":http://packages.python.org/ckan/plugins.html | |
| * One thing the extension does is set the values of | |
| ``extra_public_paths`` and ``extra_template_paths`` in the CKAN | |
| config, which are "documented | |
| here":http://packages.python.org/ckan/configuration.html#extra-template-paths | |
| * These are set to point at directories within | |
| `ckanext/example/theme/`` (in this package). Here, we override | |
| the home page, provide some extra style with an ``extra.css``, and | |
| customise the navigation and header of the main template in the file ``layout.html``. | |
| The latter file is a great place to make global theme alterations. | |
| It uses the _layout template_ pattern "described in the Genshi | |
| documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate. | |
| This allows you to use Xpath selectors to override snippets of HTML | |
| globally. | |
| * The custom package edit form at ``package_form.py`` follows the | |
| conventions in the "main CKAN | |
| documentation":http://packages.python.org/ckan/forms.html | |