Extension Tdp


Extension Basics

Title
Tdp
Name
ckanext-tdp
Type
Public extension
Description
The **ckanext-tdp** extension customizes CKAN instances for a specific environment, likely for the
CKAN versions
Download-Url (zip)
Last commit
5 years ago (2020-06-25 13:59:46)
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

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

ckanext-tdp: The data place customisations

This CKAN extension contains all the default customisations for the dataplace, which will be provided on all CKAN instances we host.

  • The Dataplace flavoured styling, with customisable color an hero image
  • Updated homepage layout, with dataset spotlight (most viewed, recently updated & added) and partner logo’s

Configuration

A couple of configuration can be passed through the configuration.

.. code::

ckanext.tdp.stylesheet_name: default ckanext.tdp.primary_colour: #FF530D ckanext.tdp.hero_image_url: https://url.to/image.jpg

  • stylesheet_name is an option when we generate a custom stylesheet for a client. For default CKAN styling, this setting can be left out an will default to the default stylesheet
  • primary_colour determines the color of the CKAN instance, this needs to be set as a hex color value.
  • hero_image_url is the URL to the hero image. It is strongly preferred to self-host this image, and provide a HTTPS url to avoid browser warnings for potential insecure content.

Styling

Modular CSS architecture is used, loosely based on SMACSS(https://smacss.com/) Using PostCSS(https://github.com/postcss/postcss) and the Post CSS CLI(https://www.npmjs.com/package/postcss-cli).

Developing

CSS and Styles

Run npm install

To build the CSS use npm run build

To watch the CSS for changes and automatically trigger a build, use npm run watch

PostCSS Is using Sugarss syntax https://github.com/postcss/sugarss and linted with stylelint https://github.com/stylelint/stylelint Source mapping is enabled to assist with debugging - this will be built with the CSS.


Contributing

Navigate to the public folder docker-ckan/src/ckanext-tdp/ckanext/tdp/public Run npm run lint - ensure no errors are produ

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


Installation Guide

Configuration hints
Plugins to configure (ckan.ini)
tdp
CKAN Settings (ckan.ini)
# ckanext.tdp.some_setting = some_default_value
DB migration to be executed
(not set)
<< back to Extensions