Redmine Drawio 插件使用教程

1. 项目介绍

Redmine Drawio 是一个开源插件，允许用户在 Redmine 的 Wiki 页面、问题描述和问题说明中嵌入 draw.io 图表。draw.io 是一个免费的在线图表工具，支持多种图表类型，如工作流、流程图、UML 图、ER 图等。通过这个插件，用户可以直接在 Redmine 中编辑和查看这些图表，极大地提高了项目文档的可视化和协作效率。

2. 项目快速启动

安装步骤

1. 克隆插件仓库：

   cd $REDMINE_HOME/plugins
   git clone https://github.com/mikitex70/redmine_drawio.git
   

2. 重启 Redmine： 安装完成后，重启 Redmine 以加载新插件。

配置插件

1. 启用 REST API： 在 Redmine 的设置中启用 REST API，以便插件能够保存图表附件。

   Administration -> Settings -> API tab -> Enable REST web service
   

2. 配置插件设置： 在 Redmine 的管理界面中，进入 Administration -> Plugins -> Redmine Drawio Plugin -> Configure，配置 draw.io 服务器的 URL 和其他选项。

使用插件

在 Redmine 的 Wiki 页面或问题描述中，使用以下宏来嵌入图表：

• drawio_attach 宏：

  [[drawio_attach(myDiagram)]]
  

• drawio_dmsf 宏：

  [[drawio_dmsf(diagrams/myDiagram)]]
  

3. 应用案例和最佳实践

应用案例

1. 项目文档可视化： 在项目 Wiki 页面中嵌入流程图、架构图等，帮助团队成员更好地理解项目结构和流程。

2. 问题跟踪： 在问题描述中嵌入相关图表，帮助开发人员快速理解问题的上下文和解决方案。

最佳实践

1. 版本控制： 使用 DMSF（Document Management System For Redmine）插件来管理图表的版本，确保图表的每次修改都能被记录和追溯。

2. 安全配置： 根据项目的安全需求，配置插件的 SVG 图表支持和 Content-Security-Policy 头，确保图表的安全性。

4. 典型生态项目

DMSF（Document Management System For Redmine）

DMSF 是一个与 Redmine 集成的文档管理系统，支持文档的版本控制、权限管理等功能。Redmine Drawio 插件可以与 DMSF 结合使用，将图表作为文档进行管理，提供更强大的文档管理能力。

Redmine WYSIWYG 插件

Redmine WYSIWYG 插件提供了所见即所得的编辑器，使得在 Redmine 中编辑内容更加直观。Redmine Drawio 插件与 WYSIWYG 插件结合使用，可以在编辑器中直接插入和编辑图表，提高工作效率。

通过以上模块的介绍，您可以快速上手并充分利用 Redmine Drawio 插件，提升项目管理和协作的效率。