Additionals插件技术文档

Additionals插件技术文档

additionals Redmine plugin for easy customization of settings, text and content display by using personal or role-based dashboards (drag&drop), providing wiki macros and act as library for other plugins. 项目地址: https://gitcode.com/gh_mirrors/ad/additionals

安装指南

系统要求

• Redmine版本: >= 5.0
• Ruby版本: >= 3.0
• 数据库版本: MySQL >= 8.0 或 PostgreSQL >= 10

注意: 如果使用MySQL，请确保所有数据库表使用相同的存储引擎（推荐InnoDB）和字符集（推荐utf8mb4）。

安装步骤

1. 进入Redmine根目录：

   cd $REDMINE_ROOT
   

2. 克隆additionals插件到plugins目录：

   git clone -b stable https://github.com/alphanodes/additionals.git plugins/additionals
   

3. 配置Bundler并安装依赖：

   bundle config set --local without 'development test'
   bundle install
   

4. 执行数据库迁移：

   bundle exec rake redmine:plugins:migrate RAILS_ENV=production
   

5. 重启应用服务器（如Apache、Nginx、Unicorn、Puma等），additionals插件即可使用。

更新插件

1. 进入插件目录并拉取最新代码：

   cd $REDMINE_ROOT/plugins/additionals
   git pull
   

2. 返回Redmine根目录并安装依赖：

   cd ../..
   bundle install
   

3. 执行数据库迁移：

   bundle exec rake redmine:plugins:migrate RAILS_ENV=production
   

4. 重启应用服务器，additionals插件即可使用。

卸载插件

1. 执行数据库回滚：

   cd $REDMINE_ROOT
   bundle exec rake redmine:plugins:migrate NAME=additionals VERSION=0 RAILS_ENV=production
   

2. 删除插件目录和相关资源：

   rm -rf plugins/additionals public/plugin_assets/additionals
   

项目使用说明

功能概述

additionals插件提供了多种功能，包括：

• 仪表盘（拖放支持）
• 登录页面文本
• 全局页脚
• 欢迎文本
• 全局侧边栏内容支持
• 新问题提示
• Wiki页面PDF生成
• Wiki宏
  • asciinema, cryptocompare, date, fa, gihub gist, google_docs, gmap, group_users, iframe, last_updated_at, last_updated_by, members, meteoblue, new_issue, projects, recently_updated, reddit, redmine.org issue and wiki page, slideshare, tradingview, twitter, user, vimeo, youtube
• 宏列表
• 宏按钮
• 隐藏顶部菜单中的“帮助”
• 禁用项目模块
• 外部链接在新窗口打开
• 表情符号支持
• 匿名化外部链接的referrer
• 隐藏项目成员框中的角色
• 限制问题中显示的附件数量
• 自动关注分配给我的问题
• 更改问题作者
• 在用户资料中创建问题
• 问题分配给我链接
• 侧边栏更改问题状态
• 可配置的问题规则

配置说明

插件配置在管理区域的Plugins / Additionals中进行。配置分为多个部分，包括：

• 内容
  • 登录页面文本
  • 全局侧边栏
  • 项目页脚
• 设置
  • 外部链接在新窗口打开
  • 返回顶部链接
  • 表情符号支持
  • 旧版表情符号支持
  • 最大LiveSearch结果数量

项目API使用文档

库资产加载器

additionals_library_load(module_name)

该方法加载所需模块的所有JS和CSS文件。

可用模块包括：

• chartjs
• chartjs_colorschemes
• chartjs_datalabels
• clipboardjs
• d3
• d3plus
• font_awesome
• mermaid
• select2

Rails辅助方法

插件提供了多种Rails辅助方法，具体请参考插件文档。

项目安装方式

插件的安装方式已在安装指南中详细说明。请按照步骤进行安装、更新和卸载。

additionals Redmine plugin for easy customization of settings, text and content display by using personal or role-based dashboards (drag&drop), providing wiki macros and act as library for other plugins. 项目地址: https://gitcode.com/gh_mirrors/ad/additionals