ckanext-tour

ckanext-tour是一个CKAN扩展，为CKAN实例提供导游功能。它允许用户创建交互式导游来展示CKAN实例的不同功能和功能。

特性

• 创建带有逐步说明的交互式导游
• 突出显示CKAN页面上的特定元素
• 自定义导游的外观和行为
• 通过CKAN管理界面轻松管理和编辑导游

安装并启用扩展后，您可以通过CKAN管理界面开始创建导游。导游可以与CKAN门户的特定页面或部分相关联，并且您可以定义每个导游的多个步骤。

要开始导游，用户可以点击导游触发按钮，或者当用户访问指定页面时自动启动。导游将引导他们通过指定的步骤，突出显示每页的相关元素。

每个步骤包含以下信息

• 标题：简短、吸引人的标题，总结步骤。
• 查询：指定要突出显示哪个元素
• 简介：将在步骤卡片上显示的文本
• 位置：指定步骤卡片的放置位置（顶部、右侧、底部、左侧）。
• 图像：补充文本、说明观点或增加视觉兴趣的视觉效果。这里可以使用GIF动画。

创建导游

要通过管理面板UI创建ckanext-tour的导游，请按照以下步骤操作

• 以系统管理员身份登录您的 CKAN 实例。
• 在管理员面板工具栏中导航到 配置 部分。
• 在 巡游 部分下找到并点击 添加巡游 链接，以打开巡游创建表单。
• 填写巡游所需的信息。
  • 您可以给每个巡游添加 1 个或多个步骤。
• 添加所有信息后，按下 创建巡游 按钮提交表单并保存巡游。
• 现在您可以转到 巡游列表 页面查看所有创建的巡游。

要求

与核心 CKAN 版本的兼容性

安装

安装 ckanext-tour

1. 激活您的 CKAN 虚拟环境，例如

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

2. 克隆源并将其安装在虚拟环境中

   git clone https://github.com/mutantsan/ckanext-tour.git cd ckanext-tour pip install -e . pip install -r requirements.txt

3. 将 tour 添加到您的 CKAN 配置文件中的 ckan.plugins 设置（默认配置文件位于 /etc/ckan/default/ckan.ini）。

4. 重启 CKAN。例如，如果您在 Ubuntu 上使用 Apache 部署了 CKAN

   sudo service apache2 reload

配置设置

要修改扩展的配置，请通过网站的用户界面进行更改。

开发者安装

要为开发安装 ckanext-tour，请激活您的 CKAN 虚拟环境并执行

git clone https://github.com/mutantsan/ckanext-tour.git
cd ckanext-tour
python setup.py develop
pip install -r dev-requirements.txt

测试

要运行测试，请执行

pytest --ckan-ini=test.ini

许可证

AGPL