Extension for CKAN: HRO-theme

A custom theme for for OpenData.HRO, the open data portal of the Hanseatic and University City of Rostock (https://www.opendata-hro.de/).

Requirements

CKAN

Installation

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

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

2. Install HRO-theme into your virtual Python environment, for example:

   cd /usr/lib/ckan/default/src
   git clone https://github.com/rostock/ckanext-hro_theme.git
   cd ckanext-hro_theme
   pip install -e .
   

3. Enable HRO-theme in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini):

   ckan.plugins = hro_theme
   

4. Restart CKAN. For example, if you have deployed CKAN with Apache HTTP Server on Ubuntu, run:

   sudo service apache2 reload
   

Upgrade

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

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

2. Upgrade HRO-theme within your virtual Python environment:

   cd /usr/lib/ckan/default/src/ckanext-hro_theme
   git pull
   pip install -e .
   

3. Restart CKAN. For example, if you have deployed CKAN with Apache HTTP Server on Ubuntu:

   sudo service apache2 reload
   

Translation

1. Create or update the file ckanext/hro_theme/i18n/ckanext-hro_theme.pot by extracting all translatable strings into it:

   cd /usr/lib/ckan/default/src/ckanext-hro_theme
   python setup.py extract_messages
   

2. If necessary, create a new translation for your language – this will generate a new directory ckanext/hro_theme/i18n/YOUR_LANGUAGE with a LC_MESSAGES/ckanext-hro_theme.po file containing all the untranslated strings:

   python setup.py init_catalog --locale <YOUR_LANGUAGE>
   

3. Start editing either the new po file you created before or one of the existing po files:

   msgid "This is an untranslated string!"
   msgstr "This is a translated string!"
   

4. Compile the updated po file(s) – this will generate the required mo file(s):

   python setup.py compile_catalog