From: Ross Jones Date: Fri, 09 Dec 2011 15:36:08 +0000 Subject: Making sure we can determine whether the group_form() func was called X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=7f3278199a080c9624b4278692d250c59036c841 --- Making sure we can determine whether the group_form() func was called --- --- a/README.rst +++ b/README.rst @@ -12,6 +12,9 @@ * A custom Pylons controller for overriding some core CKAN behaviour * A custom Package edit form + +* A plugin that allows for custom forms to be used for datasets based on + their "type". * A custom User registration and edition form --- a/ckanext/example/controller_plugin.py +++ /dev/null @@ -1,223 +1,1 @@ -import logging -from ckan.lib.base import BaseController, render, c, model, abort, request -from ckan.lib.base import redirect, _, config, h -import ckan.logic.action.create as create -import ckan.logic.action.update as update -import ckan.logic.action.get as get -from ckan.logic.converters import date_to_db, date_to_form, convert_to_extras, convert_from_extras -from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten -from ckan.logic import NotFound, NotAuthorized, ValidationError -from ckan.logic import tuplize_dict, clean_dict, parse_params -from ckan.logic.schema import package_form_schema -from ckan.plugins import IDatasetForm -from ckan.plugins import implements, SingletonPlugin -from ckan.lib.package_saver import PackageSaver -from ckan.lib.field_types import DateType, DateConvertError -from ckan.authz import Authorizer -from ckan.lib.navl.dictization_functions import Invalid -from ckanext.dgu.forms.package_gov_fields import GeoCoverageType -from ckan.lib.navl.dictization_functions import validate, missing -import ckan.logic.validators as val -import ckan.logic.schema as default_schema -from ckan.lib.navl.validators import (ignore_missing, - not_empty, - empty, - ignore, - keep_extras, - ) -log = logging.getLogger(__name__) - -geographic_granularity = [('', ''), - ('national', 'national'), - ('regional', 'regional'), - ('local authority', 'local authority'), - ('ward', 'ward'), - ('point', 'point'), - ('other', 'other - please specify')] - -update_frequency = [('', ''), - ('never', 'never'), - ('discontinued', 'discontinued'), - ('annual', 'annual'), - ('quarterly', 'quarterly'), - ('monthly', 'monthly'), - ('other', 'other - please specify')] - -temporal_granularity = [("",""), - ("year","year"), - ("quarter","quarter"), - ("month","month"), - ("week","week"), - ("day","day"), - ("hour","hour"), - ("point","point"), - ("other","other - please specify")] - - -class ExamplePackageController(SingletonPlugin): - - implements(IDatasetForm, inherit=True) - - def package_form(self): - return 'controller/package_plugin.html' - - def is_fallback(self): - """ - Returns true iff this provides the fallback behaviour, when no other - plugin instance matches a package's type. - - As this is not the fallback controller we should return False. If - we were wanting to act as the fallback, we'd return True - """ - return False - - def package_types(self): - """ - Returns an iterable of package type strings. - - If a request involving a package of one of those types is made, then - this plugin instance will be delegated to. - - There must only be one plugin registered to each package type. Any - attempts to register more than one plugin instance to a given package - type will raise an exception at startup. - """ - return ["example"] - - def _setup_template_variables(self, context, data_dict=None): - c.licences = [('', '')] + model.Package.get_license_options() - c.geographic_granularity = geographic_granularity - c.update_frequency = update_frequency - c.temporal_granularity = temporal_granularity - - c.publishers = self.get_publishers() - - c.is_sysadmin = Authorizer().is_sysadmin(c.user) - c.resource_columns = model.Resource.get_columns() - - ## This is messy as auths take domain object not data_dict - pkg = context.get('package') or c.pkg - if pkg: - c.auth_for_change_state = Authorizer().am_authorized( - c, model.Action.CHANGE_STATE, pkg) - - def _form_to_db_schema(self): - - schema = { - 'title': [not_empty, unicode], - '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], - 'update_frequency': [use_other, unicode, convert_to_extras], - 'update_frequency-other': [], - 'precision': [unicode, convert_to_extras], - 'geographic_granularity': [use_other, unicode, convert_to_extras], - 'geographic_granularity-other': [], - 'geographic_coverage': [ignore_missing, convert_geographic_to_db, convert_to_extras], - 'temporal_granularity': [use_other, unicode, convert_to_extras], - 'temporal_granularity-other': [], - 'temporal_coverage-from': [date_to_db, convert_to_extras], - 'temporal_coverage-to': [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_via': [ignore_missing, unicode, convert_to_extras], - '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 - - def _db_to_form_schema(data): - schema = { - 'date_released': [convert_from_extras, ignore_missing, date_to_form], - 'date_updated': [convert_from_extras, ignore_missing, date_to_form], - 'date_update_future': [convert_from_extras, ignore_missing, date_to_form], - 'update_frequency': [convert_from_extras, ignore_missing, extract_other(update_frequency)], - 'precision': [convert_from_extras, ignore_missing], - 'geographic_granularity': [convert_from_extras, ignore_missing, extract_other(geographic_granularity)], - 'geographic_coverage': [convert_from_extras, ignore_missing, convert_geographic_to_form], - 'temporal_granularity': [convert_from_extras, ignore_missing, extract_other(temporal_granularity)], - 'temporal_coverage-from': [convert_from_extras, ignore_missing, date_to_form], - 'temporal_coverage-to': [convert_from_extras, ignore_missing, date_to_form], - 'taxonomy_url': [convert_from_extras, ignore_missing], - - 'resources': default_schema.default_resource_schema(), - 'extras': { - 'key': [], - 'value': [], - '__extras': [keep_extras] - }, - 'tags': { - '__extras': [keep_extras] - }, - - '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 - - def _check_data_dict(self, data_dict): - return - - def get_publishers(self): - return [('pub1', 'pub2')] - - -def use_other(key, data, errors, context): - - other_key = key[-1] + '-other' - other_value = data.get((other_key,), '').strip() - if other_value: - data[key] = other_value - -def extract_other(option_list): - - def other(key, data, errors, context): - value = data[key] - if value in dict(option_list).keys(): - return - elif value is missing: - data[key] = '' - return - else: - data[key] = 'other' - other_key = key[-1] + '-other' - data[(other_key,)] = value - return other - -def convert_geographic_to_db(value, context): - - if isinstance(value, list): - regions = value - elif value: - regions = [value] - else: - regions = [] - - return GeoCoverageType.get_instance().form_to_db(regions) - -def convert_geographic_to_form(value, context): - - return GeoCoverageType.get_instance().db_to_form(value) - --- /dev/null +++ b/ckanext/example/forms.py @@ -1,1 +1,243 @@ - +import os, logging +from ckan.authz import Authorizer +import ckan.logic.action.create as create +import ckan.logic.action.update as update +import ckan.logic.action.get as get +from ckan.logic.converters import date_to_db, date_to_form, convert_to_extras, convert_from_extras +from ckan.logic import NotFound, NotAuthorized, ValidationError +from ckan.logic import tuplize_dict, clean_dict, parse_params +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.lib.navl.validators import (ignore_missing, + not_empty, + empty, + ignore, + keep_extras, + ) + +log = logging.getLogger(__name__) + +class ExampleGroupForm(SingletonPlugin): + """This plugin demonstrates how a theme packaged as a CKAN + extension might extend CKAN behaviour. + + In this case, we implement twos extension interfaces to provide custom + forms for specific types of group. + + - ``IConfigurer`` allows us to override configuration normally + found in the ``ini``-file. Here we use it to specify where the + form templates can be found. + - ``IGroupForm`` allows us to provide a custom form for a dataset + based on the 'type' that may be set for a group. Where the + 'type' matches one of the values in group_types then this + class will be used. + """ + implements(IGroupForm, inherit=True) + implements(IConfigurer, inherit=True) + + def update_config(self, config): + """ + This IConfigurer implementation causes CKAN to look in the + ```templates``` directory when looking for the group_form() + """ + here = os.path.dirname(__file__) + rootdir = os.path.dirname(os.path.dirname(here)) + template_dir = os.path.join(rootdir, 'ckanext', + 'example', 'theme', 'templates') + config['extra_template_paths'] = ','.join([template_dir, + config.get('extra_template_paths', '')]) + + def group_form(self): + """ + Returns a string representing the location of the template to be + rendered. e.g. "forms/group_form.html". + """ + from pdb import set_trace; set_trace() + + return 'forms/group_form.html' + + def group_types(self): + """ + Returns an iterable of group type strings. + + If a request involving a group of one of those types is made, then + this plugin instance will be delegated to. + + There must only be one plugin registered to each group type. Any + attempts to register more than one plugin instance to a given group + type will raise an exception at startup. + """ + return ["example"] + + def is_fallback(self): + """ + Returns true iff this provides the fallback behaviour, when no other + plugin instance matches a group's type. + + As this is not the fallback controller we should return False. If + we were wanting to act as the fallback, we'd return True + """ + return False + + + + +class ExampleDatasetForm(SingletonPlugin): + """This plugin demonstrates how a theme packaged as a CKAN + extension might extend CKAN behaviour. + + In this case, we implement three extension interfaces: + + - ``IConfigurer`` allows us to override configuration normally + found in the ``ini``-file. Here we use it to specify where the + form templates can be found. + - ``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 + type_name matches one of the values in package_types then this + class will be used. + """ + implements(IDatasetForm, inherit=True) + implements(IConfigurer, inherit=True) + + def update_config(self, config): + """ + This IConfigurer implementation causes CKAN to look in the + ```templates``` directory when looking for the package_form() + """ + here = os.path.dirname(__file__) + rootdir = os.path.dirname(os.path.dirname(here)) + template_dir = os.path.join(rootdir, 'ckanext', + 'example', 'theme', 'templates') + config['extra_template_paths'] = ','.join([template_dir, + config.get('extra_template_paths', '')]) + + def package_form(self): + """ + Returns a string representing the location of the template to be + rendered. e.g. "package/new_package_form.html". + """ + return 'forms/dataset_form.html' + + def is_fallback(self): + """ + Returns true iff this provides the fallback behaviour, when no other + plugin instance matches a package's type. + + As this is not the fallback controller we should return False. If + we were wanting to act as the fallback, we'd return True + """ + return False + + def package_types(self): + """ + Returns an iterable of package type strings. + + If a request involving a package of one of those types is made, then + this plugin instance will be delegated to. + + There must only be one plugin registered to each package type. Any + attempts to register more than one plugin instance to a given package + type will raise an exception at startup. + """ + return ["example"] + + def setup_template_variables(self, context, data_dict=None): + """ + Adds variables to c just prior to the template being rendered that can + then be used within the form + """ + c.licences = [('', '')] + model.Package.get_license_options() + c.publishers = [('Example publisher', 'Example publisher 2')] + c.is_sysadmin = Authorizer().is_sysadmin(c.user) + c.resource_columns = model.Resource.get_columns() + + ## This is messy as auths take domain object not data_dict + pkg = context.get('package') or c.pkg + if pkg: + c.auth_for_change_state = Authorizer().am_authorized( + c, model.Action.CHANGE_STATE, pkg) + + def form_to_db_schema(self): + """ + Returns the schema for mapping package data from a form to a format + suitable for the database. + """ + schema = { + 'title': [not_empty, unicode], + '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_via': [ignore_missing, unicode, convert_to_extras], + '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 + + def db_to_form_schema(data): + """ + Returns the schema for mapping package data from the database into a + format suitable for the form (optional) + """ + schema = { + 'date_released': [convert_from_extras, ignore_missing, date_to_form], + 'date_updated': [convert_from_extras, ignore_missing, date_to_form], + 'date_update_future': [convert_from_extras, ignore_missing, date_to_form], + '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': { + '__extras': [keep_extras] + }, + + '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 + + def check_data_dict(self, data_dict): + """ + Check if the return data is correct and raises a DataError if not. + """ + return + + --- a/ckanext/example/theme/templates/controller/package_plugin.html +++ /dev/null @@ -1,297 +1,1 @@ -
-
-

Errors in form

-

The form contains invalid entries:

-
    -
  • ${"%s: %s" % (key, error)}
    • -
-
- -
- Example Basic information -
-
-
-
The title of the data set.
-
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.
-
e.g. Payments to suppliers with a value over £500 from Harlow Council
-
${errors.get('title', '')}
- -
-
-
A public unique identifier for the dataset
-
It should be roughly readable, with dashes separating words.
-
Format: Two or more lowercase alphanumeric, dash (-) or underscore (_) characters. e.g. uk-road-traffic-statistics-2008 or local-authority-spend-over-500-harlow
-
${errors.get('name', '')}
- -
-
-
The main description of the dataset
-
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.
-
${errors.get('notes', '')}
-
-
- -
- Example Details -
-
-
-
The date of the official release of the initial version of the dataset
-
This is probably not the date that it is uploaded to data.gov.uk. Be careful not to confuse a new 'version' of some data with a new dataset covering another time period or geographic area.
-
DD/MM/YYYY
-
${errors.get('date_released', '')}
- -
-
-
The date of release of the most recent version of the dataset
-
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/MM/YYYY
-
${errors.get('date_updated', '')}
- -
-
-
When the dataset will be updated in the future, if appropriate
-
DD/MM/YYYY
-
${errors.get('date_updated', '')}
- -
-
- - -
-
How frequently the dataset is updated with new versions
-
For one-off data, use 'never'. For those once updated but now discontinued, use 'discontinued'.
-
${errors.get('update_frequency', '')}
- -
-
-
Indicate the level of precision in the data, to avoid over-interpretation.
-
e.g. 'per cent to two decimal places' or 'as supplied by respondents'
- -
-
- - -
-
The lowest level of geographic detail
-
This should give the lowest level of geographic detail given in the dataset if it is aggregated. If the data is not aggregated, and so the dataset goes down to the level of the entities being reported on (such as school, hospital, or police station), use 'point'. If none of the choices is appropriate or the granularity varies, please specify in the 'other' element.
-
${errors.get('geographic_granularity', '')}
- -
-
- - - - - - -
-
The geographic coverage of this dataset.
-
Where a dataset covers multiple areas, the system will automatically group these (e.g. 'England', 'Scotland' and 'Wales' all being selected would be shown as 'Great Britain').
- -
-
- - -
-
The lowest level of temporal detail granularity
-
This should give the lowest level of temporal detail given in the dataset if it is aggregated, expressed as an interval of time. If the data is not aggregated over time, and so the dataset goes down to the instants that reported events occurred (such as the timings of high and low tides), use 'point'. If none of the choices is appropriate or the granularity varies, please specify in the 'other' element.
- -
-
- - - -
-
The temporal coverage of this dataset.
-
If available, please indicate the time as well as the date. Where data covers only a single day, the 'To' sub-element can be left blank.
-
e.g. 21/03/2007 - 03/10/2009 or 07:45 31/03/2006
- -
-
-
The Internet link to a web page discussing the dataset.
-
e.g. http://www.somedept.gov.uk/growth-figures.html
-
${errors.get('url', '')}
- -
-
-
An Internet link to a web page describing the taxonomies used in the dataset, if any, to ensure they understand any terms used.
-
e.g. http://www.somedept.gov.uk/growth-figures-technical-details.html
-
${errors.get('taxonomy_url', '')}
-
-
-
- Example Resources - - - - - - - - - - - - - - - - - - - -
URL*FormatDescriptionHash
- -
-
The files containing the data or address of the APIs for accessing it
-
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.
URL: 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
e.g. http://www.somedept.gov.uk/growth-figures-2009.csv
Format: 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 Public Sector Transparency Board's principles 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.
-
Format choices: CSV | RDF | XML | XBRL | SDMX | HTML+RDFa | Other as appropriate
-
Package resource(s) incomplete.
-
- -
- Example More details -
-
-
- -
-
The organisation (usually a public body) credited with or associated with the publication of this data.
-
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.
- -
-
- -
-
A second organisation that is credited with or associated with the publication of this data.
-
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.
- -
-
-
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.
-
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.
-
Examples: Statistics team, Public consultation unit, FOI contact point
- -
-
-
A generic official e-mail address for members of the public to contact, to match the 'Contact' element.
-
A new e-mail address may need to be created for this function.
- -
-
-
An Internet link to the enabling legislation that serves as the mandate for the collection or creation of this data, if appropriate.
-
This should be taken from The National Archives' Legislation website, and where possible be a link directly to the relevant section of the Act.
-
For example Public Record Act s.2 would be: http://www.legislation.gov.uk/id/ukpga/Eliz2/6-7/51/section/2
- -
-
- -
-
The licence under which the dataset is released.
-
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 Public Data and Transparency Team.
- -
-
- -
-
Tags can be thought of as the way that the packages are categorised, so are of primary importance.
-
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 Integrated Public Sector Vocabulary may be helpful in forming these.
-
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
-
${errors.get('tag_string', '')}
- -
-
-
Indicate if the dataset is a National Statistic
-
This is so that it can be highlighted.
- -
-
- -
- - - - -
- -

- Since you have not signed in this will just be your IP address. - Click here to sign in before saving (opens in new window). -

-
- -
- - -
-

-Important: By submitting content, you agree to release your contributions - under the open license specified on the license page. Please refrain from editing this page if you are not happy to do this. -

- -
- --- /dev/null +++ b/ckanext/example/theme/templates/forms/dataset_form.html @@ -1,1 +1,230 @@ - +
+ +
+

Errors in form

+

The form contains invalid entries:

+
    +
  • ${"%s: %s" % (key, error)}
    • +
+
+ +
+ Basic information +
+
+
+
The title of the data set.
+
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.
+
e.g. Payments to suppliers with a value over £500 from Harlow Council
+
${errors.get('title', '')}
+ +
+
+
A public unique identifier for the dataset
+
It should be roughly readable, with dashes separating words.
+
Format: Two or more lowercase alphanumeric, dash (-) or underscore (_) characters. e.g. uk-road-traffic-statistics-2008 or local-authority-spend-over-500-harlow
+
${errors.get('name', '')}
+ +
+
+
The main description of the dataset
+
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.
+
${errors.get('notes', '')}
+
+
+ +
+ Details +
+
+
+
The date of the official release of the initial version of the dataset
+
This is the date that the data was officially released
+
DD/MM/YYYY
+
${errors.get('date_released', '')}
+ +
+
+
The date of release of the most recent version of the dataset
+
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/MM/YYYY
+
${errors.get('date_updated', '')}
+ +
+
+
When the dataset will be updated in the future, if appropriate
+
DD/MM/YYYY
+
${errors.get('date_updated', '')}
+ +
+
+ + +
+
How frequently the dataset is updated with new versions
+
For one-off data, use 'never'. For those once updated but now discontinued, use 'discontinued'.
+
${errors.get('update_frequency', '')}
+ +
+
+
Indicate the level of precision in the data, to avoid over-interpretation.
+
e.g. 'per cent to two decimal places' or 'as supplied by respondents'
+ +
+
+
The Internet link to a web page discussing the dataset.
+
e.g. http://www.somedept.gov.uk/growth-figures.html
+
${errors.get('url', '')}
+ +
+
+
An Internet link to a web page describing the taxonomies used in the dataset, if any, to ensure they understand any terms used.
+
e.g. http://www.somedept.gov.uk/growth-figures-technical-details.html
+
${errors.get('taxonomy_url', '')}
+
+
+
+ Resources + + + + + + + + + + + + + + + + + + + +
URL*FormatDescriptionHash
+ +
+
The files containing the data or address of the APIs for accessing it
+
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.
URL: 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
e.g. http://www.somedept.gov.uk/growth-figures-2009.csv
Format: 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 Public Sector Transparency Board's principles 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.
+
Format choices: CSV | RDF | XML | XBRL | SDMX | HTML+RDFa | Other as appropriate
+
Package resource(s) incomplete.
+
+ +
+ More details +
+
+
+ +
+
The organisation (usually a public body) credited with or associated with the publication of this data.
+
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.
+ +
+
+ +
+
A second organisation that is credited with or associated with the publication of this data.
+
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.
+ +
+
+
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.
+
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.
+
Examples: Statistics team, Public consultation unit, FOI contact point
+ +
+
+
A generic official e-mail address for members of the public to contact, to match the 'Contact' element.
+
A new e-mail address may need to be created for this function.
+ +
+
+
An Internet link to the enabling legislation that serves as the mandate for the collection or creation of this data, if appropriate.
+
This should be taken from The National Archives' Legislation website, and where possible be a link directly to the relevant section of the Act.
+
For example Public Record Act s.2 would be: http://www.legislation.gov.uk/id/ukpga/Eliz2/6-7/51/section/2
+ +
+
+ +
+
The licence under which the dataset is released.
+
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 Public Data and Transparency Team.
+ +
+
+ +
+
Tags can be thought of as the way that the packages are categorised, so are of primary importance.
+
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 Integrated Public Sector Vocabulary may be helpful in forming these.
+
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
+
${errors.get('tag_string', '')}
+ +
+
+
Indicate if the dataset is a National Statistic
+
This is so that it can be highlighted.
+ +
+
+ +
+ + + + +
+ +

+ Since you have not signed in this will just be your IP address. + Click here to sign in before saving (opens in new window). +

+
+ +
+ + +
+

+Important: By submitting content, you agree to release your contributions + under the open license specified on the license page. Please refrain from editing this page if you are not happy to do this. +

+ +
+ --- /dev/null +++ b/ckanext/example/theme/templates/forms/group_form.html @@ -1,1 +1,102 @@ +
+
+

Errors in form

+

The form contains invalid entries:

+
    +
  • ${"%s: %s" % (key, error)}
    • +
+
+ +
+
+
+
+ +
+
+ ${g.site_url+h.url_for(controller='group', action='index')+'/'}  + +

 

+
+ +
${errors.get('name', '')}
+ +
+
+
    +
    • +
    • +
+ + + You can use Markdown formatting here. +
+ + +
+
+ +
+
+
+ +
+

Extras

+
+ + +
+
+ + + Delete +
+ + + +
+
+ + with value + +
+ + +
+
+ +
+

Datasets

+
+ +
+
+ +
+ +
+

There are no datasets currently in this group.

+ +

A