Extension Wikidatakeyword


Extension Basics

Title
Wikidatakeyword
Name
ckanext-wikidatakeyword
Type
Public extension
Description
Wikidata-powered keyword field for CKAN
CKAN versions
Download-Url (zip)
Last commit
a year ago (2024-07-08 15:28:26)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

=======================

ckanext-wikidatakeyword

This extension adds Wikidata-powered keyword field in CKAN datasets.

This new extra field “Wikidata Keywords” will appear in the dataset form by the form snippet_.

.. image:: docs/keywords-form.png

When displayed, each keyword will appear by the display snippet_, eg.:

.. image:: docs/keywords-display.png


Requirements

This extension is only tested in CKAN 2.9 and later with ckanext-scheming installed.


Installation

To install ckanext-wikidatakeyword:

  1. Activate your CKAN virtual environment, for example::

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

  2. Install the ckanext-wikidatakeyword Python package into your virtual environment::

    pip install -e ‘git+https://github.com/depositar/ckanext-wikidatakeyword.git#egg=ckanext-wikidatakeyword’

  3. Install Python dependencies::

    pip install -r /usr/lib/ckan/default/src/ckanext-wikidatakeyword/requirements.txt

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

  5. Add ckanext.wikidatakeyword:presets.json to your scheming.presets configuration settings::

    scheming.presets = ckanext.scheming:presets.json ckanext.wikidatakeyword:presets.json

  6. A keyword field in a scheming schema will look something like (/usr/lib/ckan/default/src/ckanext-scheming/ckanext/scheming/ckan_dataset.yaml if you are not using a custom extension)::

  • field_name: keywords label: Wikidata Keywords preset: wikidata_keyword
  1. Add a file templates/scheming/package/read.html in your custom extension (or modify /usr/lib/ckan/default/src/ckanext-scheming/ckanext/scheming/templates/scheming/package/read.html if you are not using a custom extension)::

    {% ckan_extends %}

    {% block package_additional

Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints
Plugins to configure (ckan.ini)
wikidatakeyword
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions