From: David Read Date: Tue, 28 Jun 2011 12:01:16 +0000 Subject: [form]: Get form working with CKAN 1.4.1 (formalchemy deprecated). X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=5ba6ef97b6e2d660c1409a327798f5d4ab76c4d7 --- [form]: Get form working with CKAN 1.4.1 (formalchemy deprecated). --- --- a/README.txt +++ b/README.txt @@ -2,7 +2,7 @@ It comprises: - * A CKAN Extension "plugin" at ``ckanext/exampletheme/__init__.py`` + * A CKAN Extension "plugin" at ``ckanext/exampletheme/plugin.py`` which, when loaded, overrides various settings in the core ``ini``-file to provide: @@ -16,4 +16,42 @@ * 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/plugin.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 + --- a/ckanext/exampletheme/__init__.py +++ b/ckanext/exampletheme/__init__.py @@ -1,86 +1,2 @@ -import os -from logging import getLogger +# package -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"]')\ - .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/package_form.py +++ b/ckanext/exampletheme/package_form.py @@ -22,7 +22,7 @@ # Layout field_groups = OrderedDict([ - (_('Basic information'), ['title', 'name', 'url', + (_('Customised Basic information'), ['title', 'name', 'url', 'notes', 'tags']), (_('Details'), ['author', 'author_email', 'groups', 'maintainer', 'maintainer_email', --- /dev/null +++ b/ckanext/exampletheme/plugin.py @@ -1,1 +1,93 @@ +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``. + """ + # Note that when we set up the route, we must use the form + # that gives it a name (i.e. in this case, 'register'), so it + # works correctly with the url_for helper:: + # h.url_for('register') + map.connect('register', + '/user/register', + controller='ckanext.exampletheme.controller:CustomUserController', + action='custom_register') + map.connect('/package/new', controller='package_formalchemy', action='new') + map.connect('/package/edit/{id}', controller='package_formalchemy', action='edit') + return map + --- a/ckanext/exampletheme/theme/templates/home/index.html +++ b/ckanext/exampletheme/theme/templates/home/index.html @@ -16,8 +16,11 @@

Welcome to Example Theme!

+

+ This page left intentionally ugly +

- This page left intentionally ugly + Here is the frob

--- /dev/null +++ b/rename.sh @@ -1,1 +1,13 @@ +if [ $# -ne 1 ]; then + echo "Usage: `basename $0` {NewExtensionName}" + exit 65 +fi +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" +cd .. +mv ckanext-exampletheme ckanext-$NEWNAME_LOWER --- a/setup.py +++ b/setup.py @@ -25,7 +25,7 @@ entry_points=\ """ [ckan.plugins] - datagm=ckanext.exampletheme:ExampleThemePlugin + exampletheme=ckanext.exampletheme.plugin:ExampleThemePlugin [ckan.forms] example_form = ckanext.exampletheme.package_form:get_example_fieldset