From: Alex Sadleir Date: Tue, 10 Sep 2013 01:16:08 +0000 Subject: Add meta tags on html output for package/resource X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=0855a1f076db81a64946945a00ab7a200eeaed38 --- Add meta tags on html output for package/resource --- --- /dev/null +++ b/.idea/.name @@ -1,1 +1,1 @@ - +ckanext-datagovau --- /dev/null +++ b/.idea/compiler.xml @@ -1,1 +1,24 @@ + + + + + + --- /dev/null +++ b/.idea/encodings.xml @@ -1,1 +1,6 @@ + + + + + --- /dev/null +++ b/.idea/misc.xml @@ -1,1 +1,23 @@ + + + + + + + + + + + + + + + + + + --- /dev/null +++ b/.idea/modules.xml @@ -1,1 +1,10 @@ + + + + + + + + + --- /dev/null +++ b/.idea/other.xml @@ -1,1 +1,8 @@ + + + + + + --- /dev/null +++ b/.idea/scopes/scope_settings.xml @@ -1,1 +1,5 @@ - + + + + --- /dev/null +++ b/.idea/testrunner.xml @@ -1,1 +1,9 @@ + + + + + + --- /dev/null +++ b/.idea/vcs.xml @@ -1,1 +1,8 @@ + + + + + + + --- /dev/null +++ b/.idea/workspace.xml @@ -1,1 +1,692 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + localhost + 5050 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + --- a/README.rst +++ b/README.rst @@ -1,80 +1,27 @@ -This CKAN Extension demonstrates some common patterns for customising a CKAN instance. +This CKAN Extension customises a CKAN instance for the hosting of data.gov.au. It comprises: -* A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when +* A CKAN Extension "plugin" at ``ckanext/datagovau/plugin.py`` which, when loaded, overrides various settings in the core ``ini``-file to provide: + * A path to local customisations of the core templates + * A custom Package edit form that defaults to cc-by licence + * A custom n3/rdf output format - * 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 +* A cut down licenses.json file 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 + pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau -Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file. +Then activate it by setting ``ckan.plugins = datagovau`` 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 - -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 - -This data can be removed with - -:: - - paster example clean -c +To add the cut down licenses.json set ``licenses_group_url = http://%(ckan.site_url)/licenses.json`` +or copy ``ckanext/datagovau/theme/public/licenses.json`` to the same folder as your CKAN config ini file +and set ``licenses_group_url = file://%(here)s/licenses.json`` + --- /dev/null +++ b/ckanext-datagovau.iml @@ -1,1 +1,13 @@ + + + + + + + + + + + + --- /dev/null +++ b/ckanext/datagovau/__init__.py --- /dev/null +++ b/ckanext/datagovau/plugin.py @@ -1,1 +1,164 @@ +import logging +import ckan.plugins as plugins +import ckan.plugins.toolkit as tk + + +# get_action will be deprecated soon, this is the replacement +def get_user(user): + user_name = unicode(user) + if user_name: + user_obj = model.User.get(id) + context['user_obj'] = user_obj + if user_obj is None: + raise NotFound + else: + raise NotFound + + return model_dictize.user_dictize(user_obj,context) + + +class ExampleIDatasetFormPlugin(plugins.SingletonPlugin, + tk.DefaultDatasetForm): + '''An example IDatasetForm CKAN plugin. + + Uses a tag vocabulary to add a custom metadata field to datasets. + + ''' + plugins.implements(plugins.IConfigurer, inherit=False) + plugins.implements(plugins.IDatasetForm, inherit=False) + plugins.implements(plugins.ITemplateHelpers, inherit=False) + + # These record how many times methods that this plugin's methods are + # called, for testing purposes. + num_times_new_template_called = 0 + num_times_read_template_called = 0 + num_times_edit_template_called = 0 + num_times_search_template_called = 0 + num_times_history_template_called = 0 + num_times_package_form_called = 0 + num_times_check_data_dict_called = 0 + num_times_setup_template_variables_called = 0 + + + def update_config(self, config): + # Add this plugin's templates dir to CKAN's extra_template_paths, so + # that CKAN will use this plugin's custom templates. + # here = os.path.dirname(__file__) + # rootdir = os.path.dirname(os.path.dirname(here)) + + tk.add_template_directory(config, 'templates') + tk.add_public_directory(config, 'theme/public') + tk.add_resource('theme/public', 'ckanext-datagovau') + # config['licenses_group_url'] = 'http://%(ckan.site_url)/licenses.json' + + def get_helpers(self): + return {'getuser': get_user} + + def is_fallback(self): + # Return True to register this plugin as the default handler for + # package types not handled by any other IDatasetForm plugin. + return True + + def package_types(self): + # This plugin doesn't handle any special package types, it just + # registers itself as the default (above). + return [] + + + def create_package_schema(self): + schema = super(ExampleIDatasetFormPlugin, self).create_package_schema() + schema = self._modify_package_schema(schema) + return schema + + def update_package_schema(self): + schema = super(ExampleIDatasetFormPlugin, self).update_package_schema() + schema = self._modify_package_schema(schema) + return schema + + def show_package_schema(self): + schema = super(ExampleIDatasetFormPlugin, self).show_package_schema() + + # Don't show vocab tags mixed in with normal 'free' tags + # (e.g. on dataset pages, or on the search page) + schema['tags']['__extras'].append(tk.get_converter('free_tags_only')) + + # Add our custom_text field to the dataset schema. + # ignore_missing == optional + # ignore_empty == mandatory but not for viewing + # !!! always convert_from_extras first + schema.update({ + 'agency_program': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_missing')], + 'contact_point': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'spatial_coverage': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'granularity': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'jurisdiction': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'temporal_coverage': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'data_state': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'update_freq': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')] + }) + return schema + + def _modify_package_schema(self, schema): + # Add our custom_test metadata field to the schema, this one will use + # convert_to_extras instead of convert_to_tags. + # ignore_missing == optional + # not_empty == mandatory, enforced here while modifying + + schema.update({ + 'agency_program': [tk.get_validator('ignore_missing'), + tk.get_converter('convert_to_extras')], + 'contact_point': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'spatial_coverage': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'granularity': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'jurisdiction': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'temporal_coverage': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'data_state': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'update_freq': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')] + }) + return schema + + # These methods just record how many times they're called, for testing + # purposes. + # TODO: It might be better to test that custom templates returned by + # these methods are actually used, not just that the methods get + # called. + + def setup_template_variables(self, context, data_dict): + return super(ExampleIDatasetFormPlugin, self).setup_template_variables( + context, data_dict) + + def new_template(self): + return super(ExampleIDatasetFormPlugin, self).new_template() + + def read_template(self): + return super(ExampleIDatasetFormPlugin, self).read_template() + + def edit_template(self): + return super(ExampleIDatasetFormPlugin, self).edit_template() + + def search_template(self): + return super(ExampleIDatasetFormPlugin, self).search_template() + + def history_template(self): + return super(ExampleIDatasetFormPlugin, self).history_template() + + def package_form(self): + return super(ExampleIDatasetFormPlugin, self).package_form() + + --- /dev/null +++ b/ckanext/datagovau/templates/package/read.html @@ -1,1 +1,160 @@ +{% ckan_extends %} +{% block package_additional_info %} +
+

{{ _('Additional Info') }}

+ + + + + + + + + + + {# Add our custom field to the dataset read page. #} + {% if pkg.get('metadata_created') %} + + + + + {% endif %} + {% if pkg.get('metadata_updated') %} + + + + + {% endif %} + {% if pkg.get('agency_program') %} + + + + + {% endif %} + {% if pkg.get('Agency Program') %} + + + + + {% endif %} + {% if pkg.get('DCTERMS.Source.URI') %} + + + + + {% endif %} + + {% if pkg.get('contact_point') %} + + + + + {% endif %} + {% if pkg.get('spatial_coverage') %} + + + + + + {% endif %} + {% if pkg.get('Geospatial Coverage') %} + + + + + + {% endif %} + {% if pkg.get('granularity') %} + + + + + + {% endif %} + {% if pkg.get('Granularity') %} + + + + + + {% endif %} + {% if pkg.get('jurisdiction') %} + + + + + + {% endif %} + {% if pkg.get('AGLSTERMS.Jurisdiction') %} + + + + + + {% endif %} + {% if pkg.get('temporal_coverage') %} + + + + + + {% endif %} + {% if pkg.get('Temporal Coverage') %} + + + + + + {% endif %} + {% if pkg.get('data_state') %} + + + + + + {% endif %} + {% if pkg.get('update_freq') %} + + + + + + {% endif %} + {% if pkg.get('Update Frequency') %} + + + + + {% endif %} + + {% if pkg.maintainer_email %} + + + + + {% elif pkg.maintainer %} + + + + + {% endif %} + + +
{{ _('Field') }}{{ _('Value') }}
Date Published{{ pkg.metadata_created.split("T")[0] }}
Date Updated{{ pkg.metadata_updated.split("T")[0] }}
Agency Program {{ pkg.agency_program }}
Agency Program {{ pkg.get('Agency Program') }}
{{ _('Source') }}{{ h.link_to(pkg.get('DCTERMS.Source.URI'), + pkg.get('DCTERMS.Source.URI'), rel='dct:source', target='_blank') }} +
Contact Point {{ h.mail_to(email_address=pkg.contact_point, + name=pkg.contact_point) }}
Geospatial Coverage {{ pkg.spatial_coverage }}
Geospatial Coverage {{ pkg.get('Geospatial Coverage') }}
Data Granularity {{ pkg.granularity }}
Data Granularity {{ pkg.get('Granularity') }}
Government Jurisdiction {{ pkg.jurisdiction }}
Government Jurisdiction {{ pkg.get('AGLSTERMS.Jurisdiction') }}
Temporal Coverage {{ pkg.temporal_coverage }}
Temporal Coverage {{ pkg.get('Temporal Coverage') }}
Data State {{ pkg.data_state }}
Update Frequency {{ pkg.update_freq }}
Update Frequency {{ pkg.get('Update Frequency') }}
{{ _('Maintainer') }}{{ + h.mail_to(email_address=pkg.maintainer_email, name=pkg.maintainer) }} +
{{ _('Maintainer') }}{{ pkg.maintainer }}
+
+ + +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/package/read.n3 @@ -1,1 +1,45 @@ +@prefix : . +@prefix dcat: . +@prefix dct: . +@prefix foaf: . +@prefix owl: . +@prefix rdf: . +<${ h.url_for(controller='package',action='read',id=c.pkg_dict['name'], qualified=True)}> +a dcat:Dataset; + dct:description "${c.pkg_dict['notes']}"; + dct:identifier "${c.pkg_dict['name']}"; + dct:relation [ + rdf:value ""; + :label "change_note" ], + [ + rdf:value ""; + :label "definition_note" ], + [ + rdf:value ""; + :label "editorial_note" ], + [ + rdf:value ""; + :label "example_note" ], + [ + rdf:value ""; + :label "history_note" ], + [ + rdf:value ""; + :label "scope_note" ], + [ + rdf:value ""; + :label "skos_note" ], + [ + rdf:value ""; + :label "temporal_granularity" ], + [ + rdf:value ""; + :label "type_of_dataset" ], + [ + rdf:value ""; + :label "update_frequency" ]; + dct:title "${c.pkg_dict['title']}"; + :label "${c.pkg_dict['name']}"; + = ; + foaf:homepage . --- /dev/null +++ b/ckanext/datagovau/templates/package/read.rdf @@ -1,1 +1,149 @@ + + + + ${c.pkg_dict['name']} + ${c.pkg_dict['title']} + + + Dataset + ${c.pkg_dict['notes']} + ${c.pkg_dict['metadata_created']} + ${c.pkg_dict['metadata_modified']} + en + ${c.pkg_dict['license_url']} + + ${ tag_dict["name"] } + + + ${ group_dict["title"] } + + + ${c.pkg_dict['name']} + + + + + + ${rsc_dict.get('name')} + + ${rsc_dict.get('description')} + + ${rsc_dict.get('created')} + ${rsc_dict.get('revision_timestamp')} + ${rsc_dict.get('size')} + ${rsc_dict.get('mimetype')} + ${rsc_dict.get('size')} bytes + + + ${rsc_dict.get('format')} + ${rsc_dict.get('format')} + + + ${rsc_dict.get('name')} + + + + + + ${ c.pkg_dict['organization']['title'] } + + + + + ${ c.pkg_dict['organization']['title'] } +