Extension Eurovoc


Extension Basics

Title
Eurovoc
Name
ckanext-eurovoc
Type
Public extension
Description
Add top-level Eurovoc categories to CKAN's dataset schema for search and filtering, supporting EU vocabulary standards.
CKAN versions
Download-Url (zip)
Last commit
10 years ago (2015-06-15 16:52:26)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

ckanext-eurovoc

Add top-level Eurovoc categories to CKAN for search and filtering.

Eurovoc is the EU’s multilingual thesaurus. This extension adds Eurovoc category support to CKAN datasets with faceted search capabilities.

Requirements

Compatible with CKAN 2.2 and 2.3.

Installation

To install ckanext-eurovoc:

  1. Activate your CKAN virtual environment:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-eurovoc Python package:

    pip install ckanext-eurovoc
    
  3. Add eurovoc to the ckan.plugins setting in your CKAN config file.

  4. Restart CKAN.

Configuration

The Eurovoc plugin doesn’t automatically change CKAN templates or add a Eurovoc category field to your dataset schema. You need to modify the dataset schema in your own extension and add form widgets to the appropriate templates.

Alternatively, add the optional eurovoc_dataset plugin to integrate the Eurovoc category field into your schema and templates.

ckanext.eurovoc.categories

The display language for Eurovoc category labels is defined in category configuration files:

ckanext.eurovoc.categories = categories_se.json  # sweden

If no categories file is defined, categories_en.json is used.

If the category file is changed, rebuild the solr search index:

paster search-index rebuild

ckanext.eurovoc.category_field_name

Customise the dataset schema field name for storing eurovoc category values:

ckanext.eurovoc.category_field_name = theme

The default value is eurovoc_category.

Search Facet

The Eurovoc plugin adds a faceted search option to dataset, group and organization search pages. Customize using eurovoc_category_label entry via IFacets interface.

License

AGPL-3.0 license

Available on PyPI as ckanext-eurovoc.

Version
0.0.4
Version release date
2015-06-15
Contact name
CKAN
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Add ‘eurovoc’ to ckan.plugins. Optionally add ‘eurovoc_dataset’ for automatic schema integration. Configure category language file and field name. Available on PyPI.

Plugins to configure (ckan.ini)
eurovoc eurovoc_dataset
CKAN Settings (ckan.ini)
# ckanext.eurovoc.categories = categories_en.json
# ckanext.eurovoc.category_field_name = eurovoc_category
DB migration to be executed
(not set)
<< back to Extensions