Implementation of an IGroupForm
--- a/ckanext/example/forms.py
+++ b/ckanext/example/forms.py
@@ -28,7 +28,55 @@
log = logging.getLogger(__name__)
-
+class ExampleGroupForm(SingletonPlugin):
+ """This plugin demonstrates how a theme packaged as a CKAN
+ extension might extend CKAN behaviour.
+
+ In this case, we implement twos extension interfaces to provide custom
+ forms for specific types of group.
+
+ - ``IConfigurer`` allows us to override configuration normally
+ found in the ``ini``-file. Here we use it to specify where the
+ form templates can be found.
+ - ``IGroupForm`` allows us to provide a custom form for a dataset
+ based on the 'type' that may be set for a group. Where the
+ 'type' matches one of the values in group_types then this
+ class will be used.
+ """
+ implements(IGroupForm, inherit=True)
+ implements(IConfigurer, inherit=True)
+
+ def update_config(self, config):
+ """
+ This IConfigurer implementation causes CKAN to look in the
+ ```templates``` directory when looking for the group_form()
+ """
+ here = os.path.dirname(__file__)
+ rootdir = os.path.dirname(os.path.dirname(here))
+ template_dir = os.path.join(rootdir, 'ckanext',
+ 'example', 'theme', 'templates')
+ config['extra_template_paths'] = ','.join([template_dir,
+ config.get('extra_template_paths', '')])
+
+ def group_form(self):
+ """
+ Returns a string representing the location of the template to be
+ rendered. e.g. "forms/group_form.html".
+ """
+ return 'forms/group_form.html'
+
+ def is_fallback(self):
+ """
+ Returns true iff this provides the fallback behaviour, when no other
+ plugin instance matches a group's type.
+
+ As this is not the fallback controller we should return False. If
+ we were wanting to act as the fallback, we'd return True
+ """
+ return False
+
+
+
class ExampleDatasetForm(SingletonPlugin):
"""This plugin demonstrates how a theme packaged as a CKAN
--- /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">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>
+
--- a/setup.py
+++ b/setup.py
@@ -27,6 +27,7 @@
[ckan.plugins]
example=ckanext.example.plugin:ExamplePlugin
example_datasetform=ckanext.example.forms:ExampleDatasetForm
+ example_groupform=ckanext.example.forms:ExampleGroupForm
[ckan.forms]
example_form = ckanext.example.package_form:get_example_fieldset