184
2024-01-04 19:40
admin- 1 -
场景
CHM是英文Compiled HTML Help的缩写，是微软公司专有的联机帮助格式，由HTML页面、索引和其他导航工具的集合组成。这些文件被压缩并部署为二进制格式，扩展名为.CHM，用于编译HTML。CHM格式通常用于软件文档。
虽然CHM格式是老的文档格式，很多Windows程序已经不再将它作为帮助文件的首选，但是有些场景我们依然希望将DITA或者Markdown发布成CHM格式的内容。尤其是为运行在Windows操作系统下的软件提供离线帮助。DITA发布体系支持将DITA内容发布成CHM格式。
本文分析将DITA或Markdown格式的内容发布成CHM格式的方法，并为实现这个目的扫清实际操作遇到的技术障碍。
- 2 -
DITA-OT发布框架
DITA-OT是DITA内容发布的开源发布引擎。它的诞生，是为了将DITA格式的内容发布成多种格式输出。
随着这些年的发展，DITA-OT支持的输入内容包括DITA和Markdown，输出的格式包括PDF、HTML和CHM格式等。见下图（源自DITA-OT官网：http://www.dita-ot.org）：
1. 输入格式一：DITA Map + Topic
系统支持由XML格式的DITA Map和XML格式的Topic组成的文档，见下例。
Map文件内容：
Topic文件内容：
发布过程是这样的：
2. 输入格式二：DITA Map + Markdown
同时，系统也支持由XML格式的DITA Map和Markdown格式的Topic组成的文档，见下例。
Map文件内容：
注：目前DITA-OT不支持使用Markdown来写DITA Map文件，只支持使用Markdown编写Topic。
上例中格式mdita表示Markdown格式的DITA Topic。
Markdown格式的Topic内容:
提示：在发布过程中，如果Topic格式是Markdown，系统先将它转换成XML格式的Topic，然后再执行发布。
发布过程是这样的：
如果你所在的公司有很多Markdown格式的内容，想将他们组合在一起发布，那么通过这种方式可以将Markdown内容纳入DITA发布体系，获得单一数据源多种格式输出的能力。
- 3 -
实践
因为CHM是微软公司独有的格式，只能在Windows操作系统上运行，所以请在运行Windows操作系统的电脑上运行本实践步骤。
1. 安装必要软件
如果安装了Oxygen XML Editor编辑器，它已经包含了DITA-OT发布引擎。
如果没有使用Oxygen XML Editor编辑器，那么可以自行到DITA-OT官网（http://www.dita-ot.org）下载安装程序，并按照文档安装到电脑上。本文使用的是DITA-OT 3.7.4版本。
无论用到上边两种方法的哪一种，都需要额外安装一个软件叫做HTML help workshop。这个软件是微软公司开发的，但大家可能会发现微软公司的官网已经下载不到这个软件了。
幸运的是，有其他人也碰到了此问题，并提供了解决方案。请访问如下网页：
点击网页中的下图链接下载安装程序：
下载后，请运行这个安装程序安装HTML help workshop软件。
2. 使用Oxygen XML Editor发布
在Oxygen XML Editor编辑中打开ditamap文件，然后发布，如下图：
系统会生成xxx.chm文件。双击此文件，打开结果如下图：
3. 使用Windows命令行发布
如果没有Oxygen XML Editor并且安装了DITA-OT，则使用Windows命令行发布。
1) 打开Windows命令行
2）运行以下命令
注：C:\dev\dita\dita\cloudphotox是我ditamap文件所在路径。
第二行命令的意思：
- -i cloudphoto.ditamap：输入文件是cloudphoto.ditamap
- -f htmlhelp：输出格式为htmlhelp
- -o out：输出文件放到out目录下
3）输出结果为out目录下的cloudphoto.chm文件。
打开以后如下图：
- 4 -
总结
通过本文描述的总结和实践，大家可以使用此方法将DITA和Markdown格式的内容发布成CHM格式的帮助文件。赶快试试吧！
Infomagic 学院近期热诚推出“DITA文档发布与样式定制训练营”，跟随大龙老师深入了解DITA-OT，成为DITA文档发布与样式定制专家！
\ | /
infomagic
更多内容
从火爆全网的ChatGPT，看生成式AI在技术传播中的应用前景
更多培训
文档工程师新手预备营技术传播能力地图信息架构训练营2023一起学DITADITA结构化写作训练营（基础班）（回看版）技术写作企业定制培训
- 相关评论
- 我要评论
-