django-wakawaka 技术文档

1. 安装指南

1.1 环境要求

• Python 3.8 及以上版本
• Django 3.2 (LTS) 及以上版本

1.2 安装步骤

1. 使用 pip 安装 django-wakawaka：

   pip install django-wakawaka
   

2. 在 Django 项目的 settings.py 文件中，将 wakawaka 添加到 INSTALLED_APPS 列表中：

   INSTALLED_APPS = [
       ...
       'wakawaka',
       ...
   ]
   

3. 在 urls.py 文件中，添加 wakawaka 的 URL 配置：

   from django.urls import include, path
   
   urlpatterns = [
       ...
       path('wiki/', include('wakawaka.urls')),
       ...
   ]
   

2. 项目的使用说明

2.1 基本功能

• 自动链接解析：Wiki 页面之间的链接通过 CamelCase 命名方案自动解析。
• 版本控制：自动跟踪页面的修订历史，并提供回滚到早期版本的功能。
• 权限管理：与 Django 的默认权限系统集成，支持创建、编辑和删除 Wiki 页面的权限。

2.2 示例项目

项目附带一个示例项目，展示了 Wiki 的主要功能，并帮助用户将应用程序集成到现有项目中。可以通过以下步骤运行示例项目：

1. 安装 Poetry：

   pip install poetry
   

2. 安装项目依赖：

   poetry install
   

3. 运行数据库迁移：

   poetry run ./manage.py migrate
   

4. 创建超级用户：

   poetry run ./manage.py createsuperuser
   

5. 启动开发服务器：

   poetry run ./manage.py runserver
   

3. 项目API使用文档

3.1 权限管理

Wakawaka 与 Django 的权限系统集成，用户需要具备相应的权限才能执行以下操作：

• 创建 Wiki 页面：需要 add_wikipage 权限。
• 编辑 Wiki 页面：需要 change_wikipage 权限。
• 删除 Wiki 页面：需要 delete_wikipage 权限。

3.2 自定义设置

• 默认首页名称：可以通过 WAKAWAKA_DEFAULT_INDEX 设置自定义默认首页名称。例如：

  WAKAWAKA_DEFAULT_INDEX = 'Home'
  

• CamelCase 链接规则：可以通过 WAKAWAKA_SLUG_REGEX 设置自定义的 CamelCase 链接规则。默认规则为：

  WAKAWAKA_SLUG_REGEX = r'((([A-Z]+[a-z]+){2,})(/([A-Z]+[a-z]+){2,})*)'
  

4. 项目安装方式

4.1 通过 pip 安装

pip install django-wakawaka

4.2 通过 Poetry 安装

1. 安装 Poetry：

   pip install poetry
   

2. 安装项目依赖：

   poetry install
   

3. 运行测试：

   poetry run pytest
   

通过以上步骤，您可以顺利安装并使用 django-wakawaka 项目。