NDoc 用户指南   [回目录] NDoc 1.3

Microsoft Help 2 部署

[此文档为预发布版本,在未来版本中有可能改变。]

部署 Microsoft Help 2

Microsoft Help 2 帮助系统维护一个注册表(不要和 Windows 注册表混淆),保存当前机器中所有已安装的帮助集合。注册表保存了所有的帮助集合,每个帮助集合中包含的 Help Titles,帮助集合间的嵌套关系等。

查看 Microsoft Help 2 Title 或集合之前,必须首先注册。因此 Microsoft Help 2 文档的部署,要比 HTML Help 1 的简单文件拷贝复杂的多。

Windows Installer

可以通过创建一个 Windows Installer 安装包程序,用于部署并注册帮助集合和 Help Titles。VSHIK 文档中有具体的制作步骤。不幸的是,这个过程中有很多手工的步骤,我们还没有能够找到自动制作 Windows Installer 安装包的方法。

H2Reg

另一格选择是使用 helpware.net 提供的 共享软件 H2Reg.exe。H2Reg.exe 是一个命名行工具,可以在安装过程中使用它,完成帮助集合/Help Title 的注册。它可以被用于任何支持命令行的安装程序,比如对于 Windows Installer 安装包,H2Reg 可以作为一个自定义动作。

如果设置 GenerateCollectionFilestrue,NDoc 会为 H2Reg 创建特定的 INI 配置文件,H2Reg 可以根据这个 INI 配置文件完成 Help Title 的注册、并合并到 VS.NET 的合并文档集合等动作。(记得将这个 INI 配置文件包含进您的安装包。)

下面是完整的步骤:

  1. 设置文档引擎的 GenerateCollectionFilestrue
  2. 将编译生成的帮助文件(*.HxS, *.HxI 等),和生成的 INI 文件包含到安装包中。
  3. 将 H2Reg.exe 和 H2Reg.ini (此文件可以从 H2Reg 安装路径中拷贝出来)包含到安装包中。
  4. 配置安装包,让安装包安装时,将帮助文件和生成的 INI 文件复制到安装路径下。
  5. 安装动作:执行 H2Reg,语法为:

    H2reg -r "CmdFile=<生成的 INI 文件的完整路径>"

  6. 卸载动作:执行 H2Reg,语法为:

    H2reg -u "CmdFile=<生成的 INI 文件的完整路径>"

    注意: 先执行 H2Reg,再删除相应的帮助文件和 INI 文件。

请参见

VS.NET 2003 文档引擎, GenerateCollectionFiles, VSHIK 部署步骤, H2Reg 在线