=============
ckanext-dictionary
.. The extension adds the ability to include a data dictionary (metadata) for each dataset.
Admins can create the data dictionary when adding the dataset, or create/modify it any other time.
Users see the data dictionary as another tab for each dataset.
Since this dictionary extension utilizes the DataStore extension, Data Dictionary information can
be accessed via API.
The extension adds the ability to include a data dictionary (metadata) for each dataset.
Admins can create the data dictionary when adding the dataset, or create/modify it any other time.
Users see the data dictionary as another tab for each dataset.
Since this dictionary extension utilizes the DataStore extension, Data Dictionary information can
be accessed via API.
.. image:: https://github.com/cmuphillycapstone/ckanext-dictionary/blob/master/screenshots/admin-setup.png?raw=true
:alt: Additional stage added to dataset setup
:height: 245px
:width: 449px
.. class:: center
Additional stage added to dataset setup
.. image:: https://github.com/cmuphillycapstone/ckanext-dictionary/blob/master/screenshots/admin-edit.png?raw=true
:alt: Editing data dictionary for a dataset
:height: 280px
:width: 450px
.. class:: center
Editing data dictionary for a dataset
.. image:: https://github.com/cmuphillycapstone/ckanext-dictionary/blob/master/screenshots/user-view.png?raw=true
:alt: User view of the data dictionary
:height: 197px
:width: 450px
.. class:: center
User view of the data dictionary
Requirements
The extension requires the DataStore extension to also be installed.
Additionally, it only works on CKAN versions that have two current stages in the ‘add dataset’ dialog.
Installation
.. Add any additional install steps to the list below.
For example installing any non-Python dependencies or adding any required
config settings.
To install ckanext-dict