Requirements:
- CKAN 2.9+
- Python 2.7
Installation:
1. Activate CKAN virtual environment:
. /usr/lib/ckan/default/bin/activate
Install extension:
pip install ‘git+https://github.com/DataShades/ckanext-citation.git#egg=ckanext-citation’
Add ‘citation’ to ckan.plugins in config file
Restart CKAN
Configuration:
Mapping between CKAN Fields and CSL Variables:
Configure mapping between CKAN dataset fields and CSL citation variables
Currently supports title and author fields
ckanext.citation.csl_mappings = {“title”: “title”, “author”: “author”}
CSL Variables reference:
https://docs.citationstyles.org/en/stable/specification.html#appendix-iv-variables
Citation Styles Configuration:
Configure which styles to show (space or newline separated)
ckanext.citation.csl_styles = apa modern-language-association chicago-note-bibliography
Commands:
Build Citation Styles:
ckan citation build-styles
This command generates a list of citation styles for the extension.
Default Major Styles (shown if not configured):
- apa (American Psychological Association)
- modern-language-association (MLA)
- chicago-note-bibliography (Chicago Note-Bibliography)
- chicago-author-date (Chicago Author-Date)
- ieee (IEEE)
- council-of-science-editors (CSE)
- american-medical-association (AMA)
- american-chemical-society (ACS)
- american-institute-of-physics (AIP)
- american-society-of-civil-engineers (ASCE)
Custom Styles Configuration:
Add custom citation styles via ckanext.citation.csl_styles option
Separate styles by space or newline
Run ‘ckan citation build-styles’ after adding styles
Usage:
1. Configure CKAN field mappings to CSL variables
2. Run build-styles command to generate style list
3. Citation snippet appears on dataset pages
4. Users can select citation style and copy formatted citation
Features:
- Multiple citation style support (CSL-based)
- Configurable field mappings
- Major academic citation formats included
- Extensible with custom styles
- Dataset page integration
- Copy-to-clipboard functionality
CSL (Citation Style Language):
- Industry standard for citation formatting
- Supports thousands of citation styles
- Flexible field mapping
- Widely used in academic publishing
Use Cases:
- Academic data repositories
- Research data portals
- Scientific dataset archives
- Government research data catalogs
- Institutional repositories
Development Status: Beta
License: MIT
Keywords: CKAN, citation, CSL, academic, research