| This CKAN Extension demonstrates some common patterns for customising a CKAN instance. | This CKAN Extension demonstrates some common patterns for customising a CKAN instance. |
| It comprises: | It comprises: |
| * A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when | * A CKAN Extension "plugin" at ``ckanext/example/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 and stylesheets | * A path to local customisations of the core templates and stylesheets |
| * A "stream filter" that replaces arbitrary strings in rendered templates | * 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 "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 Pylons controller for overriding some core CKAN behaviour |
| * A custom Package edit form | * A custom Package edit form |
| * A custom Group edit form | |
| * A plugin that allows for custom forms to be used for datasets based on | * A plugin that allows for custom forms to be used for datasets based on |
| their "type". | their "type". |
| * A custom User registration and edition form | * A custom User registration and edition form |
| * Some simple template customisations | * 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-example#egg=ckanext-example |
| Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file. | Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file. |
| Orientation | Orientation |
| =========== | =========== |
| * Examine the source code, starting with ``ckanext/example/plugin.py`` | * Examine the source code, starting with ``ckanext/example/plugin.py`` |
| * To understand the nuts and bolts of this file, which is a CKAN | * To understand the nuts and bolts of this file, which is a CKAN |
| *Extension*, read in conjunction with the "Extension | *Extension*, read in conjunction with the "Extension |
| documentation": http://docs.ckan.org/en/latest/plugins.html | documentation": http://docs.ckan.org/en/latest/plugins.html |
| * One thing the extension does is set the values of | * One thing the extension does is set the values of |
| ``extra_public_paths`` and ``extra_template_paths`` in the CKAN | ``extra_public_paths`` and ``extra_template_paths`` in the CKAN |
| config, which are "documented | config, which are "documented |
| here": http://docs.ckan.org/en/latest/configuration.html#extra-template-paths | here": http://docs.ckan.org/en/latest/configuration.html#extra-template-paths |
| * These are set to point at directories within | * These are set to point at directories within |
| ``ckanext/example/theme/`` (in this package). Here we: | ``ckanext/example/theme/`` (in this package). Here we: |
| * override the home page HTML ``ckanext/example/theme/templates/home/index.html`` | * override the home page HTML ``ckanext/example/theme/templates/home/index.html`` |
| * provide some extra style by serving ``extra.css`` (which is loaded using the ``ckan.template_head_end`` option | * provide some extra style by serving ``extra.css`` (which is loaded using the ``ckan.template_head_end`` option |
| * customise the navigation and header of the main template in the file ``layout.html``. | * 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. | The latter file is a great place to make global theme alterations. |
| It uses the _layout template_ pattern "described in the Genshi | It uses the _layout template_ pattern "described in the Genshi |
| documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate. | documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate. |
| This allows you to use Xpath selectors to override snippets of HTML | This allows you to use Xpath selectors to override snippets of HTML |
| globally. | globally. |
| * The custom package edit form at ``package_form.py`` follows a deprecated | * The custom package edit form at ``package_form.py`` follows a deprecated |
| way to make a form (using FormAlchemy). This part of the Example Theme needs | way to make a form (using FormAlchemy). This part of the Example Theme needs |
| updating. In the meantime, follow the instructions at: | updating. In the meantime, follow the instructions at: |
| http://readthedocs.org/docs/ckan/en/latest/forms.html | http://readthedocs.org/docs/ckan/en/latest/forms.html |
| import os, logging | import os, logging |
| from ckan.authz import Authorizer | from ckan.authz import Authorizer |
| import ckan.logic.action.create as create | from ckan.logic.converters import convert_to_extras,\ |
| import ckan.logic.action.update as update | convert_from_extras, convert_to_tags, convert_from_tags, free_tags_only |
| import ckan.logic.action.get as get | from ckan.logic import get_action |
| from ckan.logic.converters import date_to_db, date_to_form, convert_to_extras, convert_from_extras | from ckan.logic.schema import package_form_schema, group_form_schema |
| from ckan.logic import NotFound, NotAuthorized, ValidationError | from ckan.lib.base import c, model |
| from ckan.logic import tuplize_dict, clean_dict, parse_params | from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer, IConfigurable |
| import ckan.logic.schema as default_schema | |
| from ckan.logic.schema import package_form_schema | |
| import ckan.logic.validators as val | |
| from ckan.lib.base import BaseController, render, c, model, abort, request | |
| from ckan.lib.base import redirect, _, config, h | |
| from ckan.lib.package_saver import PackageSaver | |
| from ckan.lib.field_types import DateType, DateConvertError | |
| from ckan.lib.navl.dictization_functions import Invalid | |
| from ckan.lib.navl.dictization_functions import validate, missing | |
| from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten | |
| from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer | |
| from ckan.plugins import implements, SingletonPlugin | from ckan.plugins import implements, SingletonPlugin |
| from ckan.lib.navl.validators import ignore_missing, not_empty, keep_extras | |
| from ckan.lib.navl.validators import (ignore_missing, | |
| not_empty, | |
| empty, | |
| ignore, | |
| keep_extras, | |
| ) | |
| log = logging.getLogger(__name__) | log = logging.getLogger(__name__) |
| class ExampleGroupForm(SingletonPlugin): | class ExampleGroupForm(SingletonPlugin): |
| """This plugin demonstrates how a theme packaged as a CKAN | """This plugin demonstrates how a class packaged as a CKAN |
| extension might extend CKAN behaviour. | extension might extend CKAN behaviour by providing custom forms |
| based on the type of a Group. | |
| In this case, we implement twos extension interfaces to provide custom | |
| In this case, we implement two extension interfaces to provide custom | |
| forms for specific types of group. | forms for specific types of group. |
| - ``IConfigurer`` allows us to override configuration normally | - ``IConfigurer`` allows us to override configuration normally |
| found in the ``ini``-file. Here we use it to specify where the | found in the ``ini``-file. Here we use it to specify where the |
| form templates can be found. | form templates can be found. |
| - ``IGroupForm`` allows us to provide a custom form for a dataset | - ``IGroupForm`` allows us to provide a custom form for a dataset |
| based on the 'type' that may be set for a group. Where the | based on the 'type' that may be set for a group. Where the |
| 'type' matches one of the values in group_types then this | 'type' matches one of the values in group_types then this |
| class will be used. | class will be used. |
| """ | """ |
| implements(IGroupForm, inherit=True) | implements(IGroupForm, inherit=True) |
| implements(IConfigurer, inherit=True) | implements(IConfigurer, inherit=True) |
| def update_config(self, config): | def update_config(self, config): |
| """ | """ |
| This IConfigurer implementation causes CKAN to look in the | This IConfigurer implementation causes CKAN to look in the |
| ```templates``` directory when looking for the group_form() | ```templates``` directory when looking for the group_form() |
| """ | """ |
| here = os.path.dirname(__file__) | here = os.path.dirname(__file__) |
| rootdir = os.path.dirname(os.path.dirname(here)) | rootdir = os.path.dirname(os.path.dirname(here)) |
| template_dir = os.path.join(rootdir, 'ckanext', | template_dir = os.path.join(rootdir, 'ckanext', |
| 'example', 'theme', 'templates') | 'example', 'theme', 'templates') |
| config['extra_template_paths'] = ','.join([template_dir, | config['extra_template_paths'] = ','.join([template_dir, |
| config.get('extra_template_paths', '')]) | config.get('extra_template_paths', '')]) |
| def group_form(self): | def group_form(self): |
| """ | """ |
| Returns a string representing the location of the template to be | Returns a string representing the location of the template to be |
| rendered. e.g. "forms/group_form.html". | rendered. e.g. "forms/group_form.html". |
| """ | """ |
| from pdb import set_trace; set_trace() | |
| return 'forms/group_form.html' | return 'forms/group_form.html' |
| def group_types(self): | def group_types(self): |
| """ | """ |
| Returns an iterable of group type strings. | Returns an iterable of group type strings. |
| If a request involving a group of one of those types is made, then | If a request involving a group of one of those types is made, then |
| this plugin instance will be delegated to. | this plugin instance will be delegated to. |
| There must only be one plugin registered to each group type. Any | There must only be one plugin registered to each group type. Any |
| attempts to register more than one plugin instance to a given group | attempts to register more than one plugin instance to a given group |
| type will raise an exception at startup. | type will raise an exception at startup. |
| """ | """ |
| return ["example"] | return ["testgroup"] |
| def is_fallback(self): | def is_fallback(self): |
| """ | """ |
| Returns true iff this provides the fallback behaviour, when no other | Returns true iff this provides the fallback behaviour, when no other |
| plugin instance matches a group's type. | plugin instance matches a group's type. |
| As this is not the fallback controller we should return False. If | As this is not the fallback controller we should return False. If |
| we were wanting to act as the fallback, we'd return True | we were wanting to act as the fallback, we'd return True |
| """ | """ |
| return False | return False |
| def form_to_db_schema(self): | |
| """ | |
| Returns the schema for mapping group data from a form to a format | |
| suitable for the database. | |
| """ | |
| return group_form_schema() | |
| def db_to_form_schema(self): | |
| """ | |
| Returns the schema for mapping group data from the database into a | |
| format suitable for the form (optional) | |
| """ | |
| return {} | |
| def check_data_dict(self, data_dict): | |
| """ | |
| Check if the return data is correct. | |
| raise a DataError if not. | |
| """ | |
| def setup_template_variables(self, context, data_dict): | |
| """ | |
| Add variables to c just prior to the template being rendered. | |
| """ | |
| class ExampleDatasetForm(SingletonPlugin): | class ExampleDatasetForm(SingletonPlugin): |
| """This plugin demonstrates how a theme packaged as a CKAN | """This plugin demonstrates how a theme packaged as a CKAN |
| extension might extend CKAN behaviour. | extension might extend CKAN behaviour. |
| In this case, we implement three extension interfaces: | In this case, we implement three extension interfaces: |
| - ``IConfigurer`` allows us to override configuration normally | - ``IConfigurer`` allows us to override configuration normally |
| found in the ``ini``-file. Here we use it to specify where the | found in the ``ini``-file. Here we use it to specify where the |
| form templates can be found. | form templates can be found. |
| - ``IDatasetForm`` allows us to provide a custom form for a dataset | - ``IDatasetForm`` allows us to provide a custom form for a dataset |
| based on the type_name that may be set for a package. Where the | based on the type_name that may be set for a package. Where the |
| type_name matches one of the values in package_types then this | type_name matches one of the values in package_types then this |
| class will be used. | class will be used. |
| """ | """ |
| implements(IDatasetForm, inherit=True) | implements(IDatasetForm, inherit=True) |
| implements(IConfigurer, inherit=True) | implements(IConfigurer, inherit=True) |
| implements(IConfigurable) | |
| def update_config(self, config): | def update_config(self, config): |
| """ | """ |
| This IConfigurer implementation causes CKAN to look in the | This IConfigurer implementation causes CKAN to look in the |
| ```templates``` directory when looking for the package_form() | ```templates``` directory when looking for the package_form() |
| """ | """ |
| here = os.path.dirname(__file__) | here = os.path.dirname(__file__) |
| rootdir = os.path.dirname(os.path.dirname(here)) | rootdir = os.path.dirname(os.path.dirname(here)) |
| template_dir = os.path.join(rootdir, 'ckanext', | template_dir = os.path.join(rootdir, 'ckanext', |
| 'example', 'theme', 'templates') | 'example', 'theme', 'templates') |
| config['extra_template_paths'] = ','.join([template_dir, | config['extra_template_paths'] = ','.join([template_dir, |
| config.get('extra_template_paths', '')]) | config.get('extra_template_paths', '')]) |
| def configure(self, config): | |
| """ | |
| Adds our new vocabulary to the database if it doesn't | |
| already exist. | |
| """ | |
| self.vocab_name = u'example_vocab' | |
| v = model.Vocabulary.get(self.vocab_name) | |
| if not v: | |
| log.info("Adding vocab %s" % self.vocab_name) | |
| vocab = model.Vocabulary(self.vocab_name) | |
| model.Session.add(vocab) | |
| model.Session.commit() | |
| log.info("Adding example tags to vocab %s" % self.vocab_name) | |
| vocab_tag_1 = model.Tag('vocab-tag-example-1', vocab.id) | |
| vocab_tag_2 = model.Tag('vocab-tag-example-2', vocab.id) | |
| model.Session.add(vocab_tag_1) | |
| model.Session.add(vocab_tag_2) | |
| model.Session.commit() | |
| def package_form(self): | def package_form(self): |
| """ | """ |
| Returns a string representing the location of the template to be | Returns a string representing the location of the template to be |
| rendered. e.g. "package/new_package_form.html". | rendered. e.g. "package/new_package_form.html". |
| """ | """ |
| return 'forms/dataset_form.html' | return 'forms/dataset_form.html' |
| def is_fallback(self): | def is_fallback(self): |
| """ | """ |
| Returns true iff this provides the fallback behaviour, when no other | Returns true iff this provides the fallback behaviour, when no other |
| plugin instance matches a package's type. | plugin instance matches a package's type. |
| As this is not the fallback controller we should return False. If | As this is not the fallback controller we should return False. If |
| we were wanting to act as the fallback, we'd return True | we were wanting to act as the fallback, we'd return True |
| """ | """ |
| return False | return True |
| def package_types(self): | def package_types(self): |
| """ | """ |
| Returns an iterable of package type strings. | Returns an iterable of package type strings. |
| If a request involving a package of one of those types is made, then | If a request involving a package of one of those types is made, then |
| this plugin instance will be delegated to. | this plugin instance will be delegated to. |
| There must only be one plugin registered to each package type. Any | There must only be one plugin registered to each package type. Any |
| attempts to register more than one plugin instance to a given package | attempts to register more than one plugin instance to a given package |
| type will raise an exception at startup. | type will raise an exception at startup. |
| """ | """ |
| return ["example"] | return ["example_dataset_form"] |
| def setup_template_variables(self, context, data_dict=None): | def setup_template_variables(self, context, data_dict=None): |
| """ | """ |
| Adds variables to c just prior to the template being rendered that can | Adds variables to c just prior to the template being rendered that can |
| then be used within the form | then be used within the form |
| """ | """ |
| c.licences = [('', '')] + model.Package.get_license_options() | c.licences = [('', '')] + model.Package.get_license_options() |
| c.publishers = [('Example publisher', 'Example publisher 2')] | c.publishers = [('Example publisher', 'Example publisher 2')] |
| c.is_sysadmin = Authorizer().is_sysadmin(c.user) | c.is_sysadmin = Authorizer().is_sysadmin(c.user) |
| c.resource_columns = model.Resource.get_columns() | c.resource_columns = model.Resource.get_columns() |
| c.vocab_tags = get_action('tag_list')(context, {'vocabulary_name': self.vocab_name}) | |
| ## This is messy as auths take domain object not data_dict | ## This is messy as auths take domain object not data_dict |
| pkg = context.get('package') or c.pkg | pkg = context.get('package') or c.pkg |
| if pkg: | if pkg: |
| c.auth_for_change_state = Authorizer().am_authorized( | c.auth_for_change_state = Authorizer().am_authorized( |
| c, model.Action.CHANGE_STATE, pkg) | c, model.Action.CHANGE_STATE, pkg) |
| def form_to_db_schema(self): | def form_to_db_schema(self): |
| """ | """ |
| Returns the schema for mapping package data from a form to a format | Returns the schema for mapping package data from a form to a format |
| suitable for the database. | suitable for the database. |
| """ | """ |
| schema = { | schema = package_form_schema() |
| 'title': [not_empty, unicode], | schema.update({ |
| 'name': [not_empty, unicode, val.name_validator, val.package_name_validator], | |
| 'notes': [not_empty, unicode], | |
| 'date_released': [date_to_db, convert_to_extras], | |
| 'date_updated': [date_to_db, convert_to_extras], | |
| 'date_update_future': [date_to_db, convert_to_extras], | |
| 'url': [unicode], | |
| 'taxonomy_url': [unicode, convert_to_extras], | |
| 'resources': default_schema.default_resource_schema(), | |
| 'published_by': [not_empty, unicode, convert_to_extras], | 'published_by': [not_empty, unicode, convert_to_extras], |
| 'published_via': [ignore_missing, unicode, convert_to_extras], | 'vocab_tags': [ignore_missing, convert_to_tags(self.vocab_name)], |
| 'author': [ignore_missing, unicode], | }) |
| 'author_email': [ignore_missing, unicode], | |
| 'mandate': [ignore_missing, unicode, convert_to_extras], | |
| 'license_id': [ignore_missing, unicode], | |
| 'tag_string': [ignore_missing, val.tag_string_convert], | |
| 'national_statistic': [ignore_missing, convert_to_extras], | |
| 'state': [val.ignore_not_admin, ignore_missing], | |
| 'log_message': [unicode, val.no_http], | |
| '__extras': [ignore], | |
| '__junk': [empty], | |
| } | |
| return schema | return schema |
| def db_to_form_schema(data): | def db_to_form_schema(self): |
| """ | """ |
| Returns the schema for mapping package data from the database into a | Returns the schema for mapping package data from the database into a |
| format suitable for the form (optional) | format suitable for the form (optional) |
| """ | """ |
| schema = { | schema = package_form_schema() |
| 'date_released': [convert_from_extras, ignore_missing, date_to_form], | schema.update({ |
| 'date_updated': [convert_from_extras, ignore_missing, date_to_form], | 'tags': { |
| 'date_update_future': [convert_from_extras, ignore_missing, date_to_form], | '__extras': [keep_extras, free_tags_only] |
| 'precision': [convert_from_extras, ignore_missing], | |
| 'taxonomy_url': [convert_from_extras, ignore_missing], | |
| 'resources': default_schema.default_resource_schema(), | |
| 'extras': { | |
| 'key': [], | |
| 'value': [], | |
| '__extras': [keep_extras] | |
| }, | }, |
| 'tags': { | 'vocab_tags_selected': [convert_from_tags(self.vocab_name), ignore_missing], |
| '__extras': [keep_extras] | |
| }, | |
| 'published_by': [convert_from_extras, ignore_missing], | 'published_by': [convert_from_extras, ignore_missing], |
| 'published_via': [convert_from_extras, ignore_missing], | }) |
| 'mandate': [convert_from_extras, ignore_missing], | |
| 'national_statistic': [convert_from_extras, ignore_missing], | |
| '__extras': [keep_extras], | |
| '__junk': [ignore], | |
| } | |
| return schema | return schema |
| def check_data_dict(self, data_dict): | def check_data_dict(self, data_dict): |
| """ | """ |
| Check if the return data is correct and raises a DataError if not. | Check if the return data is correct and raises a DataError if not. |
| """ | """ |
| return | return |
| import os | import os |
| from logging import getLogger | from logging import getLogger |
| from genshi.filters.transform import Transformer | from genshi.filters.transform import Transformer |
| from ckan.plugins import implements, SingletonPlugin | from ckan.plugins import implements, SingletonPlugin |
| from ckan.plugins import IConfigurer | from ckan.plugins import IConfigurer |
| from ckan.plugins import IGenshiStreamFilter | from ckan.plugins import IGenshiStreamFilter |
| from ckan.plugins import IRoutes | from ckan.plugins import IRoutes |
| log = getLogger(__name__) | log = getLogger(__name__) |
| class ExamplePlugin(SingletonPlugin): | class ExamplePlugin(SingletonPlugin): |
| """This plugin demonstrates how a theme packaged as a CKAN | """This plugin demonstrates how a theme packaged as a CKAN |
| extension might extend CKAN behaviour. | extension might extend CKAN behaviour. |
| In this case, we implement three extension interfaces: | In this case, we implement three extension interfaces: |
| - ``IConfigurer`` allows us to override configuration normally | - ``IConfigurer`` allows us to override configuration normally |
| found in the ``ini``-file. Here we use it to specify the site | found in the ``ini``-file. Here we use it to specify the site |
| title, and to tell CKAN to look in this package for templates | title, and to tell CKAN to look in this package for templates |
| and resources that customise the core look and feel. | and resources that customise the core look and feel. |
| - ``IGenshiStreamFilter`` allows us to filter and transform the | - ``IGenshiStreamFilter`` allows us to filter and transform the |
| HTML stream just before it is rendered. In this case we use | HTML stream just before it is rendered. In this case we use |
| it to rename "frob" to "foobar" | it to rename "frob" to "foobar" |
| - ``IRoutes`` allows us to add new URLs, or override existing | - ``IRoutes`` allows us to add new URLs, or override existing |
| URLs. In this example we use it to override the default | URLs. In this example we use it to override the default |
| ``/register`` behaviour with a custom controller | ``/register`` behaviour with a custom controller |
| """ | """ |
| implements(IConfigurer, inherit=True) | implements(IConfigurer, inherit=True) |
| implements(IGenshiStreamFilter, inherit=True) | implements(IGenshiStreamFilter, inherit=True) |
| implements(IRoutes, inherit=True) | implements(IRoutes, inherit=True) |
| def update_config(self, config): | def update_config(self, config): |
| """This IConfigurer implementation causes CKAN to look in the | """This IConfigurer implementation causes CKAN to look in the |
| ```public``` and ```templates``` directories present in this | ```public``` and ```templates``` directories present in this |
| package for any customisations. | package for any customisations. |
| It also shows how to set the site title here (rather than in | It also shows how to set the site title here (rather than in |
| the main site .ini file), and causes CKAN to use the | the main site .ini file), and causes CKAN to use the |
| customised package form defined in ``package_form.py`` in this | customised package form defined in ``package_form.py`` in this |
| directory. | directory. |
| """ | """ |
| here = os.path.dirname(__file__) | here = os.path.dirname(__file__) |
| rootdir = os.path.dirname(os.path.dirname(here)) | rootdir = os.path.dirname(os.path.dirname(here)) |
| our_public_dir = os.path.join(rootdir, 'ckanext', | our_public_dir = os.path.join(rootdir, 'ckanext', |
| 'example', 'theme', 'public') | 'example', 'theme', 'public') |
| template_dir = os.path.join(rootdir, 'ckanext', | template_dir = os.path.join(rootdir, 'ckanext', |
| 'example', 'theme', | 'example', 'theme', |
| 'templates') | 'templates') |
| # set our local template and resource overrides | # set our local template and resource overrides |
| config['extra_public_paths'] = ','.join([our_public_dir, | config['extra_public_paths'] = ','.join([our_public_dir, |
| config.get('extra_public_paths', '')]) | config.get('extra_public_paths', '')]) |
| config['extra_template_paths'] = ','.join([template_dir, | config['extra_template_paths'] = ','.join([template_dir, |
| config.get('extra_template_paths', '')]) | config.get('extra_template_paths', '')]) |
| # add in the extra.css | # add in the extra.css |
| config['ckan.template_head_end'] = config.get('ckan.template_head_end', '') +\ | config['ckan.template_head_end'] = config.get('ckan.template_head_end', '') +\ |
| '<link rel="stylesheet" href="/css/extra.css" type="text/css"> ' | '<link rel="stylesheet" href="/css/extra.css" type="text/css"> ' |
| # set the title | # set the title |
| config['ckan.site_title'] = "Example CKAN theme" | config['ckan.site_title'] = "Example CKAN theme" |
| # set the customised package form (see ``setup.py`` for entry point) | # set the customised package form (see ``setup.py`` for entry point) |
| config['package_form'] = "example_form" | config['package_form'] = "example_form" |
| def filter(self, stream): | def filter(self, stream): |
| """Conform to IGenshiStreamFilter interface. | """Conform to IGenshiStreamFilter interface. |
| This example filter renames 'frob' to 'foobar' (this string is | This example filter renames 'frob' to 'foobar' (this string is |
| found in the custom ``home/index.html`` template provided as | found in the custom ``home/index.html`` template provided as |
| part of the package). | part of the package). |
| """ | """ |
| stream = stream | Transformer('//p[@id="examplething"]/text()')\ | stream = stream | Transformer('//p[@id="examplething"]/text()')\ |
| .substitute(r'frob', r'foobar') | .substitute(r'frob', r'foobar') |
| return stream | return stream |
| def before_map(self, map): | def before_map(self, map): |
| """This IRoutes implementation overrides the standard | """This IRoutes implementation overrides the standard |
| ``/user/register`` behaviour with a custom controller. You | ``/user/register`` behaviour with a custom controller. You |
| might instead use it to provide a completely new page, for | might instead use it to provide a completely new page, for |
| example. | example. |
| Note that we have also provided a custom register form | Note that we have also provided a custom register form |
| template at ``theme/templates/user/register.html``. | template at ``theme/templates/user/register.html``. |
| """ | """ |
| # Hook in our custom user controller at the points of creation | # Hook in our custom user controller at the points of creation |
| # and edition. | # and edition. |
| map.connect('/user/register', | map.connect('/user/register', |
| controller='ckanext.example.controller:CustomUserController', | controller='ckanext.example.controller:CustomUserController', |
| action='register') | action='register') |
| map.connect('/user/edit', | map.connect('/user/edit', |
| controller='ckanext.example.controller:CustomUserController', | controller='ckanext.example.controller:CustomUserController', |
| action='edit') | action='edit') |
| map.connect('/user/edit/{id:.*}', | map.connect('/user/edit/{id:.*}', |
| controller='ckanext.example.controller:CustomUserController', | controller='ckanext.example.controller:CustomUserController', |
| action='edit') | action='edit') |
| map.connect('/package/new', controller='package_formalchemy', action='new') | map.connect('/package/new', controller='package_formalchemy', action='new') |
| map.connect('/package/edit/{id}', controller='package_formalchemy', action='edit') | map.connect('/package/edit/{id}', controller='package_formalchemy', action='edit') |
| return map | return map |
| <form id="package-edit" class="package_create_form ckan" method="post" | <form id="dataset-edit" method="post" |
| py:attrs="{'class':'has-errors'} if errors else {}" | py:attrs="{'class':'has-errors'} if errors else {}" |
| xmlns:i18n="http://genshi.edgewall.org/i18n" | xmlns:i18n="http://genshi.edgewall.org/i18n" |
| xmlns:py="http://genshi.edgewall.org/" | xmlns:py="http://genshi.edgewall.org/" |
| xmlns:xi="http://www.w3.org/2001/XInclude"> | xmlns:xi="http://www.w3.org/2001/XInclude"> |
| <div class="error-explanation" py:if="error_summary"> | <div class="error-explanation" py:if="error_summary"> |
| <h2>Errors in form</h2> | <h2>Errors in form</h2> |
| <p>The form contains invalid entries:</p> | <p>The form contains invalid entries:</p> |
| <ul> | <ul> |
| <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)}</li> | <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)} |
| <py:if test="key=='Resources'"> | |
| <ul> | |
| <py:for each="idx, errordict in enumerate(errors.get('resources', []))"> | |
| <li py:if="errordict"> | |
| Resource ${idx}: | |
| <ul> | |
| <li py:for="thiskey, thiserror in errordict.items()">${thiskey}: <py:for each="errorinfo in thiserror">${errorinfo}; </py:for></li> | |
| </ul> | |
| </li> | |
| </py:for> | |
| </ul> | |
| </py:if> | |
| </li> | |
| </ul> | </ul> |
| </div> | </div> |
| <fieldset> | <fieldset id="basic-information"> |
| <legend>Basic information</legend> | <dl> |
| <dl> | <dt class="title-label"><label class="field_opt" for="title">Title</label></dt> |
| <dt><label class="field_req" for="title">Title *</label></dt> | <dd class="title-field"> |
| <dd><input id="title" name="title" type="text" value="${data.get('title', '')}"/></dd> | <input id="title" |
| <dd class="instructions basic">The title of the data set.</dd> | class="js-title" |
| <dd class="instructions further">The main subject of the data should be clear. For cross-government data requirements, such as spend data, specify the public body the data belongs to or its geographical coverage, in order to distinguish your data from other similar datasets in data.gov.uk. If the data relates to a period of time, include that in the name, although this would not be appropriate for data which is updated over time. It is not a description - save that for the Abstract element. Do not give a trailing full stop.</dd> | name="title" type="text" |
| <dd class="hints">e.g. Payments to suppliers with a value over £500 from Harlow Council</dd> | value="${data.get('title', '')}" |
| <dd class="field_error" py:if="errors.get('title', '')">${errors.get('title', '')}</dd> | placeholder="${_('A short descriptive title for the dataset')}" |
| /> | |
| <dt><label class="field_req" for="name">Identifier *</label></dt> | </dd> |
| <dd><input id="name" maxlength="100" name="name" type="text" value="${data.get('name', '')}" /></dd> | <dd class="title-instructions field_error" py:if="errors.get('title', '')">${errors.get('title', '')}</dd> |
| <dd class="instructions basic">A public unique identifier for the dataset</dd> | |
| <dd class="instructions further">It should be roughly readable, with dashes separating words.</dd> | <dt class="name-label"><label class="field_req" for="name">Url</label></dt> |
| <dd class="hints">Format: Two or more lowercase alphanumeric, dash (-) or underscore (_) characters. e.g. uk-road-traffic-statistics-2008 or local-authority-spend-over-500-harlow</dd> | <dd class="name-field"> |
| <dd class="field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd> | <span class="js-url-text url-text">${url(controller='package', action='index')+'/'}<span class="js-url-viewmode js-url-suffix"> </span><a href="#" style="display: none;" class="url-edit js-url-editlink js-url-viewmode">(edit)</a></span> |
| <input style="display: none;" id="name" maxlength="100" name="name" type="text" class="url-input js-url-editmode js-url-input" value="${data.get('name', '')}" /> | |
| <dt><label class="field_req" for="notes">Abstract *</label></dt> | <p class="js-url-is-valid"> </p> |
| <dd><textarea cols="60" id="notes" name="notes" rows="15">${data.get('notes', '')}</textarea></dd> | </dd> |
| <dd class="instructions basic">The main description of the dataset</dd> | <dd style="display: none;" class="js-url-editmode name-instructions basic">2+ characters, lowercase, using only 'a-z0-9' and '-_'</dd> |
| <dd class="instructions further">It is often displayed with the package title. In particular, it should start with a short sentence that describes the data set succinctly, because the first few words alone may be used in some views of the data sets. Here is the place to state if there are any limitations or deficiencies to the data in order to enable users to evaluate the information; even incomplete data may be adequate for some users.</dd> | <dd class="js-url-editmode name-instructions field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd> |
| <dd class="field_error" py:if="errors.get('notes', '')">${errors.get('notes', '')}</dd> | |
| </dl> | <dt class="homepage-label"><label class="field_opt" for="url">Home Page</label></dt> |
| </fieldset> | <dd class="homepage-field"><input id="url" name="url" type="text" value="${data.get('url', '')}"/></dd> |
| <dd class="homepage-instructions instructions basic">The URL for the web page describing the data (not the data itself).</dd> | |
| <fieldset> | <dd class="homepage-instructions hints">e.g. http://www.example.com/growth-figures.html</dd> |
| <legend>Details</legend> | <dd class="homepage-instructions field_error" py:if="errors.get('url', '')">${errors.get('url', '')}</dd> |
| <dl> | |
| <dt><label class="field_opt" for="date_released">Date released</label></dt> | <dt class="license-label"><label class="field_opt" for="license_id">License</label></dt> |
| <dd><input id="date_released" name="date_released" size="40" type="text" value="${data.get('date_released', '')}" /></dd> | <dd class="license-field"> |
| <dd class="instructions basic">The date of the official release of the initial version of the dataset</dd> | <select id="license_id" name="license_id"> |
| <dd class="instructions further">This is the date that the data was officially released</dd> | <py:for each="licence_desc, licence_id in c.licences"> |
| <dd class="hints">DD/MM/YYYY</dd> | <option value="${licence_id}" py:attrs="{'selected': 'selected' if data.get('license_id', '') == licence_id else None}" >${licence_desc}</option> |
| <dd class="field_error" py:if="errors.get('date_released', '')">${errors.get('date_released', '')}</dd> | </py:for> |
| </select> | |
| <dt><label class="field_opt" for="date_updated">Date updated</label></dt> | </dd> |
| <dd><input id="date_updated" name="date_updated" size="40" type="text" value="${data.get('date_updated', '')}"/></dd> | <dd class="license-instructions instructions basic">The licence under which the dataset is released.</dd> |
| <dd class="instructions basic">The date of release of the most recent version of the dataset</dd> | |
| <dd class="instructions further">This is not necessarily the date when it was updated on data.gov.uk. As with 'Date released', this is for updates to a particular dataset, such as corrections or refinements, not for that of a new time period.</dd> | <dt class="description-label"><label class="field_opt" for="notes">Description</label></dt> |
| <dd class="hints">DD/MM/YYYY</dd> | <dd class="description-field"><div class="markdown-editor"> |
| <dd class="field_error" py:if="errors.get('date_updated', '')">${errors.get('date_updated', '')}</dd> | <ul class="button-row"> |
| <li><button class="pretty-button js-markdown-edit depressed">Edit</button></li> | |
| <dt><label class="field_opt" for="date_update_future">Date to be published</label></dt> | <li><button class="pretty-button js-markdown-preview">Preview</button></li> |
| <dd><input id="date_update_future" name="date_update_future" size="40" type="text" value="${data.get('date_update_future', '')}"/></dd> | </ul> |
| <dd class="instructions basic">When the dataset will be updated in the future, if appropriate</dd> | <textarea class="markdown-input" name="notes" id="notes" placeholder="${_('Start with a summary sentence ...')}">${data.get('notes','')}</textarea> |
| <dd class="hints">DD/MM/YYYY</dd> | <div class="markdown-preview" style="display: none;"></div> |
| <dd class="field_error" py:if="errors.get('date_updated', '')">${errors.get('date_updated', '')}</dd> | <span class="hints">You can use <a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown formatting</a> here.</span> |
| <!-- | |
| <dt><label class="field_opt" for="update_frequency">Update frequency</label></dt> | <dd class="instructions basic">The main description of the dataset</dd> |
| <dd> | <dd class="instructions further">It is often displayed with the dataset title. In particular, it should start with a short sentence that describes the dataset succinctly, because the first few words alone may be used in some views of the datasets.</dd> |
| <select class="short" id="update_frequency" name="update_frequency"> | --> |
| <py:for each="freq_name, freq_desc in c.update_frequency"> | </div></dd> |
| <option value="${freq_name}" py:attrs="{'selected': 'selected' if data.get('update_frequency', '') == freq_name else None}" > | </dl> |
| ${freq_desc} | </fieldset> |
| </option> | |
| </py:for> | <fieldset id="resources"> |
| </select> | <div class="instructions basic"><h3>Resources: the files and APIs associated with this dataset</h3></div> |
| <label class="inline" for="update_frequency-other">Other: | <table class="resource-table-edit"> |
| <input class="medium-width" id="update_frequency-other" name="update_frequency-other" type="text" value="${data.get('update_frequency-other', '')}"/> | |
| </label> | |
| </dd> | |
| <dd class="instructions basic">How frequently the dataset is updated with new versions</dd> | |
| <dd class="instructions further">For one-off data, use 'never'. For those once updated but now discontinued, use 'discontinued'.</dd> | |
| <dd class="field_error" py:if="errors.get('update_frequency', '')">${errors.get('update_frequency', '')}</dd> | |
| <dt><label class="field_opt" for="precision">Precision</label></dt> | |
| <dd><input id="precision" name="precision" size="40" type="text" value="${data.get('precision', '')}"/></dd> | |
| <dd class="instructions basic">Indicate the level of precision in the data, to avoid over-interpretation.</dd> | |
| <dd class="hints">e.g. 'per cent to two decimal places' or 'as supplied by respondents'</dd> | |
| <dt><label class="field_opt" for="url">URL</label></dt> | |
| <dd><input id="url" name="url" type="text" value="${data.get('url', '')}"/></dd> | |
| <dd class="instructions basic">The Internet link to a web page discussing the dataset.</dd> | |
| <dd class="hints">e.g. http://www.somedept.gov.uk/growth-figures.html</dd> | |
| <dd class="field_error" py:if="errors.get('url', '')">${errors.get('url', '')}</dd> | |
| <dt><label class="field_opt" for="taxonomy_url">Taxonomy URL</label></dt> | |
| <dd><input id="taxonomy_url" name="taxonomy_url" size="40" type="text" value="${data.get('taxonomy_url', '')}"/></dd> | |
| <dd class="instructions basic">An Internet link to a web page describing the taxonomies used in the dataset, if any, to ensure they understand any terms used.</dd> | |
| <dd class="hints">e.g. http://www.somedept.gov.uk/growth-figures-technical-details.html</dd> | |
| <dd class="field_error" py:if="errors.get('taxonomy_url', '')">${errors.get('taxonomy_url', '')}</dd> | |
| </dl> | |
| </fieldset> | |
| <fieldset> | |
| <legend>Resources</legend> | |
| <table class="flexitable"> | |
| <thead> | <thead> |
| <tr> | <tr> |
| <th class="field_req resource-url">URL*</th> | <th class="field_req resource-url">Resource</th> |
| <th class="field_opt resource-format">Format</th> | <th class="resource-delete-link"></th> |
| <th class="field_opt resource-description">Description</th> | |
| <th class="field_opt resource-hash">Hash</th> | |
| </tr> | </tr> |
| </thead> | </thead> |
| <tbody> | <tbody class="js-resource-editor"> |
| <py:for each="num, res in enumerate(data.get('resources', []) + [{}])"> | |
| <tr> | |
| <py:for each="col in c.resource_columns"> | |
| <td class="resource-${col}"> | |
| <input name="resources__${num}__${col}" type="text" value="${res.get(col, '')}" class="${'medium-width' if col=='description' else 'short'}" /> | |
| </td> | |
| </py:for> | |
| <td class="resource-id"><input name="resources__${num}__id" type="hidden" value="${res.get('id', '')}" /></td> | |
| </tr> | |
| </py:for> | |
| </tbody> | </tbody> |
| </table> | </table> |
| <div class="instructions basic">The files containing the data or address of the APIs for accessing it</div> | |
| <div class="instructions further">These can be repeated as required. For example if the data is being supplied in multiple formats, or split into different areas or time periods, each file is a different 'resource' which should be described differently. They will all appear on the dataset page on data.gov.uk together.<br/> <b>URL:</b> This is the Internet link directly to the data - by selecting this link in a web browser, the user will immediately download the full data set. Note that datasets are not hosted by data.gov.uk, but by the responsible department<br/> e.g. http://www.somedept.gov.uk/growth-figures-2009.csv<br/><b>Format:</b> This should give the file format in which the data is supplied. You may supply the data in a form not listed here, constrained by the <a href="http://data.gov.uk/blog/new-public-sector-transparency-board-and-public-data-transparency-principles" target="_blank">Public Sector Transparency Board's principles</a> that require that all data is available in an 'open and standardised format' that can be read by a machine. Data can also be released in formats that are not machine-processable (e.g. PDF) alongside this.<br/></div> | |
| <div class="hints">Format choices: CSV | RDF | XML | XBRL | SDMX | HTML+RDFa | Other as appropriate</div> | <div class="resource-add"> |
| <div class="field_error" py:if="errors.get('resources', '')">Package resource(s) incomplete.</div> | <ul class="button-row"> |
| </fieldset> | <li><h4>Add a resource:</h4></li> |
| <li><button class="pretty-button js-link-file">Link to a file</button></li> | |
| <fieldset> | <li><button class="pretty-button js-link-api">Link to an API</button></li> |
| <legend>More details</legend> | <li class="js-upload-file ckan-logged-in" style="display: none;"><button class="pretty-button js-upload-file">Upload a file</button></li> |
| </ul> | |
| </div> | |
| </fieldset> | |
| <fieldset id="groups"> | |
| <h3>Groups</h3> | |
| <dl> | |
| <py:for each="num, group in enumerate(data.get('groups', []))"> | |
| <?python | |
| authorized_group = [group_authz for group_authz in c.groups_authz if group_authz['id'] == group['id']] | |
| authorized_group = authorized_group[0] if authorized_group else None | |
| ?> | |
| <dt py:if="'id' in group"> | |
| <input type="${'checkbox' if authorized_group else 'hidden'}" name="groups__${num}__id" checked="checked" value="${group['id']}" /> | |
| <input type="hidden" name="groups__${num}__name" value="${group.get('name', authorized_group['name'] if authorized_group else '')}" /> | |
| </dt> | |
| <dd py:if="'id' in group"><label for="groups__${num}__checked">${group.get('name', authorized_group['name'] if authorized_group else '')}</label></dd> | |
| </py:for> | |
| <dt>Group</dt> | |
| <dd py:if="c.groups_available"> | |
| <select id="groups__${len(data.get('groups', []))}__id" name="groups__${len(data.get('groups', []))}__id"> | |
| <option selected="selected" value="">(None)</option> | |
| <py:for each="group in c.groups_available"> | |
| <option value="${group['id']}" >${group['name']}</option> | |
| </py:for> | |
| </select> | |
| </dd> | |
| <dd py:if="not c.groups_available"><em>Cannot add any groups.</em></dd> | |
| </dl> | |
| <h3>Tags</h3> | |
| <dl> | |
| <dt class="tags-label"><label class="field_opt" for="tags">Tags</label></dt> | |
| <dd class="tags-field"> | |
| <input class="long autocomplete-tag" id="tag_string" name="tag_string" size="60" type="text" | |
| value="${data.get('tag_string') or ', '.join([tag['name'] for tag in data.get('tags', []) if not tag.get('vocabulary_id')])}" /> | |
| </dd> | |
| <dd class="tags-instructions instructions basic" i18n:msg="">Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see <a href="http://wiki.okfn.org/ckan/doc/faq#TagConventions">this wiki page</a>.</dd> | |
| <dd class="tags-instructions hints">e.g. pollution, rivers, water quality</dd> | |
| <dd class="tags-instructions field_error" py:if="errors.get('tag_string', '')">${errors.get('tag_string', '')}</dd> | |
| </dl> | |
| <h3>Tags with Vocabulary</h3> | |
| <dl> | |
| <dt class="tags-label"><label class="field_opt" for="tags_vocab">Tags</label></dt> | |
| <dd class="tags-field"> | |
| <select id="vocab_tags" name="vocab_tags" size="60" multiple="multiple"> | |
| <py:for each="tag in c.vocab_tags"> | |
| <py:choose test=""> | |
| <option py:when="tag in data.get('vocab_tags_selected', [])" selected="selected" value="${tag}">${tag}</option> | |
| <option py:otherwise="" value="${tag}">${tag}</option> | |
| </py:choose> | |
| </py:for> | |
| </select> | |
| </dd> | |
| <dd class="tags-instructions instructions basic" i18n:msg="">Similar to standard CKAN tags, but these use a fixed vocabulary.</dd> | |
| <dd class="tags-instructions field_error" py:if="errors.get('vocab_tag_string', '')">${errors.get('vocab_tag_string', '')}</dd> | |
| </dl> | |
| </fieldset> | |
| <fieldset id='further-information'> | |
| <dl> | |
| <dt><label class="field_opt" for="author">Author</label></dt> | |
| <dd><input id="author" name="author" type="text" value="${data.get('author', '')}" /></dd> | |
| <dd class="instructions basic">The name of the main contact, for enquiries about this particular dataset, using the e-mail address in the following field.</dd> | |
| <dt><label class="field_opt" for="author_email">Author email</label></dt> | |
| <dd><input id="author_email" name="author_email" type="text" value="${data.get('author_email', '')}" /></dd> | |
| <dt><label class="field_opt" for="maintainer">Maintainer</label></dt> | |
| <dd><input id="maintainer" name="maintainer" type="text" value="${data.get('maintainer', '')}" /></dd> | |
| <dd class="instructions basic">If there is another important contact person (in addition to the person in the Author field) then provide details here.</dd> | |
| <dt><label class="field_opt" for="maintainer_email">Maintainer email</label></dt> | |
| <dd><input id="maintainer_email" name="maintainer_email" type="text" value="${data.get('maintainer_email', '')}" /></dd> | |
| <dt><label class="field_opt" for="version">Version</label></dt> | |
| <dd><input id="version" maxlength="100" name="version" type="text" value="${data.get('version', '')}" /></dd> | |
| <dd class="instructions basic">A number representing the version (if applicable)</dd> | |
| <dd class="hints">e.g. 1.2.0</dd> | |
| <dt py:if="c.is_sysadmin or c.auth_for_change_state"><label class="field_opt" for="state">State</label></dt> | |
| <dd py:if="c.is_sysadmin or c.auth_for_change_state"> | |
| <select id="state" name="state" > | |
| <option py:attrs="{'selected': 'selected' if data.get('state') == 'active' else None}" value="active">active</option> | |
| <option py:attrs="{'selected': 'selected' if data.get('state') == 'deleted' else None}" value="deleted">deleted</option> | |
| </select> | |
| </dd> | |
| </dl> | |
| </fieldset> | |
| <fieldset id='extras'> | |
| <dl> | <dl> |
| <dt><label class="field_req" for="published_by">Published by *</label></dt> | <dt><label class="field_req" for="published_by">Published by *</label></dt> |
| <dd> | <dd> |
| <select id="published_by" name="published_by"> | <select id="published_by" name="published_by"> |
| <py:for each="published_name, published_desc in c.publishers"> | <py:for each="published_name, published_desc in c.publishers"> |
| <option value="${published_name}" py:attrs="{'selected': 'selected' if data.get('published_by', '') == published_name else None}" > | <option value="${published_name}" py:attrs="{'selected': 'selected' if data.get('published_by', '') == published_name else None}" > |
| ${published_desc} | ${published_desc} |
| </option> | </option> |
| </py:for> | </py:for> |
| </select> | </select> |
| </dd> | </dd> |
| <dd class="instructions basic">The organisation (usually a public body) credited with or associated with the publication of this data.</dd> | <dd class="instructions basic">The organisation credited with or associated with the publication of this data.</dd> |
| <dd class="instructions further">Often datasets are associated with both a government department and an outside agency, in which case this field should store the department and "Published via" should store the agency. When an organisation is not listed, please request it using the form found in your data.gov.uk user page under the "Publishers" tab. An asterisk (*) denotes an pre-existing value for this field, which is allowed, but the current user's permissions would not be able to change a package\s publisher to this value.</dd> | |
| <py:with vars="extras = data.get('extras', [])"> | |
| <dt><label class="field_opt" for="published_via">Published via</label></dt> | <py:for each="num, extra in enumerate(data.get('extras', []))"> |
| <dt><label for="extras__${num}__value">${extra.get('key')}</label></dt> | |
| <dd> | <dd> |
| <select id="published_via" name="published_via"> | <input id="extras__${num}__key" name="extras__${num}__key" type="hidden" value="${extra.get('key')}" /> |
| <py:for each="published_name, published_desc in c.publishers"> | <input id="extras__${num}__value" name="extras__${num}__value" type="text" value="${extra.get('value')}" /> |
| <option value="${published_name}" py:attrs="{'selected': 'selected' if data.get('published_via', '') == published_name else None}" > | <input type="checkbox" name="extras__${num}__deleted" checked="${extra.get('deleted')}">Delete</input> |
| ${published_desc} | </dd> |
| </option> | </py:for> |
| </py:for> | |
| </select> | <py:for each="num in range(len(extras), len(extras) + 4)"> |
| </dd> | <dt><label for="extras__${num}__key">New key</label></dt> |
| <dd class="instructions basic">A second organisation that is credited with or associated with the publication of this data.</dd> | |
| <dd class="instructions further">Often datasets are associated with both a government department and an outside agency, in which case the "Published by" field should store the department and this field should store the agency. When an organisation is not listed, please request it using the form found in your data.gov.uk user page under the "Publishers" tab. An asterisk (*) denotes an pre-existing value for this field, which is allowed, but the current user's permissions would not be able to change a package\s publisher to this value.</dd> | |
| <dt><label class="field_opt" for="author">Contact</label></dt> | |
| <dd><input id="author" name="author" type="text" value="${data.get('author', '')}"/></dd> | |
| <dd class="instructions basic">The permanent contact point for the public to enquire about this particular dataset. In addition, the Public Data and Transparency Team will use it for any suggestions for changes, feedback, reports of mistakes in the datasets or metadata.</dd> | |
| <dd class="instructions further">This should be the name of the section of the agency or Department responsible, and should not be a named person. Particular care should be taken in choosing this element.</dd> | |
| <dd class="hints">Examples: Statistics team, Public consultation unit, FOI contact point</dd> | |
| <dt><label class="field_opt" for="author_email">Contact email</label></dt> | |
| <dd><input id="author_email" name="author_email" type="text" value="${data.get('author_email', '')}"/></dd> | |
| <dd class="instructions basic">A generic official e-mail address for members of the public to contact, to match the 'Contact' element.</dd> | |
| <dd class="instructions further">A new e-mail address may need to be created for this function.</dd> | |
| <dt><label class="field_opt" for="mandate">Mandate</label></dt> | |
| <dd><input id="mandate" name="mandate" size="40" type="text" value="${data.get('mandate', '')}"/></dd> | |
| <dd class="instructions basic">An Internet link to the enabling legislation that serves as the mandate for the collection or creation of this data, if appropriate.</dd> | |
| <dd class="instructions further">This should be taken from The National Archives' Legislation website, and where possible be a link directly to the relevant section of the Act.</dd> | |
| <dd class="hints">For example Public Record Act s.2 would be: http://www.legislation.gov.uk/id/ukpga/Eliz2/6-7/51/section/2</dd> | |
| <dt><label class="field_opt" for="license_id">Licence *</label></dt> | |
| <dd> | <dd> |
| <select id="license_id" name="license_id"> | <input class="medium-width" id="extras__${num}__key" name="extras__${num}__key" type="text" /> |
| <py:for each="licence_desc, licence_id in c.licences"> | with value |
| <option value="${licence_id}" py:attrs="{'selected': 'selected' if data.get('license_id', 'uk-ogl') == licence_id else None}" >${licence_desc}</option> | <input class="medium-width" id="extras__${num}__value" name="extras__${num}__value" type="text" /> |
| </py:for> | </dd> |
| </select> | </py:for> |
| </dd> | </py:with> |
| <dd class="instructions basic">The licence under which the dataset is released.</dd> | </dl> |
| <dd class="instructions further">For most situations of central Departments' and Local Authority data, this should be the 'Open Government Licence'. If you wish to release the data under a different licence, please contact the <a href="mailto:PublicData@nationalarchives.gsi.gov.uk">Public Data and Transparency Team</a>.</dd> | </fieldset> |
| <dt><label class="field_opt" for="tags">Tags</label></dt> | <label for="log_message" class="edit-summary">Edit summary (briefly describe the changes you have made)</label> |
| <dd> | <textarea id="log_message" name="log_message" class="edit-summary short wide">${data.get('log_message', '')}</textarea> |
| <input class="long tagComplete" data-tagcomplete-queryparam="incomplete" | |
| data-tagcomplete-url="/api/2/util/tag/autocomplete" id="tag_string" name="tag_string" size="60" type="text" | |
| value="${data.get('tag_string') or ' '.join([tag['name'] for tag in data.get('tags', [])])}" /> | |
| </dd> | |
| <dd class="instructions basic">Tags can be thought of as the way that the packages are categorised, so are of primary importance.</dd> | |
| <dd class="instructions further">One or more tags should be added to give the government department and geographic location the data covers, as well as general descriptive words. The <a href="http://www.esd.org.uk/standards/ipsv_abridged/" target="_blank">Integrated Public Sector Vocabulary</a> may be helpful in forming these.</dd> | |
| <dd class="hints">Format: Two or more lowercase alphanumeric or dash (-) characters; different tags separated by spaces. As tags cannot contain spaces, use dashes instead. e.g. for a dataset containing statistics on burns to the arms in the UK in 2009: nhs uk arm burns medical-statistics</dd> | |
| <dd class="field_error" py:if="errors.get('tag_string', '')">${errors.get('tag_string', '')}</dd> | |
| <dt><label class="field_opt" for="national_statistic">National Statistic</label></dt> | |
| <dd><input id="national_statistic" name="national_statistic" size="40" type="checkbox" value="yes" | |
| py:attrs="{'checked': 'checked' if data.get('national_statistic', '').lower() == 'yes' else None}" /></dd> | |
| <dd class="instructions basic">Indicate if the dataset is a National Statistic</dd> | |
| <dd class="instructions further">This is so that it can be highlighted.</dd> | |
| </dl> | |
| </fieldset> | |
| <hr /> | |
| <label for="log_message">Edit summary (briefly describe the changes you have made)</label> | |
| <textarea id="log_message" name="log_message" class="short wide"></textarea> | |
| <div class="ckan-logged-in" style="display: none;"> | <div class="ckan-logged-in" style="display: none;"> |
| <p>Author: ${c.author}</p> | <p>Author: ${c.author}</p> |
| </div> | </div> |
| <div class="ckan-logged-out"> | <div class="ckan-logged-out"> |
| <label>Author: ${c.author}</label> | <label>Author: ${c.author}</label> |
| <p class="hints"> | <p i18n:msg="" class="hints"> |
| Since you have not signed in this will just be your IP address. | Since you have not signed in this will just be your IP address. |
| <a href="${h.url_for(controller='user', action='login', id=None)}" target="_blank">Click here to sign in</a> before saving (opens in new window). | <a href="${h.url_for(controller='user', action='login', id=None)}" target="_blank">Click here to sign in</a> before saving (opens in new window). |
| </p> | </p> |
| </div> | </div> |
| <div class="submit"> | <div class="form-submit"> |
| <input name="preview" type="submit" value="Preview" /> | <input id="save" class="pretty-button primary" name="save" type="submit" value="${_('Save Changes')}" /> |
| <input id="save" name="save" type="submit" value="Save" /> | <py:if test="c.pkg"> |
| </div> | <input id="cancel" class="pretty-button href-action" name="cancel" type="reset" value="${_('Cancel')}" action="${h.url_for(controller='package', action='read', id=c.pkg.name)}" /> |
| <p class="hints"> | </py:if> |
| <strong>Important:</strong> By submitting content, you agree to release your contributions | <p i18n:msg="" class="hints"> |
| under the open license specified on the <a href="/license">license page</a>. Please <strong>refrain</strong> from editing this page if you are <strong>not</strong> happy to do this. | <strong>Important:</strong> By submitting content, you agree to release your contributions under the <a href="http://opendatacommons.org/licenses/odbl/1.0/">Open Database License</a>. Please <strong>refrain</strong> from editing this page if you are <strong>not</strong> happy to do this. |
| </p> | </p> |
| <div class="clear"></div> | |
| </div> | |
| </form> | </form> |
| <html xmlns:py="http://genshi.edgewall.org/" | <html xmlns:py="http://genshi.edgewall.org/" |
| xmlns:i18n="http://genshi.edgewall.org/i18n" | xmlns:i18n="http://genshi.edgewall.org/i18n" |
| xmlns:xi="http://www.w3.org/2001/XInclude" | xmlns:xi="http://www.w3.org/2001/XInclude" |
| py:strip=""> | py:strip=""> |
| <py:def function="page_title">Home</py:def> | <py:def function="page_title">Home</py:def> |
| <py:def function="optional_head"> | <py:def function="optional_head"> |
| <style type="text/css"> | <style type="text/css"> |
| #examplething { | #examplething { |
| background-color: yellow; | background-color: yellow; |
| padding: 10px; | padding: 10px; |
| } | } |
| </style> | </style> |
| </py:def> | </py:def> |
| <div py:match="content"> | <div py:match="content"> |
| <h2>Welcome to Example Theme!</h2> | <h2>Welcome to Example Theme!</h2> |
| <p> | <p> |
| This page left intentionally ugly | This page left intentionally ugly |
| </p> | </p> |
| <p id="examplething"> | <p id="examplething"> |
| Here is the frob | Here is the frob |
| </p> | </p> |
| ${select("*")} | |
| </div> | </div> |
| <xi:include href="layout.html" /> | <xi:include href="layout.html" /> |
| </html> | </html> |
| <html xmlns="http://www.w3.org/1999/xhtml" | <html xmlns="http://www.w3.org/1999/xhtml" |
| xmlns:py="http://genshi.edgewall.org/" | xmlns:py="http://genshi.edgewall.org/" |
| xmlns:xi="http://www.w3.org/2001/XInclude" | xmlns:xi="http://www.w3.org/2001/XInclude" |
| xmlns:doap="http://usefulinc.com/ns/doap" | xmlns:doap="http://usefulinc.com/ns/doap" |
| xmlns:foaf="http://xmlns.com/foaf/0.1/" | xmlns:foaf="http://xmlns.com/foaf/0.1/" |
| py:strip="" | py:strip="" |
| > | > |
| <!-- ! a custom primary nav --> | <!-- ! a custom primary nav --> |
| <py:match path="//div[@class='menu']"> | <py:match path="//div[@class='menu']"> |
| <div class="menu"> | <div class="menu"> |
| ${h.nav_link(c, _('Home'), controller='home', action='index', id=None)} | ${h.nav_link(c, _('Home'), controller='home', action='index')} |
| ${h.nav_link(c, _('Data'), controller='package', action='index', id=None)} | ${h.nav_link(c, _('Data'), controller='package', action='index')} |
| ${h.nav_link(c, _('New dataset'), controller='package', action='new', id=None)} | ${h.nav_link(c, _('New dataset'), controller='package', action='new')} |
| ${h.nav_link(c, _('New group'), controller='group', action='new')} | |
| </div> | </div> |
| </py:match> | </py:match> |
| <!-- make a really big search box in the top bar --> | <!-- make a really big search box in the top bar --> |
| <py:match path="//div[@id='top-bar']/div[@class='search-form']"> | <py:match path="//div[@id='top-bar']/div[@class='search-form']"> |
| <div class="search-form"> | <div class="search-form"> |
| <form action="${url(controller='package', action='search')}" method="GET"> | <form action="${url(controller='package', action='search')}" method="GET"> |
| <input type="search" class="search" name="q" value="" autocomplete="off" results="5" placeholder="What are you looking for?" id="bigsearch" /> | <input type="search" class="search" name="q" value="" autocomplete="off" results="5" placeholder="What are you looking for?" id="bigsearch" /> |
| <input type="submit" class="searchbutton" value="search" /> | <input type="submit" class="searchbutton" value="search" /> |
| </form> | </form> |
| </div> | </div> |
| </py:match> | </py:match> |
| <xi:include href="layout_base.html" /> | <xi:include href="layout_base.html" /> |
| </html> | </html> |
| from setuptools import setup, find_packages | from setuptools import setup, find_packages |
| import sys, os | |
| version = '0.2' | version = '0.2' |
| setup( | setup( |
| name='ckanext-example', | name='ckanext-example', |
| version=version, | version=version, |
| description="Example extension for customising CKAN", | description='Example extension for customising CKAN', |
| long_description="""\ | long_description='', |
| """, | |
| classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers | classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers |
| keywords='', | keywords='', |
| author='Seb Bacon', | author='Seb Bacon', |
| author_email='seb.bacon@gmail.com', | author_email='seb.bacon@gmail.com', |
| url='', | url='', |
| license='', | license='', |
| packages=find_packages(exclude=['ez_setup', 'examples', 'tests']), | packages=find_packages(exclude=['ez_setup', 'examples', 'tests']), |
| namespace_packages=['ckanext', 'ckanext.example'], | namespace_packages=['ckanext', 'ckanext.example'], |
| include_package_data=True, | include_package_data=True, |
| zip_safe=False, | zip_safe=False, |
| install_requires=[ | install_requires=[ |
| # -*- Extra requirements: -*- | # -*- Extra requirements: -*- |
| ], | ], |
| entry_points=\ | entry_points=\ |
| """ | """ |
| [ckan.plugins] | [ckan.plugins] |
| example=ckanext.example.plugin:ExamplePlugin | example=ckanext.example.plugin:ExamplePlugin |
| example_datasetform=ckanext.example.forms:ExampleDatasetForm | example_datasetform=ckanext.example.forms:ExampleDatasetForm |
| example_groupform=ckanext.example.forms:ExampleGroupForm | example_groupform=ckanext.example.forms:ExampleGroupForm |
| [ckan.forms] | [ckan.forms] |
| example_form = ckanext.example.package_form:get_example_fieldset | example_form = ckanext.example.package_form:get_example_fieldset |
| """, | """, |
| ) | ) |