项目

一般

简介

插件 » Redmine UEditor «百度»富文本编辑器插件

Redmine Ueditor

Redmine UEditor插件将百度“所见即所得"的UEditor富文本编辑器完美移植到了Redmine。

发布于: https://www.redmineplugins.cn
兼容于: Redmine 5.1.*,  5.0.*,  4.2.*,  4.1.*,  4.0.*,  3.4.*,  3.3.*,  3.2.*,  3.1.*,  3.0.*

最新版本: 0.5.0 更新日期: 2024-11-17 09:56

安装指导

  • Redmine版本要求
    • 至少需要Redmine 3.0及以上版本
  • 安装方法
    • 拷贝插件目录redmine_ueditor至Redmine的plugins插件目录下
    • bundle install
    • NAME=redmine_ueditor bundle exec rake redmine:plugins:migrate
    • 重新启动Redmine
  • 启用编辑器
    • redmine_ueditor插件安装后,以Redmine管理员身份登录系统
    • 依次在菜单栏选择“管理” → “配置” → “一般” → “文本格式” → “Ueditor”
  • 卸载方法
    • bundle exec rake redmine:plugins:migrate NAME=redmine_ueditor VERSION=0
    • 删除插件redmine_ueditor插件目录
    • 重新启动Redmine
  • 以下是常见问题或技巧,任何其它使用问题可以到这里新建问题
    • 如何让自定义字段也支持ueditor富文本工具栏
      要求redmine的版本号 >= 4.1.0,“自定义字段”格式设置为'文本/長文字',并选择'文本格式'和'全宽布局'
    • Redmine UEditor上传视频、图片或附件等报"文件大小超出"
      • Redmine的配置中调整Redmine的附件大小限制,“管理” → “配置” → “文件” → “附件大小限制”
    • 如何将Redmine的textile/markdown历史文本数据迁移到Redmine Ueditor的富文本格式?
      • 方法-1: 使用redmine reformat 插件可以实现普通文本到富文本的迁移,具体见该插件介绍或举例
      • 方法-2: 将redmine已有的textile或markdown格式数据转换成html格式
        • 首先安装依赖的工具包Pandoc, 安装方法参考 https://pandoc.org/installing.html
        • 将Redmine的textile格式转换为html格式的方法
          # 在redmine目录下执行 
          rake redmine_ueditor:migrate RAILS_ENV=production FROM=textile TO=html
          
        • 将Redmine部分项目的textile格式转换为html格式的方法
          # 在redmine目录下执行,其中 project_identifier1和project_identifier2是项目标识符
          rake redmine_ueditor:migrate RAILS_ENV=production PROJECT=project_identifier1,project_identifier2 FROM=textile TO=html
          
        • 或者直接执行转换命令
          % rake redmine_ueditor:migrate
          ***** 注意 *****
          强烈建议此操作前备份你的Redmine数据库, 以免迁移操作导致数据丢失
          ****************
          projects: ALL
          migration: textile to html
          Do you want to continue? (type 'y' to continue): y
          project Redmine
          Migrating issues ... done             
          Migrating journals ... done            
          
    • 如何利用redmine_ueditor插件的草稿箱恢复功能
    • 如何保持与redmine_messager插件的兼容问题
      • 在redmine_messager的配置界面中取消“New issue description?”复选框,点击保存。
    • redmine服务器启用https后,插入百度地图显示为空白
    • 与redmine_issue_dynamic_edit插件协同时,redmine_issue_dynamic_edit不支持issue的description的富文本编辑
      • 可以通过修改修改redmine_issue_dynamic_edit插件的配置文件
      • 打开插件配置文件 /redmine_issue_dynamic_edit/assets/javascripts/issue_dynamic_edit_configuration_file.js
      • 在配置文件最后一行增加var _CONF_EXCLUDED_FIELD_ID = [“DescriptionInput”]; 关闭issue的description的实时编辑
    • 如何为ueditor添加自定义模版:
      • 修改redmine_ueditor插件目录下的文件 ./assets/javascripts/ueditor/dialogs/template/config.js ,参考该文件中的格式增加自己的模版即可。
      • 清空浏览器缓存,重新启动redmine后,再ueditor模板里就可以看到新增的模版了。
    • 与redmine_issue_templates插件的兼容性处理
      • 使用修订版的redmine_issue_templates 具体参考 #320
    • 与redmine_searchable_selectbox插件冲突,更新跟踪状态导致编辑工具栏消失
      • 更新redmine_searchable_selectbox插件版本 具体参考 #351
    • 如何修改字数限制
      • 修改配置文件 assets/javascripts/ueditor/ueditor.all.js
      • 去掉注释,并修为期望的数值,maximumWords:70000 //允许的最大字符数
    • 自定义工具栏功能按钮的数量
      • 首先备份redmine_ueditor/assets/javascripts/ueditor/ueditor.config.js
      • 使用文本编辑器打开ueditor.config.js,找到约36或37行
      • 根据需要修改 toolbars的取值。例如仅保留全屏或源码按钮的取值是 toolbars: [['fullscreen’, 'source’]]
  • redmine_ueditor的富文本编辑器如何录入redmine宏,以及插件支持哪些redmine宏?
    • 录入Redmine宏前首先要启用redmine_ueditor的html编辑模式,录入Redmine宏代指令或Redmine插件宏指令,然后取消html模式再保存即可。