projects / ckanext-datagovau.git / commitdiff
search:
summary | shortlog | log | commit | commitdiff | tree
unified | plain
Adding ID tags to the new dataset template so that the anchor URLs work properly
Adding ID tags to the new dataset template so that the anchor URLs work properly

file:a/ckanext/example/forms.py -> file:b/ckanext/example/forms.py
import os, logging import os, logging
from ckan.authz import Authorizer from ckan.authz import Authorizer
import ckan.logic.action.create as create import ckan.logic.action.create as create
import ckan.logic.action.update as update import ckan.logic.action.update as update
import ckan.logic.action.get as get 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.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 NotFound, NotAuthorized, ValidationError
from ckan.logic import tuplize_dict, clean_dict, parse_params from ckan.logic import tuplize_dict, clean_dict, parse_params
import ckan.logic.schema as default_schema import ckan.logic.schema as default_schema
  from ckan.logic.schema import group_form_schema
from ckan.logic.schema import package_form_schema from ckan.logic.schema import package_form_schema
import ckan.logic.validators as val import ckan.logic.validators as val
from ckan.lib.base import BaseController, render, c, model, abort, request from ckan.lib.base import BaseController, render, c, model, abort, request
from ckan.lib.base import redirect, _, config, h from ckan.lib.base import redirect, _, config, h
from ckan.lib.package_saver import PackageSaver from ckan.lib.package_saver import PackageSaver
from ckan.lib.field_types import DateType, DateConvertError from ckan.lib.field_types import DateType, DateConvertError
from ckan.lib.navl.dictization_functions import Invalid from ckan.lib.navl.dictization_functions import Invalid
from ckan.lib.navl.dictization_functions import validate, missing from ckan.lib.navl.dictization_functions import validate, missing
from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten
from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer 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, from ckan.lib.navl.validators import (ignore_missing,
not_empty, not_empty,
empty, empty,
ignore, ignore,
keep_extras, 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 theme packaged as a CKAN
extension might extend CKAN behaviour. extension might extend CKAN behaviour.
   
In this case, we implement twos extension interfaces to provide custom In this case, we implement twos 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 ["example_dataset_group"]
   
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)
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 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 False
   
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"]
   
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()
   
## 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 = {
'title': [not_empty, unicode], 'title': [not_empty, unicode],
'name': [not_empty, unicode, val.name_validator, val.package_name_validator], 'name': [not_empty, unicode, val.name_validator, val.package_name_validator],
'notes': [not_empty, unicode],  
   
'date_released': [date_to_db, convert_to_extras], 'date_released': [date_to_db, convert_to_extras],
'date_updated': [date_to_db, convert_to_extras], 'date_updated': [date_to_db, convert_to_extras],
'date_update_future': [date_to_db, convert_to_extras], 'date_update_future': [date_to_db, convert_to_extras],
'url': [unicode], 'url': [unicode],
'taxonomy_url': [unicode, convert_to_extras], 'taxonomy_url': [unicode, convert_to_extras],
   
'resources': default_schema.default_resource_schema(), '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], 'published_via': [ignore_missing, unicode, convert_to_extras],
'author': [ignore_missing, unicode], 'author': [ignore_missing, unicode],
'author_email': [ignore_missing, unicode], 'author_email': [ignore_missing, unicode],
'mandate': [ignore_missing, unicode, convert_to_extras], 'mandate': [ignore_missing, unicode, convert_to_extras],
'license_id': [ignore_missing, unicode], 'license_id': [ignore_missing, unicode],
'tag_string': [ignore_missing, val.tag_string_convert], 'tag_string': [ignore_missing, val.tag_string_convert],
'national_statistic': [ignore_missing, convert_to_extras], 'national_statistic': [ignore_missing, convert_to_extras],
'state': [val.ignore_not_admin, ignore_missing], 'state': [val.ignore_not_admin, ignore_missing],
   
'log_message': [unicode, val.no_http], 'log_message': [unicode, val.no_http],
   
'__extras': [ignore], '__extras': [ignore],
'__junk': [empty], '__junk': [empty],
} }
return schema return schema
def db_to_form_schema(data): def db_to_form_schema(data):
""" """
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 = {
'date_released': [convert_from_extras, ignore_missing, date_to_form], 'date_released': [convert_from_extras, ignore_missing, date_to_form],
'date_updated': [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], 'date_update_future': [convert_from_extras, ignore_missing, date_to_form],
'precision': [convert_from_extras, ignore_missing], 'precision': [convert_from_extras, ignore_missing],
'taxonomy_url': [convert_from_extras, ignore_missing], 'taxonomy_url': [convert_from_extras, ignore_missing],
   
'resources': default_schema.default_resource_schema(), 'resources': default_schema.default_resource_schema(),
'extras': { 'extras': {
'key': [], 'key': [],
'value': [], 'value': [],
'__extras': [keep_extras] '__extras': [keep_extras]
}, },
'tags': { 'tags': {
'__extras': [keep_extras] '__extras': [keep_extras]
}, },
'published_by': [convert_from_extras, ignore_missing], 'published_by': [convert_from_extras, ignore_missing],
'published_via': [convert_from_extras, ignore_missing], 'published_via': [convert_from_extras, ignore_missing],
'mandate': [convert_from_extras, ignore_missing], 'mandate': [convert_from_extras, ignore_missing],
'national_statistic': [convert_from_extras, ignore_missing], 'national_statistic': [convert_from_extras, ignore_missing],
'__extras': [keep_extras], '__extras': [keep_extras],
'__junk': [ignore], '__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
   
   
file:a/ckanext/example/theme/templates/forms/dataset_form.html -> file:b/ckanext/example/theme/templates/forms/dataset_form.html
<form id="package-edit" class="package_create_form ckan" method="post" <form id="package-edit" class="package_create_form ckan" 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)}</li>
</ul> </ul>
</div> </div>
   
<fieldset> <fieldset id='section-basic-information'>
<legend>Basic information</legend> <legend>Basic information</legend>
<dl> <dl>
<dt><label class="field_req" for="title">Title *</label></dt> <dt><label class="field_req" for="title">Title *</label></dt>
<dd><input id="title" name="title" type="text" value="${data.get('title', '')}"/></dd> <dd><input id="title" name="title" type="text" value="${data.get('title', '')}"/></dd>
<dd class="instructions basic">The title of the data set.</dd> <dd class="instructions basic">The title of the data set.</dd>
<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> <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>
<dd class="hints">e.g. Payments to suppliers with a value over &pound;500 from Harlow Council</dd> <dd class="hints">e.g. Payments to suppliers with a value over &pound;500 from Harlow Council</dd>
<dd class="field_error" py:if="errors.get('title', '')">${errors.get('title', '')}</dd> <dd class="field_error" py:if="errors.get('title', '')">${errors.get('title', '')}</dd>
   
<dt><label class="field_req" for="name">Identifier *</label></dt> <dt><label class="field_req" for="name">Identifier *</label></dt>
<dd><input id="name" maxlength="100" name="name" type="text" value="${data.get('name', '')}" /></dd> <dd><input id="name" maxlength="100" name="name" type="text" value="${data.get('name', '')}" /></dd>
<dd class="instructions basic">A public unique identifier for the dataset</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> <dd class="instructions further">It should be roughly readable, with dashes separating words.</dd>
<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="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="field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd> <dd class="field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd>
   
<dt><label class="field_req" for="notes">Abstract *</label></dt> <dt><label class="field_req" for="notes">Abstract *</label></dt>
<dd><textarea cols="60" id="notes" name="notes" rows="15">${data.get('notes', '')}</textarea></dd> <dd><textarea cols="60" id="notes" name="notes" rows="15">${data.get('notes', '')}</textarea></dd>
<dd class="instructions basic">The main description of the dataset</dd> <dd class="instructions basic">The main description of the dataset</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="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="field_error" py:if="errors.get('notes', '')">${errors.get('notes', '')}</dd> <dd class="field_error" py:if="errors.get('notes', '')">${errors.get('notes', '')}</dd>
</dl> </dl>
</fieldset> </fieldset>
   
<fieldset> <fieldset id='section-further-information'>
<legend>Details</legend> <legend>Details</legend>
<dl> <dl>
<dt><label class="field_opt" for="date_released">Date released</label></dt> <dt><label class="field_opt" for="date_released">Date released</label></dt>
<dd><input id="date_released" name="date_released" size="40" type="text" value="${data.get('date_released', '')}" /></dd> <dd><input id="date_released" name="date_released" size="40" type="text" value="${data.get('date_released', '')}" /></dd>
<dd class="instructions basic">The date of the official release of the initial version of the dataset</dd> <dd class="instructions basic">The date of the official release of the initial version of the dataset</dd>
<dd class="instructions further">This is the date that the data was officially released</dd> <dd class="instructions further">This is the date that the data was officially released</dd>
<dd class="hints">DD/MM/YYYY</dd> <dd class="hints">DD/MM/YYYY</dd>
<dd class="field_error" py:if="errors.get('date_released', '')">${errors.get('date_released', '')}</dd> <dd class="field_error" py:if="errors.get('date_released', '')">${errors.get('date_released', '')}</dd>
   
<dt><label class="field_opt" for="date_updated">Date updated</label></dt> <dt><label class="field_opt" for="date_updated">Date updated</label></dt>
<dd><input id="date_updated" name="date_updated" size="40" type="text" value="${data.get('date_updated', '')}"/></dd> <dd><input id="date_updated" name="date_updated" size="40" type="text" value="${data.get('date_updated', '')}"/></dd>
<dd class="instructions basic">The date of release of the most recent version of the dataset</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> <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>
<dd class="hints">DD/MM/YYYY</dd> <dd class="hints">DD/MM/YYYY</dd>
<dd class="field_error" py:if="errors.get('date_updated', '')">${errors.get('date_updated', '')}</dd> <dd class="field_error" py:if="errors.get('date_updated', '')">${errors.get('date_updated', '')}</dd>
   
<dt><label class="field_opt" for="date_update_future">Date to be published</label></dt> <dt><label class="field_opt" for="date_update_future">Date to be published</label></dt>
<dd><input id="date_update_future" name="date_update_future" size="40" type="text" value="${data.get('date_update_future', '')}"/></dd> <dd><input id="date_update_future" name="date_update_future" size="40" type="text" value="${data.get('date_update_future', '')}"/></dd>
<dd class="instructions basic">When the dataset will be updated in the future, if appropriate</dd> <dd class="instructions basic">When the dataset will be updated in the future, if appropriate</dd>
<dd class="hints">DD/MM/YYYY</dd> <dd class="hints">DD/MM/YYYY</dd>
<dd class="field_error" py:if="errors.get('date_updated', '')">${errors.get('date_updated', '')}</dd> <dd class="field_error" py:if="errors.get('date_updated', '')">${errors.get('date_updated', '')}</dd>
   
<dt><label class="field_opt" for="update_frequency">Update frequency</label></dt> <dt><label class="field_opt" for="update_frequency">Update frequency</label></dt>
<dd> <dd>
<select class="short" id="update_frequency" name="update_frequency"> <select class="short" id="update_frequency" name="update_frequency">
<py:for each="freq_name, freq_desc in c.update_frequency"> <py:for each="freq_name, freq_desc in c.update_frequency">
<option value="${freq_name}" py:attrs="{'selected': 'selected' if data.get('update_frequency', '') == freq_name else None}" > <option value="${freq_name}" py:attrs="{'selected': 'selected' if data.get('update_frequency', '') == freq_name else None}" >
${freq_desc} ${freq_desc}
</option> </option>
</py:for> </py:for>
</select> </select>
<label class="inline" for="update_frequency-other">Other: <label class="inline" for="update_frequency-other">Other:
<input class="medium-width" id="update_frequency-other" name="update_frequency-other" type="text" value="${data.get('update_frequency-other', '')}"/> <input class="medium-width" id="update_frequency-other" name="update_frequency-other" type="text" value="${data.get('update_frequency-other', '')}"/>
</label> </label>
</dd> </dd>
<dd class="instructions basic">How frequently the dataset is updated with new versions</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="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> <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> <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><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="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> <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> <dt><label class="field_opt" for="url">URL</label></dt>
<dd><input id="url" name="url" type="text" value="${data.get('url', '')}"/></dd> <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="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="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> <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> <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><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="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="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> <dd class="field_error" py:if="errors.get('taxonomy_url', '')">${errors.get('taxonomy_url', '')}</dd>
</dl> </dl>
</fieldset> </fieldset>
<fieldset> <fieldset id='section-resources'>
<legend>Resources</legend> <legend>Resources</legend>
<table class="flexitable"> <table class="flexitable">
<thead> <thead>
<tr> <tr>
<th class="field_req resource-url">URL*</th> <th class="field_req resource-url">URL*</th>
<th class="field_opt resource-format">Format</th> <th class="field_opt resource-format">Format</th>
<th class="field_opt resource-description">Description</th> <th class="field_opt resource-description">Description</th>
<th class="field_opt resource-hash">Hash</th> <th class="field_opt resource-hash">Hash</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<py:for each="num, res in enumerate(data.get('resources', []) + [{}])"> <py:for each="num, res in enumerate(data.get('resources', []) + [{}])">
<tr> <tr>
<py:for each="col in c.resource_columns"> <py:for each="col in c.resource_columns">
<td class="resource-${col}"> <td class="resource-${col}">
<input name="resources__${num}__${col}" type="text" value="${res.get(col, '')}" class="${'medium-width' if col=='description' else 'short'}" /> <input name="resources__${num}__${col}" type="text" value="${res.get(col, '')}" class="${'medium-width' if col=='description' else 'short'}" />
</td> </td>
</py:for> </py:for>
<td class="resource-id"><input name="resources__${num}__id" type="hidden" value="${res.get('id', '')}" /></td> <td class="resource-id"><input name="resources__${num}__id" type="hidden" value="${res.get('id', '')}" /></td>
</tr> </tr>
</py:for> </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 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="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="hints">Format choices: CSV | RDF | XML | XBRL | SDMX | HTML+RDFa | Other as appropriate</div>
<div class="field_error" py:if="errors.get('resources', '')">Package resource(s) incomplete.</div> <div class="field_error" py:if="errors.get('resources', '')">Package resource(s) incomplete.</div>
</fieldset> </fieldset>
   
<fieldset> <fieldset id='section-more-details'>
<legend>More details</legend> <legend>More details</legend>
<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 (usually a public body) 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> <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>
   
<dt><label class="field_opt" for="published_via">Published via</label></dt> <dt><label class="field_opt" for="published_via">Published via</label></dt>
<dd> <dd>
<select id="published_via" name="published_via"> <select id="published_via" name="published_via">
<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_via', '') == published_name else None}" > <option value="${published_name}" py:attrs="{'selected': 'selected' if data.get('published_via', '') == published_name else None}" >
${published_desc} ${published_desc}
</option> </option>
</py:for> </py:for>
</select> </select>
</dd> </dd>
<dd class="instructions basic">A second organisation that is credited with or associated with the publication of this data.</dd> <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> <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> <dt><label class="field_opt" for="author">Contact</label></dt>
<dd><input id="author" name="author" type="text" value="${data.get('author', '')}"/></dd> <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 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="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> <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> <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><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 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> <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> <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><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 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="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> <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> <dt><label class="field_opt" for="license_id">Licence *</label></dt>
<dd> <dd>
<select id="license_id" name="license_id"> <select id="license_id" name="license_id">
<py:for each="licence_desc, licence_id in c.licences"> <py:for each="licence_desc, licence_id in c.licences">
<option value="${licence_id}" py:attrs="{'selected': 'selected' if data.get('license_id', 'uk-ogl') == licence_id else None}" >${licence_desc}</option> <option value="${licence_id}" py:attrs="{'selected': 'selected' if data.get('license_id', 'uk-ogl') == licence_id else None}" >${licence_desc}</option>
</py:for> </py:for>
</select> </select>
</dd> </dd>
<dd class="instructions basic">The licence under which the dataset is released.</dd> <dd class="instructions basic">The licence under which the dataset is released.</dd>
<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> <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>
   
<dt><label class="field_opt" for="tags">Tags</label></dt> <dt><label class="field_opt" for="tags">Tags</label></dt>
<dd> <dd>
<input class="long tagComplete" data-tagcomplete-queryparam="incomplete" <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" 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', [])])}" /> value="${data.get('tag_string') or ' '.join([tag['name'] for tag in data.get('tags', [])])}" />
</dd> </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 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="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="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> <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> <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" <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> 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 basic">Indicate if the dataset is a National Statistic</dd>
<dd class="instructions further">This is so that it can be highlighted.</dd> <dd class="instructions further">This is so that it can be highlighted.</dd>
   
</dl> </dl>
</fieldset> </fieldset>
   
<hr /> <hr />
<label for="log_message">Edit summary (briefly describe the changes you have made)</label> <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> <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 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="submit">
<input name="preview" type="submit" value="Preview" /> <input name="preview" type="submit" value="Preview" />
<input id="save" name="save" type="submit" value="Save" /> <input id="save" name="save" type="submit" value="Save" />
</div> </div>
<p class="hints"> <p class="hints">
<strong>Important:</strong> By submitting content, you agree to release your contributions <strong>Important:</strong> By submitting content, you agree to release your contributions
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. 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.
</p> </p>
   
</form> </form>
   
Unnamed repository; edit this file 'description' to name the repository.
GitPHP by Chris Han