[1720][forms] tidy up: remove unused imports
--- /dev/null
+++ b/.gitignore
@@ -1,1 +1,10 @@
-
+*.egg-info
+*.pyc
+*.swp
+*.swo
+*~
+#*
+.#*
+build/
+dist/
+distribute-*
--- a/.hgignore
+++ /dev/null
@@ -1,11 +1,1 @@
-syntax: glob
-*.egg-info
-*.pyc
-*.swp
-*.swo
-*~
-#*
-.#*
-build/
-dist/
--- /dev/null
+++ b/README.rst
@@ -1,1 +1,66 @@
+This CKAN Extension demonstrates some common patterns for customising a CKAN instance.
+It comprises:
+
+* A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when
+ loaded, overrides various settings in the core ``ini``-file to provide:
+
+ * A path to local customisations of the core templates and stylesheets
+ * 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 custom Pylons controller for overriding some core CKAN behaviour
+
+* A custom Package edit form
+
+* A custom Group edit form
+
+* A plugin that allows for custom forms to be used for datasets based on
+ their "type".
+
+* A custom User registration and edition form
+
+* Some simple template customisations
+
+Installation
+============
+
+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
+
+Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file.
+
+
+Orientation
+===========
+
+* Examine the source code, starting with ``ckanext/example/plugin.py``
+
+* To understand the nuts and bolts of this file, which is a CKAN
+ *Extension*, read in conjunction with the "Extension
+ documentation": http://docs.ckan.org/en/latest/plugins.html
+
+* One thing the extension does is set the values of
+ ``extra_public_paths`` and ``extra_template_paths`` in the CKAN
+ config, which are "documented
+ here": http://docs.ckan.org/en/latest/configuration.html#extra-template-paths
+
+* These are set to point at directories within
+ ``ckanext/example/theme/`` (in this package). Here we:
+ * 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
+ * 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.
+ It uses the _layout template_ pattern "described in the Genshi
+ documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate.
+ This allows you to use Xpath selectors to override snippets of HTML
+ globally.
+
+* 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
+ updating. In the meantime, follow the instructions at:
+ http://readthedocs.org/docs/ckan/en/latest/forms.html
+
+
--- a/README.txt
+++ /dev/null
@@ -1,57 +1,1 @@
-This CKAN Extension demonstrates some common patterns for customising a CKAN instance.
-It comprises:
-
- * A CKAN Extension "plugin" at ``ckanext/exampletheme/__init__.py``
- which, when loaded, overrides various settings in the core
- ``ini``-file to provide:
-
- * A path to local customisations of the core templates and stylesheets
- * 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 custom Pylons controller for overriding some core CKAN behaviour
-
- * A custom Package edit form
-
- * Some simple template customisations
-
-Installation
-============
-
-To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``)::
-
- pip install -e hg+https://bitbucket.org/okfn/ckanext-exampletheme#egg=ckanext-exampletheme
-
-Then activate it by setting ``ckan.plugins = exampletheme`` in your main ``ini``-file.
-
-
-Orientation
-===========
-
-* Examine the source code, starting with ``ckanext/exampletheme/__init__.py``
-
-* To understand the nuts and bolts of this file, which is a CKAN
- *Extension*, read in conjunction with the "Extension
- documentation":http://packages.python.org/ckan/plugins.html
-
-* One thing the extension does is set the values of
- ``extra_public_paths`` and ``extra_template_paths`` in the CKAN
- config, which are "documented
- here":http://packages.python.org/ckan/configuration.html#extra-template-paths
-
-* These are set to point at directories within
- `ckanext/exampletheme/theme/`` (in this package). Here, we override
- the home page, provide some extra style with an ``extra.css``, and
- 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.
- It uses the _layout template_ pattern "described in the Genshi
- documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate.
- This allows you to use Xpath selectors to override snippets of HTML
- globally.
-
-* The custom package edit form at ``package_form.py`` follows the
- conventions in the "main CKAN
- documentation":http://packages.python.org/ckan/forms.html
-
--- /dev/null
+++ b/ckanext/example/__init__.py
@@ -1,1 +1,2 @@
+# package
--- /dev/null
+++ b/ckanext/example/controller.py
@@ -1,1 +1,53 @@
+import sys
+from ckan.lib.base import request
+from ckan.lib.base import c, g, h
+from ckan.lib.base import model
+from ckan.lib.base import render
+from ckan.lib.base import _
+from ckan.lib.navl.validators import not_empty
+
+from ckan.controllers.user import UserController
+
+
+class CustomUserController(UserController):
+ """This controller is an example to show how you might extend or
+ override core CKAN behaviour from an extension package.
+
+ It overrides 2 method hooks which the base class uses to create the
+ validation schema for the creation and editing of a user; to require
+ that a fullname is given.
+ """
+
+ new_user_form = 'user/register.html'
+
+ def _add_requires_full_name_to_schema(self, schema):
+ """
+ Helper function that modifies the fullname validation on an existing schema
+ """
+ schema['fullname'] = [not_empty, unicode]
+
+ def _new_form_to_db_schema(self):
+ """
+ Defines a custom schema that requires a full name to be supplied
+
+ This method is a hook that the base class calls for the validation
+ schema to use when creating a new user.
+ """
+ schema = super(CustomUserController, self)._new_form_to_db_schema()
+ self._add_requires_full_name_to_schema(schema)
+ return schema
+
+ def _edit_form_to_db_schema(self):
+ """
+ Defines a custom schema that requires a full name cannot be removed
+ when editing the user.
+
+ This method is a hook that the base class calls for the validation
+ schema to use when editing an exiting user.
+ """
+ schema = super(CustomUserController, self)._edit_form_to_db_schema()
+ self._add_requires_full_name_to_schema(schema)
+ return schema
+
+
--- /dev/null
+++ b/ckanext/example/forms.py
@@ -1,1 +1,225 @@
-
+import os, logging
+from ckan.authz import Authorizer
+from ckan.logic.converters import convert_to_extras,\
+ convert_from_extras, convert_to_tags, convert_from_tags
+from ckan.logic.schema import package_form_schema, group_form_schema
+from ckan.model import vocabulary
+from ckan.lib.base import c, model
+from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer, IConfigurable
+from ckan.plugins import implements, SingletonPlugin
+from ckan.lib.navl.validators import ignore_missing, not_empty, keep_extras
+
+log = logging.getLogger(__name__)
+
+class ExampleGroupForm(SingletonPlugin):
+ """This plugin demonstrates how a class packaged as a CKAN
+ extension might extend CKAN behaviour by providing custom forms
+ based on the type of a Group.
+
+ In this case, we implement two extension interfaces to provide custom
+ forms for specific types of group.
+
+ - ``IConfigurer`` allows us to override configuration normally
+ found in the ``ini``-file. Here we use it to specify where the
+ form templates can be found.
+
+ - ``IGroupForm`` allows us to provide a custom form for a dataset
+ based on the 'type' that may be set for a group. Where the
+ 'type' matches one of the values in group_types then this
+ class will be used.
+ """
+ implements(IGroupForm, inherit=True)
+ implements(IConfigurer, inherit=True)
+
+ def update_config(self, config):
+ """
+ This IConfigurer implementation causes CKAN to look in the
+ ```templates``` directory when looking for the group_form()
+ """
+ here = os.path.dirname(__file__)
+ rootdir = os.path.dirname(os.path.dirname(here))
+ template_dir = os.path.join(rootdir, 'ckanext',
+ 'example', 'theme', 'templates')
+ config['extra_template_paths'] = ','.join([template_dir,
+ config.get('extra_template_paths', '')])
+
+ def group_form(self):
+ """
+ Returns a string representing the location of the template to be
+ rendered. e.g. "forms/group_form.html".
+ """
+ return 'forms/group_form.html'
+
+ def group_types(self):
+ """
+ Returns an iterable of group type strings.
+
+ If a request involving a group of one of those types is made, then
+ this plugin instance will be delegated to.
+
+ There must only be one plugin registered to each group type. Any
+ attempts to register more than one plugin instance to a given group
+ type will raise an exception at startup.
+ """
+ return ["testgroup"]
+
+ def is_fallback(self):
+ """
+ Returns true iff this provides the fallback behaviour, when no other
+ plugin instance matches a group's type.
+
+ As this is not the fallback controller we should return False. If
+ we were wanting to act as the fallback, we'd return True
+ """
+ return False
+
+ 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):
+ """This plugin demonstrates how a theme packaged as a CKAN
+ extension might extend CKAN behaviour.
+
+ In this case, we implement three extension interfaces:
+
+ - ``IConfigurer`` allows us to override configuration normally
+ found in the ``ini``-file. Here we use it to specify where the
+ form templates can be found.
+ - ``IDatasetForm`` allows us to provide a custom form for a dataset
+ based on the type_name that may be set for a package. Where the
+ type_name matches one of the values in package_types then this
+ class will be used.
+ """
+ implements(IDatasetForm, inherit=True)
+ implements(IConfigurer, inherit=True)
+ implements(IConfigurable)
+
+ def update_config(self, config):
+ """
+ This IConfigurer implementation causes CKAN to look in the
+ ```templates``` directory when looking for the package_form()
+ """
+ here = os.path.dirname(__file__)
+ rootdir = os.path.dirname(os.path.dirname(here))
+ template_dir = os.path.join(rootdir, 'ckanext',
+ 'example', 'theme', 'templates')
+ config['extra_template_paths'] = ','.join([template_dir,
+ config.get('extra_template_paths', '')])
+
+ def configure(self, config):
+ """
+ Adds our new vocabulary to the database if it doesn't
+ already exist.
+ """
+ self.vocab_name = u'example_vocab'
+ v = vocabulary.get(self.vocab_name)
+ if not v:
+ log.info("Adding vocab %s" % self.vocab_name)
+ vocab = model.Vocabulary(self.vocab_name)
+ model.Session.add(vocab)
+ model.Session.commit()
+
+ def package_form(self):
+ """
+ Returns a string representing the location of the template to be
+ rendered. e.g. "package/new_package_form.html".
+ """
+ return 'forms/dataset_form.html'
+
+ def is_fallback(self):
+ """
+ Returns true iff this provides the fallback behaviour, when no other
+ plugin instance matches a package's type.
+
+ As this is not the fallback controller we should return False. If
+ we were wanting to act as the fallback, we'd return True
+ """
+ return True
+
+ def package_types(self):
+ """
+ Returns an iterable of package type strings.
+
+ If a request involving a package of one of those types is made, then
+ this plugin instance will be delegated to.
+
+ There must only be one plugin registered to each package type. Any
+ attempts to register more than one plugin instance to a given package
+ type will raise an exception at startup.
+ """
+ return ["example_dataset_form"]
+
+ def setup_template_variables(self, context, data_dict=None):
+ """
+ Adds variables to c just prior to the template being rendered that can
+ then be used within the form
+ """
+ c.licences = [('', '')] + model.Package.get_license_options()
+ c.publishers = [('Example publisher', 'Example publisher 2')]
+ c.is_sysadmin = Authorizer().is_sysadmin(c.user)
+ c.resource_columns = model.Resource.get_columns()
+
+ ## This is messy as auths take domain object not data_dict
+ pkg = context.get('package') or c.pkg
+ if pkg:
+ c.auth_for_change_state = Authorizer().am_authorized(
+ c, model.Action.CHANGE_STATE, pkg)
+
+ def form_to_db_schema(self):
+ """
+ Returns the schema for mapping package data from a form to a format
+ suitable for the database.
+ """
+ schema = package_form_schema()
+ schema.update({
+ 'published_by': [not_empty, unicode, convert_to_extras],
+ 'vocab_tag_string': [ignore_missing, convert_to_tags(self.vocab_name)],
+ })
+ return schema
+
+ def db_to_form_schema(self):
+ """
+ Returns the schema for mapping package data from the database into a
+ format suitable for the form (optional)
+ """
+ schema = package_form_schema()
+ schema.update({
+ 'tags': {
+ '__extras': [keep_extras]
+ },
+ 'vocab_tag_string': [convert_from_tags(self.vocab_name), ignore_missing],
+ 'published_by': [convert_from_extras, ignore_missing],
+ })
+ return schema
+
+ def check_data_dict(self, data_dict):
+ """
+ Check if the return data is correct and raises a DataError if not.
+ """
+ return
+
+
--- /dev/null
+++ b/ckanext/example/package_form.py
@@ -1,1 +1,40 @@
+from sqlalchemy.util import OrderedDict
+from pylons.i18n import _
+from ckan.forms import common
+from ckan.forms import package
+
+
+# Setup the fieldset
+def build_example_form(is_admin=False,
+ user_editable_groups=None,
+ **kwargs):
+ """Customise the core CKAN dataset editing form by adding a new
+ field "temporal coverage", and changing the layout of the core
+ fields.
+ """
+ # Restrict fields
+ builder = package.build_package_form(
+ user_editable_groups=user_editable_groups)
+
+ # Extra fields
+ builder.add_field(common.DateRangeExtraField('temporal_coverage'))
+
+ # Layout
+ field_groups = OrderedDict([
+ (_('Customised Basic information'), ['title', 'name', 'url',
+ 'notes', 'tags']),
+ (_('Details'), ['author', 'author_email', 'groups',
+ 'maintainer', 'maintainer_email',
+ 'license_id', 'temporal_coverage' ]),
+ (_('Resources'), ['resources']),
+ ])
+ builder.set_displayed_fields(field_groups)
+ return builder
+
+
+def get_example_fieldset(is_admin=False, user_editable_groups=None, **kwargs):
+ return build_example_form(is_admin=is_admin,
+ user_editable_groups=user_editable_groups,
+ **kwargs).get_fieldset()
+
--- /dev/null
+++ b/ckanext/example/plugin.py
@@ -1,1 +1,102 @@
+import os
+from logging import getLogger
+from genshi.filters.transform import Transformer
+
+from ckan.plugins import implements, SingletonPlugin
+from ckan.plugins import IConfigurer
+from ckan.plugins import IGenshiStreamFilter
+from ckan.plugins import IRoutes
+
+log = getLogger(__name__)
+
+
+class ExamplePlugin(SingletonPlugin):
+ """This plugin demonstrates how a theme packaged as a CKAN
+ extension might extend CKAN behaviour.
+
+ In this case, we implement three extension interfaces:
+
+ - ``IConfigurer`` allows us to override configuration normally
+ found in the ``ini``-file. Here we use it to specify the site
+ title, and to tell CKAN to look in this package for templates
+ and resources that customise the core look and feel.
+
+ - ``IGenshiStreamFilter`` allows us to filter and transform the
+ HTML stream just before it is rendered. In this case we use
+ it to rename "frob" to "foobar"
+
+ - ``IRoutes`` allows us to add new URLs, or override existing
+ URLs. In this example we use it to override the default
+ ``/register`` behaviour with a custom controller
+ """
+ implements(IConfigurer, inherit=True)
+ implements(IGenshiStreamFilter, inherit=True)
+ implements(IRoutes, inherit=True)
+
+ def update_config(self, config):
+ """This IConfigurer implementation causes CKAN to look in the
+ ```public``` and ```templates``` directories present in this
+ package for any customisations.
+
+ It also shows how to set the site title here (rather than in
+ the main site .ini file), and causes CKAN to use the
+ customised package form defined in ``package_form.py`` in this
+ directory.
+ """
+ here = os.path.dirname(__file__)
+ rootdir = os.path.dirname(os.path.dirname(here))
+ our_public_dir = os.path.join(rootdir, 'ckanext',
+ 'example', 'theme', 'public')
+ template_dir = os.path.join(rootdir, 'ckanext',
+ 'example', 'theme',
+ 'templates')
+ # set our local template and resource overrides
+ config['extra_public_paths'] = ','.join([our_public_dir,
+ config.get('extra_public_paths', '')])
+ config['extra_template_paths'] = ','.join([template_dir,
+ config.get('extra_template_paths', '')])
+ # add in the extra.css
+ config['ckan.template_head_end'] = config.get('ckan.template_head_end', '') +\
+ '<link rel="stylesheet" href="/css/extra.css" type="text/css"> '
+ # set the title
+ config['ckan.site_title'] = "Example CKAN theme"
+ # set the customised package form (see ``setup.py`` for entry point)
+ config['package_form'] = "example_form"
+
+ def filter(self, stream):
+ """Conform to IGenshiStreamFilter interface.
+
+ This example filter renames 'frob' to 'foobar' (this string is
+ found in the custom ``home/index.html`` template provided as
+ part of the package).
+ """
+ stream = stream | Transformer('//p[@id="examplething"]/text()')\
+ .substitute(r'frob', r'foobar')
+ return stream
+
+ def before_map(self, map):
+ """This IRoutes implementation overrides the standard
+ ``/user/register`` behaviour with a custom controller. You
+ might instead use it to provide a completely new page, for
+ example.
+
+ Note that we have also provided a custom register form
+ template at ``theme/templates/user/register.html``.
+ """
+ # Hook in our custom user controller at the points of creation
+ # and edition.
+ map.connect('/user/register',
+ controller='ckanext.example.controller:CustomUserController',
+ action='register')
+ map.connect('/user/edit',
+ controller='ckanext.example.controller:CustomUserController',
+ action='edit')
+ map.connect('/user/edit/{id:.*}',
+ controller='ckanext.example.controller:CustomUserController',
+ action='edit')
+
+ map.connect('/package/new', controller='package_formalchemy', action='new')
+ map.connect('/package/edit/{id}', controller='package_formalchemy', action='edit')
+ return map
+
--- /dev/null
+++ b/ckanext/example/theme/public/css/extra.css
@@ -1,1 +1,5 @@
+body {
+ background-color: pink;
+}
+
--- /dev/null
+++ b/ckanext/example/theme/templates/forms/dataset_form.html
@@ -1,1 +1,251 @@
-
+<form id="dataset-edit" method="post"
+ py:attrs="{'class':'has-errors'} if errors else {}"
+ xmlns:i18n="http://genshi.edgewall.org/i18n"
+ xmlns:py="http://genshi.edgewall.org/"
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+
+
+<div class="error-explanation" py:if="error_summary">
+<h2>Errors in form</h2>
+<p>The form contains invalid entries:</p>
+<ul>
+ <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)}
+ <py:if test="key=='Resources'">
+ <ul>
+ <py:for each="idx, errordict in enumerate(errors.get('resources', []))">
+ <li py:if="errordict">
+ Resource ${idx}:
+ <ul>
+ <li py:for="thiskey, thiserror in errordict.items()">${thiskey}: <py:for each="errorinfo in thiserror">${errorinfo}; </py:for></li>
+ </ul>
+ </li>
+ </py:for>
+ </ul>
+ </py:if>
+ </li>
+</ul>
+</div>
+
+<fieldset id="basic-information">
+ <dl>
+ <dt class="title-label"><label class="field_opt" for="title">Title</label></dt>
+ <dd class="title-field">
+ <input id="title"
+ class="js-title"
+ name="title" type="text"
+ value="${data.get('title', '')}"
+ placeholder="${_('A short descriptive title for the dataset')}"
+ />
+ </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>
+ <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>
+ <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>
+ </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>
+
+ <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-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 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>
+ <dd class="license-field">
+ <select id="license_id" name="license_id">
+ <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>
+ </py:for>
+ </select>
+ </dd>
+ <dd class="license-instructions instructions basic">The licence under which the dataset is released.</dd>
+
+ <dt class="description-label"><label class="field_opt" for="notes">Description</label></dt>
+ <dd class="description-field"><div class="markdown-editor">
+ <ul class="button-row">
+ <li><button class="pretty-button js-markdown-edit depressed">Edit</button></li>
+ <li><button class="pretty-button js-markdown-preview">Preview</button></li>
+ </ul>
+ <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>
+ <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 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>
+ </dl>
+</fieldset>
+
+<fieldset id="resources">
+ <div class="instructions basic"><h3>Resources: the files and APIs associated with this dataset</h3></div>
+ <table class="resource-table-edit">
+ <thead>
+ <tr>
+ <th class="field_req resource-url">Resource</th>
+ <th class="resource-delete-link"></th>
+ </tr>
+ </thead>
+ <tbody class="js-resource-editor">
+ </tbody>
+ </table>
+
+
+ <div class="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>
+</fieldset>
+
+<fieldset id="groups">
+ <h3>Groups</h3>
+ <dl>
+ <py:for each="num, group in enumerate(data.get('groups', []))">
+ <?python
+ authorized_group = [group_authz for group_authz in c.groups_authz if group_authz['id'] == group['id']]
+ authorized_group = authorized_group[0] if authorized_group else None
+ ?>
+
+ <dt py:if="'id' in group">
+ <input type="${'checkbox' if authorized_group else 'hidden'}" name="groups__${num}__id" checked="checked" value="${group['id']}" />
+ <input type="hidden" name="groups__${num}__name" value="${group.get('name', authorized_group['name'] if authorized_group else '')}" />
+ </dt>
+ <dd py:if="'id' in group"><label for="groups__${num}__checked">${group.get('name', authorized_group['name'] if authorized_group else '')}</label></dd>
+ </py:for>
+
+ <dt>Group</dt>
+ <dd py:if="c.groups_available">
+ <select id="groups__${len(data.get('groups', []))}__id" name="groups__${len(data.get('groups', []))}__id">
+ <option selected="selected" value="">(None)</option>
+ <py:for each="group in c.groups_available">
+ <option value="${group['id']}" >${group['name']}</option>
+ </py:for>
+ </select>
+ </dd>
+ <dd py:if="not c.groups_available"><em>Cannot add any groups.</em></dd>
+ </dl>
+ <h3>Tags</h3>
+ <dl>
+ <dt class="tags-label"><label class="field_opt" for="tags">Tags</label></dt>
+ <dd class="tags-field">
+ <input class="long autocomplete-tag" id="tag_string" name="tag_string" size="60" type="text"
+ value="${data.get('tag_string') or ', '.join([tag['name'] for tag in data.get('tags', [])])}" />
+ </dd>
+ <dd class="tags-instructions instructions basic" i18n:msg="">Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see <a href="http://wiki.okfn.org/ckan/doc/faq#TagConventions">this wiki page</a>.</dd>
+ <dd class="tags-instructions hints">e.g. pollution, rivers, water quality</dd>
+ <dd class="tags-instructions field_error" py:if="errors.get('tag_string', '')">${errors.get('tag_string', '')}</dd>
+ </dl>
+ <h3>Tags with Vocabulary</h3>
+ <dl>
+ <dt class="tags-label"><label class="field_opt" for="tags_vocab">Tags</label></dt>
+ <dd class="tags-field">
+ <input class="long autocomplete-tag" id="vocab_tag_string" name="vocab_tag_string" size="60" type="text"
+ value="${data.get('vocab_tag_string') or ', '.join([tag['name'] for tag in data.get('vocab_tags', [])])}" />
+ </dd>
+ <dd class="tags-instructions instructions basic" i18n:msg="">Similar to standard CKAN tags, but these use a fixed vocabulary.</dd>
+ <dd class="tags-instructions field_error" py:if="errors.get('vocab_tag_string', '')">${errors.get('vocab_tag_string', '')}</dd>
+ </dl>
+</fieldset>
+<fieldset id='further-information'>
+ <dl>
+ <dt><label class="field_opt" for="author">Author</label></dt>
+ <dd><input id="author" name="author" type="text" value="${data.get('author', '')}" /></dd>
+ <dd class="instructions basic">The name of the main contact, for enquiries about this particular dataset, using the e-mail address in the following field.</dd>
+
+ <dt><label class="field_opt" for="author_email">Author email</label></dt>
+ <dd><input id="author_email" name="author_email" type="text" value="${data.get('author_email', '')}" /></dd>
+
+ <dt><label class="field_opt" for="maintainer">Maintainer</label></dt>
+ <dd><input id="maintainer" name="maintainer" type="text" value="${data.get('maintainer', '')}" /></dd>
+ <dd class="instructions basic">If there is another important contact person (in addition to the person in the Author field) then provide details here.</dd>
+
+ <dt><label class="field_opt" for="maintainer_email">Maintainer email</label></dt>
+ <dd><input id="maintainer_email" name="maintainer_email" type="text" value="${data.get('maintainer_email', '')}" /></dd>
+
+ <dt><label class="field_opt" for="version">Version</label></dt>
+ <dd><input id="version" maxlength="100" name="version" type="text" value="${data.get('version', '')}" /></dd>
+ <dd class="instructions basic">A number representing the version (if applicable)</dd>
+ <dd class="hints">e.g. 1.2.0</dd>
+
+ <dt py:if="c.is_sysadmin or c.auth_for_change_state"><label class="field_opt" for="state">State</label></dt>
+ <dd py:if="c.is_sysadmin or c.auth_for_change_state">
+ <select id="state" name="state" >
+ <option py:attrs="{'selected': 'selected' if data.get('state') == 'active' else None}" value="active">active</option>
+ <option py:attrs="{'selected': 'selected' if data.get('state') == 'deleted' else None}" value="deleted">deleted</option>
+ </select>
+ </dd>
+
+ </dl>
+</fieldset>
+
+<fieldset id='extras'>
+ <dl>
+ <dt><label class="field_req" for="published_by">Published by *</label></dt>
+ <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:for each="num, extra in enumerate(data.get('extras', []))">
+ <dt><label for="extras__${num}__value">${extra.get('key')}</label></dt>
+ <dd>
+ <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 type="checkbox" name="extras__${num}__deleted" checked="${extra.get('deleted')}">Delete</input>
+ </dd>
+ </py:for>
+
+ <py:for each="num in range(len(extras), len(extras) + 4)">
+ <dt><label for="extras__${num}__key">New key</label></dt>
+ <dd>
+ <input class="medium-width" id="extras__${num}__key" name="extras__${num}__key" type="text" />
+ with value
+ <input class="medium-width" id="extras__${num}__value" name="extras__${num}__value" type="text" />
+ </dd>
+ </py:for>
+ </py:with>
+ </dl>
+</fieldset>
+
+<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', '')}</textarea>
+
+<div class="ckan-logged-in" style="display: none;">
+ <p>Author: ${c.author}</p>
+</div>
+<div class="ckan-logged-out">
+ <label>Author: ${c.author}</label>
+ <p i18n:msg="" class="hints">
+ 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).
+ </p>
+</div>
+
+<div class="form-submit">
+ <input id="save" class="pretty-button primary" name="save" type="submit" value="${_('Save Changes')}" />
+ <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)}" />
+ </py:if>
+ <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.
+ </p>
+ <div class="clear"></div>
+</div>
+
+</form>
+
--- /dev/null
+++ b/ckanext/example/theme/templates/forms/group_form.html
@@ -1,1 +1,102 @@
+<form id="group-edit" action="" method="post"
+ py:attrs="{'class':'has-errors'} if errors else {}"
+ xmlns:i18n="http://genshi.edgewall.org/i18n"
+ xmlns:py="http://genshi.edgewall.org/"
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+<div class="error-explanation" py:if="error_summary">
+<h2>Errors in form</h2>
+<p>The form contains invalid entries:</p>
+<ul>
+ <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)}</li>
+</ul>
+</div>
+
+<fieldset id="basic-information">
+ <dl>
+ <dt><label class="field_opt" for="name">The Title</label></dt>
+ <dd><input class="js-title" id="title" name="title" type="text" value="${data.get('title', '')}"/></dd>
+
+ <dt><label class="field_opt" for="title">Url</label></dt>
+ <dd class="name-field">
+ <span class="js-url-text url-text">${g.site_url+h.url_for(controller='group', action='index')+'/'}<span class="js-url-viewmode js-url-suffix"> </span><a style="display: none;" href="#" class="url-edit js-url-editlink js-url-viewmode">(edit)</a></span>
+ <input style="display: none;" id="name" maxlength="100" name="name" type="text" class="url-input js-url-editmode js-url-input" value="${data.get('name', '')}" />
+ <p class="js-url-is-valid"> </p>
+ </dd>
+ <dd style="display: none;" class="js-url-editmode instructions basic">2+ chars, lowercase, using only 'a-z0-9' and '-_'</dd>
+ <dd class="field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd>
+
+ <dt class="description-label"><label class="field_opt" for="title">Description</label></dt>
+ <dd class="description-field"><div class="markdown-editor">
+ <ul class="button-row">
+ <li><button class="pretty-button js-markdown-edit depressed">Edit</button></li>
+ <li><button class="pretty-button js-markdown-preview">Preview</button></li>
+ </ul>
+ <textarea class="markdown-input" name="description" id="notes" placeholder="${_('Start with a summary sentence ...')}">${data.get('description','')}</textarea>
+ <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>
+ </div></dd>
+
+
+ <dt class="state-label" py:if="c.is_sysadmin or c.auth_for_change_state"><label class="field_opt" for="state">State</label></dt>
+ <dd class="state-field" py:if="c.is_sysadmin or c.auth_for_change_state">
+ <select id="state" name="state" >
+ <option py:attrs="{'selected': 'selected' if data.get('state') == 'active' else None}" value="active">active</option>
+ <option py:attrs="{'selected': 'selected' if data.get('state') == 'deleted' else None}" value="deleted">deleted</option>
+ </select>
+ </dd>
+ </dl>
+</fieldset>
+
+<fieldset id="extras">
+ <h3>Extras</h3>
+ <dl>
+ <py:with vars="extras = data.get('extras', [])">
+ <py:for each="num, extra in enumerate(data.get('extras', []))">
+ <dt><label for="extras__${num}__value">${extra.get('key')}</label></dt>
+ <dd>
+ <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 type="checkbox" name="extras__${num}__deleted" checked="${extra.get('deleted')}">Delete</input>
+ </dd>
+ </py:for>
+
+ <py:for each="num in range(len(extras), len(extras) + 4)">
+ <dt><label for="extras__${num}__key">New key</label></dt>
+ <dd>
+ <input class="medium-width" id="extras__${num}__key" name="extras__${num}__key" type="text" />
+ with value
+ <input class="medium-width" id="extras__${num}__value" name="extras__${num}__value" type="text" />
+ </dd>
+ </py:for>
+ </py:with>
+ </dl>
+</fieldset>
+
+<fieldset id="datasets">
+ <h3>Datasets</h3>
+ <dl py:if="data.get('packages')">
+ <py:for each="num, package in enumerate(data.get('packages'))">
+ <dt><input checked="checked" id="datasets__${num}__name" name="packages__${num}__name" type="checkbox" value="${package['name']}"/></dt>
+ <dd>
+ <label for="packages__${num}__name">${package['name']}</label>
+ </dd>
+ </py:for>
+ </dl>
+ <p py:if="not data.get('packages')">There are no datasets currently in this group.</p>
+
+ <h3>Add datasets</h3>
+ <dl>
+ <dt><label class="field_opt" for="packages__${len(data.get('packages', []))}__name">Dataset</label></dt>
+ <dd><input class="autocomplete-dataset" id="datasets__${len(data.get('packages', []))}__name" name="packages__${len(data.get('packages', []))}__name" type="text" /></dd>
+ </dl>
+</fieldset>
+
+<div class="form-submit">
+ <input id="save" class="pretty-button primary" name="save" type="submit" value="${_('Save Changes')}" />
+ <py:if test="c.group">
+ <input id="cancel" class="pretty-button href-action" name="cancel" type="reset" value="${_('Cancel')}" action="${h.url_for(controller='group', action='read', id=c.group.name)}" />
+ </py:if>
+</div>
+</form>
+
--- /dev/null
+++ b/ckanext/example/theme/templates/home/index.html
@@ -1,1 +1,30 @@
+<html xmlns:py="http://genshi.edgewall.org/"
+ xmlns:i18n="http://genshi.edgewall.org/i18n"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ py:strip="">
+ <py:def function="page_title">Home</py:def>
+
+ <py:def function="optional_head">
+ <style type="text/css">
+ #examplething {
+ background-color: yellow;
+ padding: 10px;
+ }
+ </style>
+ </py:def>
+
+ <div py:match="content">
+ <h2>Welcome to Example Theme!</h2>
+ <p>
+ This page left intentionally ugly
+ </p>
+ <p id="examplething">
+ Here is the frob
+ </p>
+ ${select("*")}
+ </div>
+
+ <xi:include href="layout.html" />
+</html>
+
--- /dev/null
+++ b/ckanext/example/theme/templates/layout.html
@@ -1,1 +1,31 @@
+<html xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:py="http://genshi.edgewall.org/"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:doap="http://usefulinc.com/ns/doap"
+ xmlns:foaf="http://xmlns.com/foaf/0.1/"
+ py:strip=""
+ >
+<!-- ! a custom primary nav -->
+ <py:match path="//div[@class='menu']">
+ <div class="menu">
+ ${h.nav_link(c, _('Home'), controller='home', action='index')}
+ ${h.nav_link(c, _('Data'), controller='package', action='index')}
+ ${h.nav_link(c, _('New dataset'), controller='package', action='new')}
+ ${h.nav_link(c, _('New group'), controller='group', action='new')}
+ </div>
+ </py:match>
+
+<!-- make a really big search box in the top bar -->
+ <py:match path="//div[@id='top-bar']/div[@class='search-form']">
+ <div class="search-form">
+ <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="submit" class="searchbutton" value="search" />
+ </form>
+ </div>
+ </py:match>
+
+ <xi:include href="layout_base.html" />
+</html>
+
--- /dev/null
+++ b/ckanext/example/theme/templates/user/register.html
@@ -1,1 +1,50 @@
+<form id="user-edit" action="" method="post"
+ py:attrs="{'class':'has-errors'} if errors else {}"
+ xmlns:i18n="http://genshi.edgewall.org/i18n"
+ xmlns:py="http://genshi.edgewall.org/"
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+<div class="error-explanation" py:if="error_summary">
+<h2>Errors in form</h2>
+<p>The form contains invalid entries:</p>
+<ul>
+ <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)}</li>
+</ul>
+</div>
+
+ <dl>
+ <dt><label class="field_opt" for="name">Login:</label></dt>
+ <dd><input type="text" name="name" value="${data.get('name','')}" /></dd>
+ <dd class="instructions basic">3+ chars, using only 'a-z0-9' and '-_'</dd>
+ <dd class="field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd>
+
+ <dt><label class="field_opt" for="fullname">Full name:</label></dt>
+ <dd><input type="text" name="fullname" value="${data.get('fullname','')}" /></dd>
+ <dd class="field_error" py:if="errors.get('fullname', '')">${errors.get('fullname', '')}</dd>
+
+ <dt><label class="field_opt" for="email">E-Mail</label></dt>
+ <dd><input type="text" name="email" value="${data.get('email','')}" /></dd>
+
+ <dt><label class="field_opt" for="password1">Password:</label></dt>
+ <dd><input type="password" name="password1" value="" /></dd>
+ <dd class="field_error" py:if="errors.get('password1', '')">${errors.get('password1', '')}</dd>
+
+ <dt><label class="field_opt" for="password2">Password (repeat):</label></dt>
+ <dd><input type="password" name="password2" value="" /></dd>
+
+ <dd py:if="g.recaptcha_publickey">
+ <script type="text/javascript"
+ src="http://www.google.com/recaptcha/api/challenge?k=${g.recaptcha_publickey}">
+ </script>
+ <noscript>
+ <iframe src="http://www.google.com/recaptcha/api/noscript?k=${g.recaptcha_publickey}"
+ height="300" width="500" frameborder="0"></iframe><br/>
+ <textarea name="recaptcha_challenge_field" rows="3" cols="40"> </textarea>
+ <input type="hidden" name="recaptcha_response_field" value="manual_challenge" />
+ </noscript>
+ </dd>
+
+ </dl>
+ <input id="save" name="save" type="submit" class="pretty-button primary" value="Register now »" />
+</form>
+
--- a/ckanext/exampletheme/__init__.py
+++ /dev/null
@@ -1,86 +1,1 @@
-import os
-from logging import getLogger
-from genshi.filters.transform import Transformer
-
-from ckan.plugins import implements, SingletonPlugin
-from ckan.plugins import IConfigurer
-from ckan.plugins import IGenshiStreamFilter
-from ckan.plugins import IRoutes
-
-log = getLogger(__name__)
-
-
-class ExampleThemePlugin(SingletonPlugin):
- """This plugin demonstrates how a theme packaged as a CKAN
- extension might extend CKAN behaviour.
-
- In this case, we implement three extension interfaces:
-
- - ``IConfigurer`` allows us to override configuration normally
- found in the ``ini``-file. Here we use it to specify the site
- title, and to tell CKAN to look in this package for templates
- and resources that customise the core look and feel.
- - ``IGenshiStreamFilter`` allows us to filter and transform the
- HTML stream just before it is rendered. In this case we use
- it to rename "frob" to "foobar"
- - ``IRoutes`` allows us to add new URLs, or override existing
- URLs. In this example we use it to override the default
- ``/register`` behaviour with a custom controller
- """
- implements(IConfigurer, inherit=True)
- implements(IGenshiStreamFilter, inherit=True)
- implements(IRoutes, inherit=True)
-
- def update_config(self, config):
- """This IConfigurer implementation causes CKAN to look in the
- ```public``` and ```templates``` directories present in this
- package for any customisations.
-
- It also shows how to set the site title here (rather than in
- the main site .ini file), and causes CKAN to use the
- customised package form defined in ``package_form.py`` in this
- directory.
- """
- here = os.path.dirname(__file__)
- rootdir = os.path.dirname(os.path.dirname(here))
- our_public_dir = os.path.join(rootdir, 'ckanext',
- 'exampletheme', 'theme', 'public')
- template_dir = os.path.join(rootdir, 'ckanext',
- 'exampletheme', 'theme',
- 'templates')
- # set our local template and resource overrides
- config['extra_public_paths'] = ','.join([our_public_dir,
- config.get('extra_public_paths', '')])
- config['extra_template_paths'] = ','.join([template_dir,
- config.get('extra_template_paths', '')])
- # set the title
- config['ckan.site_title'] = "An example CKAN theme"
- # set the customised package form (see ``setup.py`` for entry point)
- config['package_form'] = "example_form"
-
- def filter(self, stream):
- """Conform to IGenshiStreamFilter interface.
-
- This example filter renames 'frob' to 'foobar' (this string is
- found in the custom ``home/index.html`` template provided as
- part of the package).
- """
- stream = stream | Transformer('//p[@id="examplething"]/text()')\
- .substitute(r'frob', r'foobar')
- return stream
-
- def before_map(self, map):
- """This IRoutes implementation overrides the standard
- ``/user/register`` behaviour with a custom controller. You
- might instead use it to provide a completely new page, for
- example.
-
- Note that we have also provided a custom register form
- template at ``theme/templates/user/register.html``.
- """
- map.connect('/user/register',
- controller='ckanext.exampletheme.controller:CustomUserController',
- action='custom_register')
- return map
-
--- a/ckanext/exampletheme/controller.py
+++ /dev/null
@@ -1,40 +1,1 @@
-import sys
-from ckan.lib.base import request
-from ckan.lib.base import c, g, h
-from ckan.lib.base import model
-from ckan.lib.base import render
-from ckan.lib.base import _
-from ckan.controllers.user import UserController
-
-
-class CustomUserController(UserController):
- """This controller is an example to show how you might extend or
- override core CKAN behaviour from an extension package.
-
- It duplicates functionality in the core CKAN UserController's
- register function, but extends it to make an email address
- mandatory.
- """
- def custom_register(self):
- if request.method == 'POST':
- # custom validation that requires an email address
- error = False
- c.email = request.params.getone('email')
- c.login = request.params.getone('login')
- if not model.User.check_name_available(c.login):
- error = True
- h.flash_error(_("That username is not available."))
- if not c.email:
- error = True
- h.flash_error(_("You must supply an email address."))
- try:
- self._get_form_password()
- except ValueError, ve:
- h.flash_error(ve)
- error = True
- if error:
- return render('user/register.html')
- # now delegate to core CKAN register method
- return self.register()
-
--- a/ckanext/exampletheme/package_form.py
+++ /dev/null
@@ -1,40 +1,1 @@
-from sqlalchemy.util import OrderedDict
-from pylons.i18n import _
-from ckan.forms import common
-from ckan.forms import package
-
-
-# Setup the fieldset
-def build_example_form(is_admin=False,
- user_editable_groups=None,
- **kwargs):
- """Customise the core CKAN dataset editing form by adding a new
- field "temporal coverage", and changing the layout of the core
- fields.
- """
- # Restrict fields
- builder = package.build_package_form(
- user_editable_groups=user_editable_groups)
-
- # Extra fields
- builder.add_field(common.DateRangeExtraField('temporal_coverage'))
-
- # Layout
- field_groups = OrderedDict([
- (_('Basic information'), ['title', 'name', 'url',
- 'notes', 'tags']),
- (_('Details'), ['author', 'author_email', 'groups',
- 'maintainer', 'maintainer_email',
- 'license_id', 'temporal_coverage' ]),
- (_('Resources'), ['resources']),
- ])
- builder.set_displayed_fields(field_groups)
- return builder
-
-
-def get_example_fieldset(is_admin=False, user_editable_groups=None, **kwargs):
- return build_example_form(is_admin=is_admin,
- user_editable_groups=user_editable_groups,
- **kwargs).get_fieldset()
-
--- a/ckanext/exampletheme/theme/public/css/extra.css
+++ /dev/null
@@ -1,5 +1,1 @@
-body {
- background-color: pink;
-}
-
--- a/ckanext/exampletheme/theme/templates/home/index.html
+++ /dev/null
@@ -1,29 +1,1 @@
-<html xmlns:py="http://genshi.edgewall.org/"
- xmlns:i18n="http://genshi.edgewall.org/i18n"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- py:strip="">
- <py:def function="page_title">Home</py:def>
-
- <py:def function="optional_head">
- <style type="text/css">
- #examplething {
- background-color: yellow;
- padding: 10px;
- }
- </style>
- </py:def>
-
- <div py:match="content">
- <h2>Welcome to Example Theme!</h2>
- <p>
- This page left intentionally ugly
- </p>
- <p id="examplething">
- Here is the frob
- </p>
- </div>
-
- <xi:include href="layout.html" />
-</html>
-
--- a/ckanext/exampletheme/theme/templates/layout.html
+++ /dev/null
@@ -1,33 +1,1 @@
-<html xmlns="http://www.w3.org/1999/xhtml"
- xmlns:py="http://genshi.edgewall.org/"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:doap="http://usefulinc.com/ns/doap"
- xmlns:foaf="http://xmlns.com/foaf/0.1/"
- py:strip=""
- >
-<!-- ! a custom primary nav -->
- <py:match path="//div[@class='menu']">
- <div class="menu">
- <ul>
- <li>${h.nav_link(c, _('Home'), controller='home', action='index', id=None)}
- </li>
- <li>${h.nav_link(c, _('Data'), controller='package', action='index', id=None)}
- </li>
- </ul>
- </div>
- </py:match>
-
-<!-- make a really big search box in the top bar -->
- <py:match path="//div[@id='top-bar']/div[@class='search-form']">
- <div class="search-form">
- <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="submit" class="searchbutton" value="search" />
- </form>
- </div>
- </py:match>
-
- <xi:include href="layout_base.html" />
-</html>
-
--- a/ckanext/exampletheme/theme/templates/user/register.html
+++ /dev/null
@@ -1,49 +1,1 @@
-<html xmlns:py="http://genshi.edgewall.org/"
- xmlns:i18n="http://genshi.edgewall.org/i18n"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- py:strip="">
-
- <py:match path="primarysidebar">
- <li class="widget-container widget_text">
- <h2>Have an OpenID?</h2>
- <p>
- If you have an account with Google, Yahoo or one of many other
- OpenID providers, you can log in without signing up.
- </p>
- <ul>
- <li>${h.link_to(_('Log in now'), h.url_for(conroller='user', action='login'))}</li>
- </ul>
- </li>
- </py:match>
-
- <py:def function="page_title">Register - User</py:def>
- <div py:match="content">
- <h2>Join the community</h2>
-
- <form action="/user/register" method="post" class="simple-form" id="register_form">
- <fieldset>
- <legend i18n:msg="site_title">Register with CKAN</legend>
-
- <label for="login">Login:</label>
- <input name="login" value="${c.login}" />
- <br/>
- <label for="fullname">Full name (optional):</label>
- <input name="fullname" value="${c.fullname}" />
- <br/>
- <label for="email">E-Mail:</label>
- <input name="email" value="${c.email}" />
- <br/>
- <label for="password1">Password:</label>
- <input type="password" name="password1" value="" />
- <br/>
- <label for="password2">Password (repeat):</label>
- <input type="password" name="password2" value="" />
- <br/>
- </fieldset>
- ${h.submit('s', _('Sign up'))}
- </form>
- </div>
- <xi:include href="layout.html" />
-</html>
-
--- a/rename.sh
+++ b/rename.sh
@@ -6,8 +6,9 @@
NEWNAME=$1
NEWNAME_LOWER="`echo $NEWNAME | awk '{print tolower($0)}'`"
echo $NEWNAME_LOWER
-mv ckanext/exampletheme ckanext/$NEWNAME_LOWER
-grep -rl ExampleTheme * | grep -v `basename $0` | xargs perl -pi -e "s/ExampleTheme/$NEWNAME/g"
-grep -rl exampletheme * | grep -v `basename $0` | xargs perl -pi -e "s/exampletheme/$NEWNAME_LOWER/g"
+mv ckanext/example ckanext/$NEWNAME_LOWER
+grep -rl Example * | grep -v `basename $0` | xargs perl -pi -e "s/Example/$NEWNAME/g"
+grep -rl example * | grep -v `basename $0` | xargs perl -pi -e "s/example/$NEWNAME_LOWER/g"
cd ..
-mv ckanext-exampletheme ckanext-$NEWNAME_LOWER
+mv ckanext-example ckanext-$NEWNAME_LOWER
+
--- a/setup.py
+++ b/setup.py
@@ -1,14 +1,12 @@
from setuptools import setup, find_packages
-import sys, os
-version = '0.1'
+version = '0.2'
setup(
- name='ckanext-exampletheme',
+ name='ckanext-example',
version=version,
- description="Example themeb for customising CKAN",
- long_description="""\
- """,
+ description='Example extension for customising CKAN',
+ long_description='',
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='',
author='Seb Bacon',
@@ -16,7 +14,7 @@
url='',
license='',
packages=find_packages(exclude=['ez_setup', 'examples', 'tests']),
- namespace_packages=['ckanext', 'ckanext.exampletheme'],
+ namespace_packages=['ckanext', 'ckanext.example'],
include_package_data=True,
zip_safe=False,
install_requires=[
@@ -25,10 +23,12 @@
entry_points=\
"""
[ckan.plugins]
- exampletheme=ckanext.exampletheme:ExampleThemePlugin
+ example=ckanext.example.plugin:ExamplePlugin
+ example_datasetform=ckanext.example.forms:ExampleDatasetForm
+ example_groupform=ckanext.example.forms:ExampleGroupForm
[ckan.forms]
- example_form = ckanext.exampletheme.package_form:get_example_fieldset
+ example_form = ckanext.example.package_form:get_example_fieldset
""",
)