From: Ian Murray Date: Thu, 24 Nov 2011 13:44:54 +0000 Subject: [docs] Updated documentation to reflect change to the User form X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=36c3058c19d34a8505f267f81d5b59bd55b8fc69 --- [docs] Updated documentation to reflect change to the User form --- --- /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,56 @@ +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 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. + + --- 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/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 - - * 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 - --- /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/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,100 @@ +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', '') +\ + ' ' + # 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/home/index.html @@ -1,1 +1,29 @@ + + Home + + + + + +
+

Welcome to Example Theme!

+

+ This page left intentionally ugly +

+

+ Here is the frob +

+
+ + + + --- /dev/null +++ b/ckanext/example/theme/templates/layout.html @@ -1,1 +1,30 @@ + + + +
+ ${h.nav_link(c, _('Home'), controller='home', action='index', id=None)} + ${h.nav_link(c, _('Data'), controller='package', action='index', id=None)} + ${h.nav_link(c, _('New dataset'), controller='package', action='new', id=None)} +
+ + + + +
+
+ + +
+
+ + + + + --- /dev/null +++ b/ckanext/example/theme/templates/user/register.html @@ -1,1 +1,50 @@ +
+
+

Errors in form

+

The form contains invalid entries:

+
    +
  • ${"%s: %s" % (key, error)}
    • +
+
+ +
+
+
+
3+ chars, using only 'a-z0-9' and '-_'
+
${errors.get('name', '')}
+ +
+
+
${errors.get('fullname', '')}
+ +
+
+ +
+
+
${errors.get('password1', '')}
+ +
+
+ +
+ + +
+ +
+ +
+ --- a/ckanext/exampletheme/__init__.py +++ /dev/null @@ -1,2 +1,1 @@ -# package --- 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/plugin.py +++ /dev/null @@ -1,91 +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``. - """ - # 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') - return map - --- 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 @@ - - Home - - - - - -
-

Welcome to Example Theme!

-

- This page left intentionally ugly -

-

- Here is the frob -

-
- - - - --- a/ckanext/exampletheme/theme/templates/layout.html +++ /dev/null @@ -1,33 +1,1 @@ - - - -
-
    -
  • ${h.nav_link(c, _('Home'), controller='home', action='index', id=None)} -
    • -
  • ${h.nav_link(c, _('Data'), controller='package', action='index', id=None)} -
    • -
-
- - - - -
-
- - -
-
- - - - - --- a/ckanext/exampletheme/theme/templates/user/register.html +++ /dev/null @@ -1,49 +1,1 @@ - - - -
  • -

    Have an OpenID?

    -

    - If you have an account with Google, Yahoo or one of many other - OpenID providers, you can log in without signing up. -

    -
      -
    • ${h.link_to(_('Log in now'), h.url_for(conroller='user', action='login'))}
      • -
    -
    • -     - - Register - User -
    -

    Join the community

    - -
    -
    - Register with CKAN - - - -
    - - -
    - - -
    - - -
    - - -
    -
    - ${h.submit('s', _('Sign up'))} -
    -
    - - - --- 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 @@ -4,9 +4,9 @@ version = '0.1' setup( - name='ckanext-exampletheme', + name='ckanext-example', version=version, - description="Example themeb for customising CKAN", + description="Example extension for customising CKAN", long_description="""\ """, classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers @@ -16,7 +16,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 +25,10 @@ entry_points=\ """ [ckan.plugins] - exampletheme=ckanext.exampletheme.plugin:ExampleThemePlugin + example=ckanext.example.plugin:ExamplePlugin [ckan.forms] - example_form = ckanext.exampletheme.package_form:get_example_fieldset + example_form = ckanext.example.package_form:get_example_fieldset """, )