Extension ckanext-citeproc


Extension Basics

Title
ckanext-citeproc
Name
ckanext-citeproc
Type
Public extension
Description
CKAN plugin to add citations to datasets and resources. This plugin uses https://github.com/citeproc-py/citeproc-py to generate citations in different formats.
CKAN versions

~2.10,~2.11

Show details
Download-Url (zip)
https://github.com/unckan/ckanext-citeproc
Last commit
7 months ago (2025-05-27 16:21:23)
Url to repo
https://github.com/unckan/ckanext-citeproc
Category
(not set)


Background Infos

Description (long)
Show details

CKAN plugin to add citations to datasets and resources. This plugin uses https://github.com/citeproc-py/citeproc-py to generate citations in different formats.

Prerequisites

citeproc-py currently only contains harvard1.csl for the styles. To allow for more styles, you will need to put any desired CSL files from https://github.com/citation-style-language/styles onto your server and define the citeproc style path with ckanext.citeproc.citation_styles_path in your CKAN INI file. The available citation formats will be built from any CSL files in this directory.

Version
v1.0.1
Version release date
2025-05-27
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

To install ckanext-citeproc:

Activate your CKAN virtual environment, for example:

. /usr/lib/ckan/default/bin/activate

Clone the source and install it on the virtualenv:

git clone https://github.com/open-data/ckanext-citeproc.git cd ckanext-citeproc pip install -e . pip install -r requirements.txt

Add citeproc to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

sudo service apache2 reload
Plugins to configure (ckan.ini)
citeproc
CKAN Settings (ckan.ini) 
# ckanext.citeproc.citation_styles_path specifies the absolute path on the server to the directory containing the CSL files:
# (required, default: None).
ckanext.citeproc.citation_styles_path = /path/to/csl/styles/directory/

# ckanext.citeproc._show_citations controls citations showing for datasets of a given package type:
# (optional, default: true).
ckanext.citeproc.dataset_show_citations = false

# ckanext.citeproc._resource_show_citations controls citations showing for resources of a given package type:
# (optional, default: true).
ckanext.citeproc.dataset_resource_show_citations = false
DB migration to be executed
(not set)
<< back to Extensions