ckanext-esdstandards 0.0.2

Adding the la_function and la_service fields to your custom schema

You will need to extend the default CKAN schema using the IDatasetForm interface (as described in the tutorial).

The extension provides a couple of validators to use. The fields generated should be stored as extras an named la_function and la_service (as per Appendix B of the data.gov.uk harvesting guide).

This snippet should be easy enough to follow (note: this assumes CKAN>=2.3):

import ckan.plugins as plugins
import ckan.plugins.toolkit as toolkit


class MyPlugin(plugins.SingletonPlugin, toolkit.DefaultDatasetForm):
    plugins.implements(plugins.IDatasetForm)


    # IDatasetForm

    def _modify_package_schema(self, schema):
        schema.update({
            'la_function': [toolkit.get_validator('ignore_missing'),
                            toolkit.get_validator('esd_function_validator'),
                            toolkit.get_converter('convert_to_extras')],
            'la_service': [toolkit.get_validator('ignore_missing'),
                           toolkit.get_validator('esd_service_validator'),
                           toolkit.get_converter('convert_to_extras')],
        })
        return schema

    def create_package_schema(self):
        schema = super(MyPlugin, self).create_package_schema()
        schema = self._modify_package_schema(schema)
        return schema

    def update_package_schema(self):
        schema = super(MyPlugin, self).update_package_schema()
        schema = self._modify_package_schema(schema)
        return schema

    def show_package_schema(self):
        schema = super(MyPlugin, self).show_package_schema()
        default_validators = [toolkit.get_converter('convert_from_extras'),
                              toolkit.get_validator('ignore_missing')]

        schema.update({
            'la_function': default_validators,
            'la_service': default_validators,
        })
        return schema

On CKAN versions lower than 2.3, the validators need to be explicitly imported:

import ckan.plugins as plugins
import ckan.plugins.toolkit as toolkit

from ckanext.esdstandards.validators import (esd_function_validator,
                                             esd_service_validator)

class MyPlugin(plugins.SingletonPlugin, toolkit.DefaultDatasetForm):
    plugins.implements(plugins.IDatasetForm)


    # IDatasetForm

    def _modify_package_schema(self, schema):
        schema.update({
            'la_function': [toolkit.get_validator('ignore_missing'),
                            esd_function_validator,
                            toolkit.get_converter('convert_to_extras')],
            'la_service': [toolkit.get_validator('ignore_missing'),
                           esd_service_validator,
                           toolkit.get_converter('convert_to_extras')],
        })
        return schema

    def create_package_schema(self):
        schema = super(MyPlugin, self).create_package_schema()
        schema = self._modify_package_schema(schema)
        return schema

    def update_package_schema(self):
        schema = super(MyPlugin, self).update_package_schema()
        schema = self._modify_package_schema(schema)
        return schema

    def show_package_schema(self):
        schema = super(MyPlugin, self).show_package_schema()
        default_validators = [toolkit.get_converter('convert_from_extras'),
                              toolkit.get_validator('ignore_missing')]

        schema.update({
            'la_function': default_validators,
            'la_service': default_validators,
        })
        return schema

Adding the Functions and Services fields to the dataset form

The extension provides two covenient snippets that will add all the necessary markup and scripts to the templates. You need to extend the package_basic_fields.html template on your own extension with the following:

# ckanext-yourext/ckanext/yourext/templates/package/snippets/package_basic_fields.html

{% ckan_extends %}

{% block package_basic_fields_custom %}

  {% snippet 'snippets/esd_functions.html', data=data, errors=errors %}

  {% snippet 'snippets/esd_services.html', data=data, errors=errors %}

{% endblock %}

You should see a couple of new fields added, similar to the one for defining tags:

Adding the field values on the dataset page

Just extend the additional_info.html template on your own extension with the following:

# ckanext-yourext/ckanext/yourext/templates/package/snippets/additional_info.html

{% ckan_extends %}

{% block extras %}

  {{ super() }}

  {% snippet 'snippets/esd_functions_additional_info.html', data=pkg_dict %}

  {% snippet 'snippets/esd_services_additional_info.html', data=pkg_dict %}

{% endblock %}

You can pass display_row_if_missing=False to the snippet to completely hide the row if no values are defined.

The snippets will show the fields rendered like that: