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 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/extensions.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://docs.ckan.org/en/latest/forms.html |
Example Tags With Vocabularies | |
============================== | |
To add example tag vocabulary data to the database, from the ckanext-example directory run: | |
:: | |
paster example create-example-vocabs -c <path to your ckan config file> | |
This data can be removed with | |
:: | |
paster example clean -c <path to your ckan config file> | |
from ckan import model | from ckan import model |
from ckan.lib.cli import CkanCommand | from ckan.lib.cli import CkanCommand |
from ckan.logic import get_action, NotFound | from ckan.logic import get_action, NotFound |
import forms | import forms |
import logging | import logging |
log = logging.getLogger() | log = logging.getLogger() |
class ExampleCommand(CkanCommand): | class ExampleCommand(CkanCommand): |
''' | ''' |
CKAN Example Extension | CKAN Example Extension |
Usage:: | Usage:: |
paster example create-example-vocab -c <path to config file> | paster example create-example-vocabs -c <path to config file> |
paster example clean -c <path to config file> | paster example clean -c <path to config file> |
- Remove all data created by ckanext-example | - Remove all data created by ckanext-example |
The commands should be run from the ckanext-example directory. | The commands should be run from the ckanext-example directory. |
''' | ''' |
summary = __doc__.split('\n')[0] | summary = __doc__.split('\n')[0] |
usage = __doc__ | usage = __doc__ |
def command(self): | def command(self): |
''' | ''' |
Parse command line arguments and call appropriate method. | Parse command line arguments and call appropriate method. |
''' | ''' |
if not self.args or self.args[0] in ['--help', '-h', 'help']: | if not self.args or self.args[0] in ['--help', '-h', 'help']: |
print ExampleCommand.__doc__ | print ExampleCommand.__doc__ |
return | return |
cmd = self.args[0] | cmd = self.args[0] |
self._load_config() | self._load_config() |
if cmd == 'create-example-vocab': | if cmd == 'create-example-vocabs': |
self.create_example_vocab() | self.create_example_vocabs() |
if cmd == 'clean': | |
self.clean() | |
else: | else: |
log.error('Command "%s" not recognized' % (cmd,)) | log.error('Command "%s" not recognized' % (cmd,)) |
def create_example_vocab(self): | def create_example_vocabs(self): |
''' | ''' |
Adds an example vocabulary to the database if it doesn't | Adds example vocabularies to the database if they don't already exist. |
already exist. | |
''' | ''' |
user = get_action('get_site_user')({'model': model, 'ignore_auth': True}, {}) | user = get_action('get_site_user')({'model': model, 'ignore_auth': True}, {}) |
context = {'model': model, 'session': model.Session, 'user': user['name']} | context = {'model': model, 'session': model.Session, 'user': user['name']} |
data = {'id': forms.EXAMPLE_VOCAB} | |
try: | try: |
data = {'id': forms.GENRE_VOCAB} | |
get_action('vocabulary_show')(context, data) | get_action('vocabulary_show')(context, data) |
log.info("Example tag vocabulary already exists, skipping.") | log.info("Example genre vocabulary already exists, skipping.") |
except NotFound: | except NotFound: |
log.info("Creating example vocab %s" % forms.EXAMPLE_VOCAB) | log.info("Creating vocab %s" % forms.GENRE_VOCAB) |
data = {'name': forms.EXAMPLE_VOCAB} | data = {'name': forms.GENRE_VOCAB} |
vocab = get_action('vocabulary_create')(context, data) | vocab = get_action('vocabulary_create')(context, data) |
log.info("Adding tag %s to vocab %s" % ('jazz', forms.GENRE_VOCAB)) | |
log.info("Adding tag %s to vocab %s" % ('vocab-tag-example-1', forms.EXAMPLE_VOCAB)) | data = {'name': 'jazz', 'vocabulary_id': vocab['id']} |
data = {'name': 'vocab-tag-example-1', 'vocabulary_id': vocab['id']} | get_action('tag_create')(context, data) |
log.info("Adding tag %s to vocab %s" % ('soul', forms.GENRE_VOCAB)) | |
data = {'name': 'soul', 'vocabulary_id': vocab['id']} | |
get_action('tag_create')(context, data) | get_action('tag_create')(context, data) |
log.info("Adding tag %s to vocab %s" % ('vocab-tag-example-2', forms.EXAMPLE_VOCAB)) | try: |
data = {'name': 'vocab-tag-example-2', 'vocabulary_id': vocab['id']} | data = {'id': forms.COMPOSER_VOCAB} |
get_action('vocabulary_show')(context, data) | |
log.info("Example composer vocabulary already exists, skipping.") | |
except NotFound: | |
log.info("Creating vocab %s" % forms.COMPOSER_VOCAB) | |
data = {'name': forms.COMPOSER_VOCAB} | |
vocab = get_action('vocabulary_create')(context, data) | |
log.info("Adding tag %s to vocab %s" % ('Bob Mintzer', forms.COMPOSER_VOCAB)) | |
data = {'name': 'Bob Mintzer', 'vocabulary_id': vocab['id']} | |
get_action('tag_create')(context, data) | |
log.info("Adding tag %s to vocab %s" % ('Steve Lewis', forms.COMPOSER_VOCAB)) | |
data = {'name': 'Steve Lewis', 'vocabulary_id': vocab['id']} | |
get_action('tag_create')(context, data) | get_action('tag_create')(context, data) |
def clean(self): | |
log.error("Clean command not yet implemented") | |
import os | import os |
import logging | import logging |
from pylons import tmpl_context as c | |
from ckan.authz import Authorizer | from ckan.authz import Authorizer |
from ckan.logic.converters import convert_to_extras,\ | from ckan.logic.converters import convert_to_extras,\ |
convert_from_extras, convert_to_tags, convert_from_tags, free_tags_only | convert_from_extras, convert_to_tags, convert_from_tags, free_tags_only |
from ckan.logic import get_action, NotFound | from ckan.logic import get_action, NotFound |
from ckan.logic.schema import package_form_schema, group_form_schema | from ckan.logic.schema import package_form_schema, group_form_schema |
from ckan.lib.base import c, model | from ckan.lib.base import c, model |
from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer | from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer |
from ckan.plugins import IGenshiStreamFilter | from ckan.plugins import IGenshiStreamFilter |
from ckan.plugins import implements, SingletonPlugin | from ckan.plugins import implements, SingletonPlugin |
from ckan.lib.navl.validators import ignore_missing, keep_extras | from ckan.lib.navl.validators import ignore_missing, keep_extras |
import ckan.lib.plugins | |
log = logging.getLogger(__name__) | log = logging.getLogger(__name__) |
EXAMPLE_VOCAB = u'example_vocab' | GENRE_VOCAB = u'genre_vocab' |
COMPOSER_VOCAB = u'composer_vocab' | |
class ExampleGroupForm(SingletonPlugin): | class ExampleGroupForm(SingletonPlugin): |
"""This plugin demonstrates how a class packaged as a CKAN | """This plugin demonstrates how a class packaged as a CKAN |
extension might extend CKAN behaviour by providing custom forms | extension might extend CKAN behaviour by providing custom forms |
based on the type of a Group. | based on the type of a Group. |
In this case, we implement two 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". |
""" | """ |
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 ["testgroup"] | 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): | def form_to_db_schema(self): |
""" | """ |
Returns the schema for mapping group data from a form to a format | Returns the schema for mapping group data from a form to a format |
suitable for the database. | suitable for the database. |
""" | """ |
return group_form_schema() | return group_form_schema() |
def db_to_form_schema(self): | def db_to_form_schema(self): |
""" | """ |
Returns the schema for mapping group data from the database into a | Returns the schema for mapping group data from the database into a |
format suitable for the form (optional) | format suitable for the form (optional) |
""" | """ |
return {} | return {} |
def check_data_dict(self, data_dict): | def check_data_dict(self, data_dict): |
""" | """ |
Check if the return data is correct. | Check if the return data is correct. |
raise a DataError if not. | raise a DataError if not. |
""" | """ |
def setup_template_variables(self, context, data_dict): | def setup_template_variables(self, context, data_dict): |
""" | """ |
Add variables to c just prior to the template being rendered. | Add variables to c just prior to the template being rendered. |
""" | """ |
class ExampleDatasetForm(SingletonPlugin): | class ExampleDatasetForm(SingletonPlugin, ckan.lib.plugins.DefaultDatasetForm): |
"""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(IGenshiStreamFilter) | implements(IGenshiStreamFilter, 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 configure(self, config): | |
# ''' | |
# Adds some new vocabularies to the database if they don't already exist. | |
# ''' | |
# # Add a 'genre' vocabulary with some tags. | |
# self.genre_vocab = model.Vocabulary.get('Genre') | |
# if not self.genre_vocab: | |
# log.info("Adding vocab Genre") | |
# self.genre_vocab = model.Vocabulary('Genre') | |
# model.Session.add(self.genre_vocab) | |
# model.Session.commit() | |
# log.info("Adding example tags to vocab %s" % self.genre_vocab.name) | |
# jazz_tag = model.Tag('jazz', self.genre_vocab.id) | |
# soul_tag = model.Tag('soul', self.genre_vocab.id) | |
# model.Session.add(jazz_tag) | |
# model.Session.add(soul_tag) | |
# model.Session.commit() | |
# # Add a 'composer' vocabulary with some tags. | |
# self.composer_vocab = model.Vocabulary.get('Composer') | |
# if not self.composer_vocab: | |
# log.info("Adding vocab Composer") | |
# self.composer_vocab = model.Vocabulary('Composer') | |
# model.Session.add(self.composer_vocab) | |
# model.Session.commit() | |
# log.info("Adding example tags to vocab %s" % | |
# self.composer_vocab.name) | |
# mintzer_tag = model.Tag('Bob Mintzer', self.composer_vocab.id) | |
# lewis_tag = model.Tag('Steve Lewis', self.composer_vocab.id) | |
# model.Session.add(mintzer_tag) | |
# model.Session.add(lewis_tag) | |
# 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 True | 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_dataset_form"] | 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() |
try: | try: |
c.vocab_tags = get_action('tag_list')(context, {'vocabulary_id': EXAMPLE_VOCAB}) | c.genre_tags = get_action('tag_list')(context, {'vocabulary_id': GENRE_VOCAB}) |
# c.genre_tags = get_action('tag_list')(context, {'vocabulary_id': self.genre_vocab.name}) | c.composer_tags = get_action('tag_list')(context, {'vocabulary_id': COMPOSER_VOCAB}) |
# c.composer_tags = get_action('tag_list')(context, {'vocabulary_id': self.composer_vocab.name}) | |
except NotFound: | except NotFound: |
c.vocab_tags = None | c.vocab_tags = None |
c.composer_tags = None | |
## 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 = package_form_schema() | schema = package_form_schema() |
schema.update({ | schema.update({ |
'published_by': [ignore_missing, unicode, convert_to_extras], | 'published_by': [ignore_missing, unicode, convert_to_extras], |
'vocab_tags': [ignore_missing, convert_to_tags(EXAMPLE_VOCAB)], | 'genre_tags': [ignore_missing, convert_to_tags(GENRE_VOCAB)], |
# 'genre_tags': [ignore_missing, convert_to_tags(self.genre_vocab.name)], | 'composer_tags': [ignore_missing, convert_to_tags(COMPOSER_VOCAB)] |
# 'composer_tags': [ignore_missing, convert_to_tags(self.composer_vocab.name)], | |
}) | }) |
return schema | return schema |
def db_to_form_schema(self): | 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 = package_form_schema() | schema = package_form_schema() |
schema.update({ | schema.update({ |
'tags': { | 'tags': { |
'__extras': [keep_extras, free_tags_only] | '__extras': [keep_extras, free_tags_only] |
}, | }, |
'vocab_tags_selected': [convert_from_tags(EXAMPLE_VOCAB), ignore_missing], | 'genre_tags_selected': [ |
# 'genre_tags_selected': [convert_from_tags(self.genre_vocab.name), | convert_from_tags(GENRE_VOCAB), ignore_missing |
# ignore_missing], | ], |
# 'composer_tags_selected': [ | 'composer_tags_selected': [ |
# convert_from_tags(self.composer_vocab.name), ignore_missing], | convert_from_tags(COMPOSER_VOCAB), ignore_missing |
], | |
'published_by': [convert_from_extras, ignore_missing], | 'published_by': [convert_from_extras, ignore_missing], |
}) | }) |
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 |
def filter(self, stream): | def filter(self, stream): |
# Add vocab tags to the bottom of the sidebar. | |
from pylons import request | |
from genshi.filters import Transformer | |
from genshi.input import HTML | |
routes = request.environ.get('pylons.routes_dict') | |
context = {'model': model} | |
if routes.get('controller') == 'package' \ | |
and routes.get('action') == 'read': | |
for vocab in (GENRE_VOCAB, COMPOSER_VOCAB): | |
try: | |
vocab = get_action('vocabulary_show')(context, {'id': vocab}) | |
vocab_tags = [t for t in c.pkg_dict.get('tags', []) | |
if t.get('vocabulary_id') == vocab['id']] | |
except NotFound: | |
vocab_tags = None | |
if not vocab_tags: | |
continue | |
html = '<li class="sidebar-section">' | |
if vocab['name'] == GENRE_VOCAB: | |
html = html + '<h3>Musical Genre</h3>' | |
elif vocab['name'] == COMPOSER_VOCAB: | |
html = html + '<h3>Composer</h3>' | |
html = html + '<ul class="tags clearfix">' | |
for tag in vocab_tags: | |
html = html + '<li>%s</li>' % tag['name'] | |
html = html + "</ul></li>" | |
stream = stream | Transformer( | |
"//div[@id='sidebar']//ul[@class='widget-list']" | |
).append(HTML(html)) | |
return stream | return stream |
# def filter(self, stream): | |
# # Add vocab tags to the bottom of the sidebar. | |
# from pylons import request | |
# from genshi.filters import Transformer | |
# from genshi.input import HTML | |
# routes = request.environ.get('pylons.routes_dict') | |
# if routes.get('controller') == 'package' \ | |
# and routes.get('action') == 'read': | |
# for vocab in (self.genre_vocab, self.composer_vocab): | |
# vocab_tags = [tag for tag in c.pkg_dict.get('tags', []) | |
# if tag.get('vocabulary_id') == vocab.id] | |
# if not vocab_tags: | |
# continue | |
# html = '<li class="sidebar-section">' | |
# html = html + '<h3>%s</h3>' % vocab.name | |
# html = html + '<ul class="tags clearfix">' | |
# for tag in vocab_tags: | |
# html = html + '<li>%s</li>' % tag.get('name') | |
# html = html + "</ul></li>" | |
# stream = stream | Transformer("//div[@id='sidebar']")\ | |
# .append(HTML(html)) | |
# return stream | |
import os | import os |
from logging import getLogger | from logging import getLogger |
from pylons import request | from pylons import request |
from genshi.input import HTML | from genshi.input import HTML |
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). |
It also adds the chosen JQuery plugin to the page if viewing the | It also adds the chosen JQuery plugin to the page if viewing the |
dataset edit page (provides a better UX for working with tags with vocabularies) | dataset edit page (provides a better UX for working with tags with vocabularies) |
""" | """ |
stream = stream | Transformer('//p[@id="examplething"]/text()')\ | stream = stream | Transformer('//p[@id="examplething"]/text()')\ |
.substitute(r'frob', r'foobar') | .substitute(r'frob', r'foobar') |
routes = request.environ.get('pylons.routes_dict') | routes = request.environ.get('pylons.routes_dict') |
if routes.get('controller') == 'package' \ | if routes.get('controller') == 'package' \ |
and routes.get('action') == 'edit': | and routes.get('action') == 'edit': |
stream = stream | Transformer('head').append(HTML( | stream = stream | Transformer('head').append(HTML( |
'<link rel="stylesheet" href="/css/chosen.css" />' | '<link rel="stylesheet" href="/css/chosen.css" />' |
)) | )) |
stream = stream | Transformer('body').append(HTML( | stream = stream | Transformer('body').append(HTML( |
''' | ''' |
<script src="/scripts/chosen.jquery.min.js" type="text/javascript"></script>' | <script src="/scripts/chosen.jquery.min.js" type="text/javascript"></script>' |
<script type="text/javascript">$(".chzn-select").chosen();</script> | <script type="text/javascript">$(".chzn-select").chosen();</script> |
''' | ''' |
)) | )) |
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="dataset-edit" 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 py:for="key, error in error_summary.items()">${"%s: %s" % (key if not key=='Name' else 'URL', error)} |
<py:if test="key=='Resources'"> | <py:if test="key=='Resources'"> |
<ul> | <ul> |
<py:for each="idx, errordict in enumerate(errors.get('resources', []))"> | <py:for each="idx, errordict in enumerate(errors.get('resources', []))"> |
<li py:if="errordict"> | <li py:if="errordict"> |
Resource ${idx}: | Resource ${idx}: |
<ul> | <ul> |
<li py:for="thiskey, thiserror in errordict.items()">${thiskey}: <py:for each="errorinfo in thiserror">${errorinfo}; </py:for></li> | <li py:for="thiskey, thiserror in errordict.items()">${thiskey}: <py:for each="errorinfo in thiserror">${errorinfo}; </py:for></li> |
</ul> | </ul> |
</li> | </li> |
</py:for> | </py:for> |
</ul> | </ul> |
</py:if> | </py:if> |
</li> | </li> |
<script>var global_form_errors = ${h.dump_json(errors)};</script> | |
</ul> | </ul> |
</div> | </div> |
<fieldset id="basic-information"> | <fieldset id="basic-information"> |
<dl> | <dl> |
<dt class="title-label"><label class="field_opt" for="title">Title</label></dt> | <dt class="title-label"><label class="field_opt" for="title">Title</label></dt> |
<dd class="title-field"> | <dd class="title-field"> |
<input id="title" | <input id="title" |
class="js-title" | class="js-title" |
name="title" type="text" | name="title" type="text" |
value="${data.get('title', '')}" | value="${data.get('title', '')}" |
placeholder="${_('A short descriptive title for the dataset')}" | placeholder="${_('A short descriptive title for the dataset')}" |
/> | /> |
</dd> | </dd> |
<dd class="title-instructions field_error" py:if="errors.get('title', '')">${errors.get('title', '')}</dd> | <dd class="title-instructions field_error" py:if="errors.get('title', '')">${errors.get('title', '')}</dd> |
<dt class="name-label"><label class="field_req" for="name">Url</label></dt> | <dt class="name-label"><label class="field_req" for="name">Url</label></dt> |
<dd class="name-field"> | <dd class="name-field"> |
<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> | <span class="url-text">${h.url(controller='package', action='search')+'/'}<span class="js-url-viewmode js-url-suffix"> </span><a href="#" class="url-edit 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', '')}" /> | <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', '')}" /> |
<p class="js-url-is-valid"> </p> | <p class="js-url-is-valid"> </p> |
<p class="url-is-long">Warning: URL is very long. Consider changing it to something shorter.</p> | |
</dd> | </dd> |
<dd style="display: none;" class="js-url-editmode name-instructions basic">2+ characters, lowercase, using only 'a-z0-9' and '-_'</dd> | <dd style="display: none;" class="js-url-editmode name-instructions basic">2+ characters, lowercase, using only 'a-z0-9' and '-_'</dd> |
<dd class="js-url-editmode name-instructions field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd> | <dd class="js-url-editmode name-instructions field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd> |
<dt class="homepage-label"><label class="field_opt" for="url">Home Page</label></dt> | <dt class="homepage-label"><label class="field_opt" for="url">Home Page</label></dt> |
<dd class="homepage-field"><input id="url" name="url" type="text" value="${data.get('url', '')}"/></dd> | <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> | <dd class="homepage-instructions instructions basic">The URL for the web page describing the data (not the data itself).</dd> |
<dd class="homepage-instructions hints">e.g. http://www.example.com/growth-figures.html</dd> | <dd class="homepage-instructions hints">e.g. http://www.example.com/growth-figures.html</dd> |
<dd class="homepage-instructions field_error" py:if="errors.get('url', '')">${errors.get('url', '')}</dd> | <dd class="homepage-instructions field_error" py:if="errors.get('url', '')">${errors.get('url', '')}</dd> |
<dt class="license-label"><label class="field_opt" for="license_id">License</label></dt> | <dt class="license-label"><label class="field_opt" for="license_id">License</label></dt> |
<dd class="license-field"> | <dd class="license-field"> |
<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', '') == licence_id else None}" >${licence_desc}</option> | <option value="${licence_id}" py:attrs="{'selected': 'selected' if data.get('license_id', '') == licence_id else None}" >${licence_desc}</option> |
</py:for> | </py:for> |
</select> | </select> |
</dd> | </dd> |
<dd class="license-instructions instructions basic">The licence under which the dataset is released.</dd> | <dd class="license-instructions instructions basic">(Don't worry if you don't know which license the data has been released under).</dd> |
<dt class="description-label"><label class="field_opt" for="notes">Description</label></dt> | <dt class="description-label"><label class="field_opt" for="notes">Description</label></dt> |
<dd class="description-field"><div class="markdown-editor"> | <dd class="description-field"><div class="markdown-editor"> |
<ul class="button-row"> | <ul class="button-row"> |
<li><button class="pretty-button js-markdown-edit depressed">Edit</button></li> | <li><button class="pretty-button js-markdown-edit depressed">Edit</button></li> |
<li><button class="pretty-button js-markdown-preview">Preview</button></li> | <li><button class="pretty-button js-markdown-preview">Preview</button></li> |
</ul> | </ul> |
<textarea class="markdown-input" name="notes" id="notes" placeholder="${_('Start with a summary sentence ...')}">${data.get('notes','')}</textarea> | <textarea class="markdown-input" name="notes" id="notes" placeholder="${_('Start with a summary sentence ...')}">${data.get('notes','')}</textarea> |
<div class="markdown-preview" style="display: none;"></div> | <div class="markdown-preview" style="display: none;"></div> |
<span class="hints">You can use <a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown formatting</a> here.</span> | <span class="hints">You can use <a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown formatting</a> here.</span> |
<!-- | <!-- |
<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 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> | <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> |
--> | --> |
</div></dd> | </div></dd> |
</dl> | <dt class="groups-label"> |
</fieldset> | Groups |
</dt> | |
<fieldset id="resources"> | <dd class="groups-field"> |
<div class="instructions basic"><h3>Resources: the files and APIs associated with this dataset</h3></div> | <dl> |
<table class="resource-table-edit"> | <py:for each="num, group in enumerate(data.get('groups', []))"> |
<thead> | <?python |
<tr> | authorized_group = [group_authz for group_authz in c.groups_authz if group_authz['id'] == group['id']] |
<th class="field_req resource-url">Resource</th> | authorized_group = authorized_group[0] if authorized_group else None |
<th class="resource-delete-link"></th> | ?> |
</tr> | |
</thead> | <dt py:if="'id' in group"> |
<tbody class="js-resource-editor"> | <input type="${'checkbox' if authorized_group else 'hidden'}" name="groups__${num}__id" checked="checked" value="${group['id']}" /> |
</tbody> | <input type="hidden" name="groups__${num}__name" value="${group.get('name', authorized_group['name'] if authorized_group else '')}" /> |
</table> | </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> | |
<div class="resource-add"> | |
<ul class="button-row"> | <dt>Add to:</dt> |
<li><h4>Add a resource:</h4></li> | <dd py:if="c.groups_available"> |
<li><button class="pretty-button js-link-file">Link to a file</button></li> | <select id="groups__${len(data.get('groups', []))}__id" name="groups__${len(data.get('groups', []))}__id"> |
<li><button class="pretty-button js-link-api">Link to an API</button></li> | <option selected="selected" value="">(None)</option> |
<li class="js-upload-file ckan-logged-in" style="display: none;"><button class="pretty-button js-upload-file">Upload a file</button></li> | <py:for each="group in c.groups_available"> |
</ul> | <option value="${group['id']}" >${group['name']}</option> |
</div> | </py:for> |
</fieldset> | </select> |
</dd> | |
<fieldset id="groups"> | <dd py:if="not c.groups_available"><em>Cannot add any groups.</em></dd> |
<h3>Groups</h3> | </dl> |
<dl> | </dd> |
<py:for each="num, group in enumerate(data.get('groups', []))"> | <dt class="tags-label"> |
<?python | Tags |
authorized_group = [group_authz for group_authz in c.groups_authz if group_authz['id'] == group['id']] | </dt> |
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"> | <dd class="tags-field"> |
<input class="long autocomplete-tag" id="tag_string" name="tag_string" size="60" type="text" | <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')])}" /> | value="${data.get('tag_string') or ', '.join([tag['name'] for tag in data.get('tags', []) if not tag.get('vocabulary_id')])}" /> |
</dd> | </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 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.ckan.org/Managing_Datasets#Tag_Conventions">this wiki page</a>.</dd> |
<dd class="tags-instructions hints">e.g. pollution, rivers, water quality</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> | <dd class="tags-instructions field_error" py:if="errors.get('tag_string', '')">${errors.get('tag_string', '')}</dd> |
</dl> | </dl> |
<h3 py:if="c.vocab_tags">Tags With Example Vocabulary</h3> | |
<dl py:if="c.vocab_tags"> | <dl py:if="c.genre_tags"> |
<dt><label class="field_opt" for="tags_vocab">Musical Genre</label></dt> | |
<!-- <h3>Musical Genre</h3> --> | <dd> |
<!-- <dl> --> | <select id="genre_tags" class="chzn-select" name="genre_tags" size="60" multiple="multiple"> |
<!-- <dt class="tags-label"><label class="field_opt" for="tags_vocab">Tags</label></dt> --> | <py:for each="tag in c.genre_tags"> |
<!-- <dd class="tags-field"> --> | <py:choose test=""> |
<!-- <select id="genre_tags" class="chzn-select" name="genre_tags" size="60" multiple="multiple"> --> | <option py:when="tag in data.get('genre_tags_selected', [])" selected="selected" value="${tag}">${tag}</option> |
<!-- <py:for each="tag in c.genre_tags"> --> | <option py:otherwise="" value="${tag}">${tag}</option> |
<!-- <py:choose test=""> --> | </py:choose> |
<!-- <option py:when="tag in data.get('genre_tags_selected', [])" selected="selected" value="${tag}">${tag}</option> --> | </py:for> |
<!-- <option py:otherwise="" value="${tag}">${tag}</option> --> | </select> |
<!-- </py:choose> --> | </dd> |
<!-- </py:for> --> | <dd class="tags-instructions field_error" py:if="errors.get('genre_tag_string', '')">${errors.get('genre_tag_string', '')}</dd> |
<!-- </select> --> | </dl> |
<!-- </dd> --> | |
<!-- <dd class="tags-instructions field_error" py:if="errors.get('genre_tag_string', '')">${errors.get('genre_tag_string', '')}</dd> --> | <dl py:if="c.composer_tags"> |
<!-- </dl> --> | <dt><label class="field_opt" for="tags_vocab">Composer</label></dt> |
<dd> | |
<!-- <h3>Composer</h3> --> | <select id="composer_tags" class="chzn-select" name="composer_tags" size="60" multiple="multiple"> |
<!-- <dl> --> | <py:for each="tag in c.composer_tags"> |
<!-- <dt class="tags-label"><label class="field_opt" for="tags_vocab">Tags</label></dt> --> | <py:choose test=""> |
<!-- <dd class="tags-field"> --> | <option py:when="tag in data.get('composer_tags_selected', [])" selected="selected" value="${tag}">${tag}</option> |
<!-- <select id="composer_tags" class="chzn-select" name="composer_tags" size="60" multiple="multiple"> --> | <option py:otherwise="" value="${tag}">${tag}</option> |
<!-- <py:for each="tag in c.composer_tags"> --> | </py:choose> |
<!-- <py:choose test=""> --> | </py:for> |
<!-- <option py:when="tag in data.get('composer_tags_selected', [])" selected="selected" value="${tag}">${tag}</option> --> | </select> |
<!-- <option py:otherwise="" value="${tag}">${tag}</option> --> | </dd> |
<!-- </py:choose> --> | <dd class="tags-instructions field_error" py:if="errors.get('composer_tag_string', '')">${errors.get('composer_tag_string', '')}</dd> |
<!-- </py:for> --> | </dl> |
<!-- </select> --> | </fieldset> |
<!-- </dd> --> | |
<!-- <dd class="tags-instructions field_error" py:if="errors.get('composer_tag_string', '')">${errors.get('composer_tag_string', '')}</dd> --> | <fieldset id="resources"> |
<!-- </dl> --> | <div class="instructions"> |
<h3>Add resources:</h3> | |
</fieldset> | <p>Upload or link data files, APIs and other materials related to your dataset.</p> |
</div> | |
<div class="js-resource-edit-barebones"> | |
<!-- The resource editor deletes these fields and replaces them with a dynamic editor. | |
They are required for the form to render correctly when not in resource-edit mode. --> | |
<py:for each="num,res in enumerate(data.get('resources', []))"> | |
<py:for each="field in res.keys()"> | |
<input type="hidden" name="resources__${res.get('position')}__${field}" value="${res.get(field)}" /> | |
</py:for> | |
</py:for> | |
</div> | |
<ul class="resource-list resource-list-edit drag-drop-list"> | |
</ul> | |
<ul class="resource-list resource-list-add"> | |
<li><a href="#" class="js-resource-add">${h.icon('page_white_add')}New resource...</a></li> | |
</ul> | |
<div style="display: none;" class="resource-panel"> | |
<button class="pretty-button danger resource-panel-close">x</button> | |
<div class="resource-details resource-add"> | |
<ul class="button-row"> | |
<li><h4>Add a resource:</h4></li> | |
<li><button class="pretty-button js-link-file">Link to a file</button></li> | |
<li><button class="pretty-button js-link-api">Link to an API</button></li> | |
<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> | |
</div> | |
</fieldset> | |
<fieldset id='further-information'> | <fieldset id='further-information'> |
<dl> | <dl> |
<dt><label class="field_opt" for="author">Author</label></dt> | <dt><label class="field_opt" for="author">Author</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 name of the main contact, for enquiries about this particular dataset, using the e-mail address in the following field.</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> | <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> | <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> | <dt><label class="field_opt" for="maintainer">Maintainer</label></dt> |
<dd><input id="maintainer" name="maintainer" type="text" value="${data.get('maintainer', '')}" /></dd> | <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> | <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> | <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> | <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> | <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><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="instructions basic">A number representing the version (if applicable)</dd> |
<dd class="hints">e.g. 1.2.0</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> | </dl> |
</fieldset> | </fieldset> |
<fieldset id='extras'> | <fieldset id='extras'> |
<dl> | <p>Adding custom fields to the dataset such as "location:uk" can help users find it in the search engine. This data will also appear under <strong>Additional Information</strong> when viewing the dataset.</p> |
<dt><label class="field_req" for="published_by">Published by *</label></dt> | <dl> |
<dd> | |
<select id="published_by" name="published_by"> | |
<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}" > | |
${published_desc} | |
</option> | |
</py:for> | |
</select> | |
</dd> | |
<dd class="instructions basic">The organisation credited with or associated with the publication of this data.</dd> | |
<py:with vars="extras = data.get('extras', [])"> | <py:with vars="extras = data.get('extras', [])"> |
<py:for each="num, extra in enumerate(data.get('extras', []))"> | <py:for each="num, extra in enumerate(data.get('extras', []))"> |
<dt><label for="extras__${num}__value">${extra.get('key')}</label></dt> | <dt><label for="extras__${num}__value">${extra.get('key')}</label></dt> |
<dd> | <dd> |
<input id="extras__${num}__key" name="extras__${num}__key" type="hidden" value="${extra.get('key')}" /> | <input id="extras__${num}__key" name="extras__${num}__key" type="hidden" value="${extra.get('key')}" /> |
<input id="extras__${num}__value" name="extras__${num}__value" type="text" value="${extra.get('value')}" /> | <input id="extras__${num}__value" name="extras__${num}__value" type="text" value="${extra.get('value')}" /> |
<input type="checkbox" name="extras__${num}__deleted" checked="${extra.get('deleted')}">Delete</input> | <input type="checkbox" name="extras__${num}__deleted" checked="${extra.get('deleted')}">Delete</input> |
</dd> | </dd> |
</py:for> | </py:for> |
<py:for each="num in range(len(extras), len(extras) + 4)"> | <py:for each="num in range(len(extras), len(extras) + 4)"> |
<dt><label for="extras__${num}__key">New key</label></dt> | <dt><label for="extras__${num}__key">New key</label></dt> |
<dd> | <dd> |
<input class="medium-width" id="extras__${num}__key" name="extras__${num}__key" type="text" /> | <input class="medium-width" id="extras__${num}__key" name="extras__${num}__key" type="text" /> |
with value | with value |
<input class="medium-width" id="extras__${num}__value" name="extras__${num}__value" type="text" /> | <input class="medium-width" id="extras__${num}__value" name="extras__${num}__value" type="text" /> |
</dd> | </dd> |
</py:for> | </py:for> |
</py:with> | </py:with> |
</dl> | </dl> |
</fieldset> | </fieldset> |
<fieldset id='delete' py:if="c.is_sysadmin or c.auth_for_change_state"> | |
<label for="log_message" class="edit-summary">Edit summary (briefly describe the changes you have made)</label> | <dl> |
<textarea id="log_message" name="log_message" class="edit-summary short wide">${data.get('log_message', '')}</textarea> | <dt>Delete</dt> |
<dd> | |
<div class="ckan-logged-in" style="display: none;"> | <p>Do you really want to change the state of this dataset? <button class="dataset-delete pretty-button">Yes!</button></p> |
<span> | |
This dataset is | |
<select id="state" class="dataset-delete" name="state" style="display:inline;"> | |
<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> | |
</span> | |
</dd> | |
</dl> | |
</fieldset> | |
<div id="unsaved-warning"></div> | |
<label for="log_message" class="edit-summary">Edit summary (briefly describe the changes you have made)...</label> | |
<textarea id="log_message" name="log_message" class="edit-summary short wide">${data.get('log_message', h.auto_log_message(c))}</textarea> | |
<div class="author-box 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="author-box ckan-logged-out"> |
<label>Author: ${c.author}</label> | <label>Author: ${c.author}</label> |
<p i18n:msg="" 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="form-submit"> | <div class="form-submit"> |
<input id="save" class="pretty-button primary" name="save" type="submit" value="${_('Save Changes')}" /> | <input id="save" class="pretty-button primary" name="save" type="submit" value="${_('Save Changes')}" /> |
<py:if test="c.pkg"> | <py:if test="c.pkg"> |
<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)}" /> | <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)}" /> |
</py:if> | </py:if> |
<p i18n:msg="" class="hints"> | <p i18n:msg="" class="hints"> |
<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. | <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 class="clear"></div> |
</div> | </div> |
</form> | </form> |
<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')} | ${h.nav_link(c, _('Home'), controller='home', action='index')} |
${h.nav_link(c, _('Data'), controller='package', action='index')} | ${h.nav_link(c, _('Data'), controller='package', action='search')} |
${h.nav_link(c, _('New dataset'), controller='package', action='new')} | ${h.nav_link(c, _('New dataset'), controller='package', action='new')} |
${h.nav_link(c, _('New group'), controller='group', 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> |