Redmine Reformat - 将 Redmine 富文本数据转换为瑞士军刀¶

Redmine Reformat 是一个 Redmine 插件，提供了一项 rake 任务，用于灵活的富文本字段格式转换和批量编辑。

功能¶

• 可以在每个项目、每个对象和每个字段的基础上运行转换。
• 不同的数据集可以使用不同的转换 - 如果 Redmine 中的某些部分使用不同的语法版本，这将很有用。
• 支持自定义字段、日志甚至自定义字段日志。
• 支持在多个进程中并行转换 - 特别适合使用外部工具（pandoc、Web 服务）时。
• 即使并行转换也具有事务安全性。
• 当前支持的转换器
  • TextileToMarkdown - 基于 Pandoc 的 Textile 到 Markdown 转换器。在标记级别上工作。经过百万条字符串的实战检验。详情见下文。
  • MarkdownToCommonmark - 将旧 Redmine markdown 格式（Redcarpet）的主要特定内容转换为 CommonMark/GFM。
  • RedmineFormatter - 使用 Redmine 内部格式化程序生成 HTML。与外部转换器链式使用时很有用。详情见下文。
  • LinkRewriter - 在重构 Redmine 项目结构（重命名、合并）时很有用。详情见下文。
  • Ws - 调用一个外部 Web 服务，提供请求正文中的输入，并期望在响应正文中获得转换后的输出。
  • 请随意提交更多 :)
• 可以链式使用转换 - 例如，将 Atlassian Wiki 标记（大致类似于 Textile）转换为 HTML，然后使用 Turndown 将 HTML 转换为 Markdown。
• 换行符以可配置的方式规范化，以确保结果确定性并尽可能匹配转换后的文本。

基本用法¶

当前格式 Textile - 使用默认的 TextileToMarkdown 转换器设置将所有富文本转换为 Markdown

rake reformat:convert to_formatting=markdown

干运行

rake reformat:convert to_formatting=markdown dryrun=1

并行处理（仅限 Unix/Linux）

rake reformat:convert to_formatting=markdown workers=10

如果已经使用 commmon_mark 格式补丁（参见 #32424 和 Docker 镜像 orchitech/redmine-gfm）

# convert from textile:
rake reformat:convert to_formatting=common_mark
# convert from Redcarpet's markdown - same command:
rake reformat:convert to_formatting=common_mark

重命名或合并 Redmine 项目只能在数据库中直接完成。 redmine_reformat 可以为此更改准备维基链接

# 1. remove project prefix for wiki links within the renamed project
# 2. rename project prefix in wiki links outside of the renamed project
convcfg='[{
  "projects": ["oldname"]
  "converters": [["LinkRewriter", { "oldname": { "project": null } }]]
}, {
  "converters": [["LinkRewriter", { "oldname": { "project": "newname" } }]]
}]'
rake reformat:convert converters_json="$convcfg" 
# now you can rename the 'oldname' project to 'newname'

转换为 HTML（假设一个假设的 html 富文本格式）

convcfg='[{
  "from_formatting": "textile",
  "to_formatting": "html",
  "converters": "RedmineFormatter" 
}]'
rake reformat:convert to_formatting=html converters_json="$convcfg" 

通过中间 HTML 使用外部 Web 服务进行转换

convcfg='[{
  "from_formatting": "textile",
  "to_formatting": "common_mark",
  "converters": [
    ["RedmineFormatter"],
    ["Ws", "https://127.0.0.1:4000/turndown-uservice"]
  ]
}]'
rake reformat:convert to_formatting=common_mark converters_json="$convcfg" 

有关高级场景和更多信息，请访问主页。

问题、贡献和问题¶

请随意在 项目的 GitHub 上提交工单或 PR

祝您格式化愉快！

数据库备份¶

备份您的数据库或完全克隆您的 Redmine 实例。克隆的 Redmine 实例允许您将转换结果与原始结果进行比较。

安装¶

cd $REDMINE_ROOT
git -C plugins clone https://github.com/orchitech/redmine_reformat.git
bundle install

然后重新启动您的 Redmine。

安装转换器依赖项¶

如果使用 TextileToMarkdown 转换器，请安装 pandoc。其他提供的转换器没有直接依赖。