Extension User Manual


Extension Basics

Title
User Manual
Name
ckanext-user-manual
Type
Public extension
Description
Adds a Help option to the site's main navigation menu with information about CKAN functionalities to guide users.
CKAN versions
Download-Url (zip)
Last commit
a year ago (2025-02-26 15:58:45)
Url to repo
Category
Content Management


Background Infos

Description (long)
Show details

ckanext-user-manual

The plugin adds a “Help” option on the site main navigation menu. The Help page contains information about CKAN functionalities that aims to answer users questions and guiding them to use CKAN.

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.9 Yes
earlier Not Tested

Installation

To install ckanext-user-manual:

  1. Activate your CKAN virtual environment, for example:

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

  1. Clone the source and install it on the virtualenv:
git clone https://github.com//ckanext-user-manual.git
cd ckanext-user-manual
pip install -e .
pip install -r requirements.txt
  1. Add user_manual to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  2. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:

sudo service apache2 reload

Customization

The page contents are in: templates/snippets/sections. You may also need to change templates/snippets/ckanext_user_manual_help.html.

Version
1.0.0
Version release date
2025-02-07
Contact name
Vlad
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Customize help page contents in templates/snippets/sections.

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