Extension Discovery


Extension Basics

Title
Discovery
Name
ckanext-discovery
Type
Public extension
Description
A CKAN extension to help people discover your datasets through enhanced search capabilities and recommendations.
CKAN versions
Download-Url (zip)
Download-Url commit date
2017-03-20
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

A CKAN extension to help people discover your datasets

Open data can only be used for awesome things if it is found. CKAN has powerful built-in search tools, but for users who don’t know (yet) what exactly they are looking for there is room for improvement.

This extension provides multiple plugins that make it easier for your users to discover your data:

• search_suggestions: Provides real-time search suggestions in a drop-down box • similar_datasets: Adds a list of similar datasets to the dataset detail view • solr_query_config: Allows you to easily override the parameters that CKAN passes to Solr • tag_cloud: Replaces the list of frequent tags on the home page with a tag cloud that shows the most popular tags scaled according to their popularity

The extension has been developed and tested with CKAN 2.6. It provides modular functionality through separate plugins that can be enabled independently based on specific needs.

Installation requires database initialization and Solr configuration for full functionality. The similar_datasets plugin requires Solr’s More Like This handler to be configured properly.

Configuration involves enabling desired plugins in ckan.ini, creating database tables with paster commands, and configuring Solr appropriately for advanced features like similar dataset recommendations.

Version
0.1.1
Version release date
2017-03-20
Contact name
Stadt Karlsruhe
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

The extension provides multiple plugins (discovery, search_suggestions, similar_datasets, solr_query_config, tag_cloud) that can be enabled independently. The discovery plugin is required as base infrastructure. Database tables must be created with paster commands. Similar datasets functionality requires Solr More-Like-This handler configuration. WARNING: Known compatibility issues with CKAN 2.8+ (see GitHub issue #1). Works with CKAN 2.6 and 2.7 only.

Plugins to configure (ckan.ini)
discovery search_suggestions similar_datasets solr_query_config tag_cloud
CKAN Settings (ckan.ini)
# Maximum number of search suggestions to display in the drop-down box # ckanext.discovery.search_suggestions.limit = 4 # Whether data about search queries should be stored # ckanext.discovery.search_suggestions.store_queries = True # Whether search suggestions should be displayed # ckanext.discovery.search_suggestions.provide_suggestions = True # Maximum number of similar datasets to list # ckanext.discovery.similar_datasets.max_num = 5 # Default Solr sort parameter # ckanext.discovery.solr_query_config.default.sort = metadata_modified asc # Force specific Solr query handler # ckanext.discovery.solr_query_config.force.defType = my_special_query_handler # Number of tags to show in the tag cloud # ckanext.discovery.tag_cloud.num_tags = 20
DB migration to be executed
(not set)
<< back to Extensions