Extension Intro.js


Extension Basics

Title
Intro.js
Name
ckanext-introjs
Type
Public extension
Description
Adds intro.js to CKAN so users can follow a guided tour of the UI. Creates step-by-step guided introductions for the CKAN interface.
CKAN versions
Download-Url (zip)
Last commit
11 years ago (2015-02-24 15:44:56)
Url to repo
Category
Content Management


Background Infos

Description (long)
Show details

ckanext-introjs

This plugin adds intro.js goodness to CKAN - a library to create better introductions for websites and features with a step-by-step guide for your UI (so the intro.js website says - https://usablica.github.io/intro.js/).

Originally created for use on civil servants in NHS England with mixed results.

YMMV - please feel free to fork this repository.

Usage

After installing the plugin in the usual manner please ensure the following steps are taken:

  • Ensure that both the CSS and Javascript is correctly referenced within the appropriate template. For example:

    • <link rel="stylesheet" href="/css/introjs.min.css" />
    • <script type="text/javascript" src="/js/intro.min.js"></script> should appear in some sort of base template.
  • To start the plugin in the UI ensure you create a link or button like this:

    <a href="javascript:void(0)" onClick="javascript:introJs().start();"
     data-intro="Clicking the 'Help' link will display on-page walkthrough information. Click the 'Next' and 'Back' buttons below to navigate the walkthrough. Clicking 'Skip' returns you to the page."
     data-step="1">Help</a>
    
  • More information on how to configure the Javascript and how this interacts with HTML tags and elements in your templates can be found at the intro.js website: https://github.com/usablica/intro.js

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


Installation Guide

Configuration hints

Requires intro.js library (CSS and JS) to be added to templates. No plugin entry point in setup.py.

Plugins to configure (ckan.ini)
(not set)
CKAN Settings (ckan.ini)
# No specific environment variables required
DB migration to be executed
(not set)
<< back to Extensions