These CKAN Versions are exactely matched:

• 2.5.0
• 2.5.1
• 2.5.2
• 2.5.3
• 2.5.4
• 2.5.5
• 2.5.6
• 2.5.7
• 2.5.8
• 2.5.9
• 2.6.0
• 2.6.1
• 2.6.2
• 2.6.3
• 2.6.4
• 2.6.5
• 2.6.6
• 2.6.7
• 2.6.8
• 2.6.9
• 2.7.0
• 2.7.1
• 2.7.10
• 2.7.11
• 2.7.12
• 2.7.2
• 2.7.3
• 2.7.4
• 2.7.5
• 2.7.6
• 2.7.7
• 2.7.8
• 2.7.9
• 2.8.0
• 2.8.1
• 2.8.10
• 2.8.11
• 2.8.12
• 2.8.2
• 2.8.3
• 2.8.4
• 2.8.5
• 2.8.6
• 2.8.7
• 2.8.8
• 2.8.9
• 2.9.0
• 2.9.1
• 2.9.10
• 2.9.11
• 2.9.2
• 2.9.3
• 2.9.4
• 2.9.5
• 2.9.6
• 2.9.7
• 2.9.8
• 2.9.9
• 2.10.0
• 2.10.1
• 2.10.2
• 2.10.3
• 2.10.4
• 2.10.5
• 2.10.6
• 2.10.7
• 2.10.8
• 2.11.0
• 2.11.1
• 2.11.2
• 2.11.3

ckanext-citehelp

A CKAN extension that helps people cite your datasets correctly

Overview

Many licenses used for open data require some kind of attribution when the data is used. However, users often don’t know how exactly that should be done.

This extension gives users ready-to-use attribution texts that they can simply copy and paste. The texts are automatically adapted to the dataset, its license and the publishing organization.

Attribution Text

This is the default attribution text, shown on dataset and resource pages:

Dataset "Awesome Weather Data", Funky Weather Team (https://funky-weather.org).
Published under the license "Great Weather License" (https://weather-license.com).
See https://my-ckan-instance.com/dataset/65571194-1b1a-4ce1-b169-15942647208c.

In addition to the plain text, a HTML variant is shown which uses links instead of listing the URLs verbatim.

Key Features

• Automatic Attribution Generation: Creates ready-to-use citation texts for datasets and resources
• License Integration: Automatically includes license information in citations
• Organization Support: Includes publishing organization details with customizable URLs
• Multiple Formats: Provides both plain text and HTML formatted citations
• Template Customization: Easy to customize through template overrides
• Translation Support: Fully translatable using CKAN’s translation infrastructure
• Dataset Adaptation: Automatically adapts citation text to current dataset, license, and organization
• Custom Organization URLs: Organizations can provide custom URLs via extras field

Customization

There are multiple ways to customize the attribution text:

1. Template Override: Override blocks in ckanext-citehelp/snippets/citehelp.html, particularly citehelp_template_text and citehelp_template_html
2. Custom Translations: Provide custom translations using CKAN’s translation infrastructure

Both plain text and HTML text are marked as translatable and can be customized per language.

Technical Details

• The dataset title, organization name/URL, license title/URL are automatically adapted
• Organizations can provide custom URLs in an extra field named url
• Falls back to CKAN organization page if no custom URL is provided
• Integrates seamlessly with CKAN’s template system

License

Copyright © 2025 Stadt Karlsruhe. Distributed under the GNU Affero General Public License (AGPL-3.0).