Redmine Dashboard 插件安装与使用教程

Redmine Dashboard 插件安装与使用教程

1. 项目的目录结构及介绍

Redmine Dashboard 插件的目录结构如下：

redmine_dashboard/
├── app/
│   ├── controllers/
│   ├── helpers/
│   ├── models/
│   └── views/
├── config/
│   ├── locales/
│   └── routes.rb
├── db/
│   └── migrate/
├── lib/
│   ├── redmine_dashboard/
│   └── tasks/
├── public/
│   └── themes/
├── test/
│   ├── fixtures/
│   ├── functional/
│   ├── integration/
│   └── unit/
├── Gemfile
├── init.rb
└── README.md

目录结构介绍

• app/: 包含控制器、辅助函数、模型和视图等应用程序的核心代码。
• config/: 包含配置文件，如本地化文件和路由配置。
• db/: 包含数据库迁移文件。
• lib/: 包含插件的库文件和任务文件。
• public/: 包含公共资源，如主题文件。
• test/: 包含测试文件，如功能测试、集成测试和单元测试。
• Gemfile: 定义了项目所需的Gem依赖。
• init.rb: 插件的初始化文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

Redmine Dashboard 插件的启动文件是 init.rb。这个文件负责加载插件并进行初始化设置。

# init.rb
require 'redmine'

Redmine::Plugin.register :redmine_dashboard do
  name 'Redmine Dashboard'
  author 'Jan Graichen'
  description 'This Redmine plugin adds an issue dashboard that supports drag and drop for issues and various filters.'
  version '2.15.0'
  url 'https://github.com/jgraichen/redmine_dashboard'
  author_url 'https://github.com/jgraichen'

  menu :top_menu, :dashboard, { controller: 'dashboard', action: 'index' }, caption: 'Dashboard', if: proc { User.current.logged? }

  project_module :dashboard do
    permission :view_dashboard, dashboard: :index
    permission :manage_dashboard, dashboard: [:update, :create, :destroy]
  end
end

启动文件介绍

• require 'redmine': 加载 Redmine 核心库。
• Redmine::Plugin.register: 注册插件，定义插件的名称、作者、描述、版本等信息。
• menu :top_menu: 在顶部菜单中添加 Dashboard 菜单项。
• project_module: 定义项目模块和权限。

3. 项目的配置文件介绍

Redmine Dashboard 插件的配置文件主要位于 config/ 目录下。

配置文件介绍

• config/routes.rb: 定义插件的路由规则。

# config/routes.rb
Rails.application.routes.draw do
  resources :dashboard, only: [:index, :update, :create, :destroy]
end

• config/locales/: 包含本地化文件，如 en.yml 和 de.yml，用于定义不同语言的文本内容。

# config/locales/en.yml
en:
  label_dashboard: 'Dashboard'
  label_dashboard_settings: 'Dashboard Settings'

配置文件介绍

• routes.rb: 定义了插件的路由规则，如 dashboard 控制器的 index、update、create 和 destroy 动作。
• locales/: 包含本地化文件，用于定义不同语言的文本内容。

以上是 Redmine Dashboard 插件的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该插件。