Extension Tour


Extension Basics

Title
Tour
Name
ckanext-tour
Type
Public extension
Description
Interactive guided tours for CKAN portals
CKAN versions

~2.9, ~2.10, ~2.11

Show details
Download-Url (zip)
Download-Url commit date
2024-08-01
Url to repo
Category
Content Management


Background Infos

Description (long)
Show details

Create interactive step-by-step guided tours to showcase CKAN features and functionalities. Features include multi-step tour creation via admin panel, element highlighting with CSS query selectors, customizable tour appearance and behavior, step cards with title/intro/image/position, automatic or manual tour triggers, page-specific tour association, visual GIF animation support in steps, configurable step card positioning (top/right/bottom/left), admin interface for tour management, tour listing and editing pages, and UI configuration via admin panel without code changes.

Version
0.3.0
Version release date
2024-08-01
Contact name
DataShades / Oleksandr Cherniavskyi
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Installation: git clone, pip install -e ., pip install -r requirements.txt, add ‘tour’ to ckan.plugins. CKAN >=2.10 required (2.9 not tested). Configuration managed via admin panel UI, no INI settings required. Creating tours: Login as sysadmin → Admin panel toolbar → Configuration → Tour section → ‘Add tour’ link → Fill form with tour information → Add 1+ steps per tour → Press ‘Create tour’. Step information: Title (brief headline), Query (CSS selector for element highlighting), Intro (step card text), Position (top/right/bottom/left for card placement), Image (visuals/GIFs to illustrate). Tour triggers: Manual button click or automatic on page visit. Admin features: List of tours page, tour editing interface, step management. Use cases: Onboarding new users, feature introduction, workflow guidance, self-service help, portal training, update announcements.

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