cppreference2mshelp 项目使用教程

cppreference2mshelp 项目使用教程

cppreference2mshelp cppreference.com html archive converter to microsoft help (for Visual Studio 2012+) and chm help (for Windows) 项目地址: https://gitcode.com/gh_mirrors/cpp/cppreference2mshelp

1、项目介绍

cppreference2mshelp 是一个开源项目，它可以将 cppreference.com 的 HTML 离线存档转换为适用于 Windows Visual Studio 2012 及以上版本的 Microsoft Help 文件格式（.cab），以及适用于任何 Windows 平台甚至其他一些平台的经典 CHM 帮助文件格式。

2、项目快速启动

环境准备

• Windows x64 系统（实际上任何系统都可以，但需要使用其他工具来制作 CAB 文件、ZIP 文件和为 Visual Studio 帮助签名的 CAB）
• PHP 5.6.1 或更高版本
• 从 cppreference.com 下载的离线存档（Html book 格式）
• Microsoft 的 HTML Help Workshop 工具（用于构建 .chm 帮助文件）
• Microsoft SDK 中的 makecab.exe 和 signtool.exe（用于构建 Visual Studio 帮助文件）
• Tidy 工具（用于将 HTML 转换为 XHTML 并修复错误）
• 数字证书（用于签名 Visual Studio 帮助的 CAB 文件，CHM 帮助文件不需要）

步骤

1. 下载并解压 cppreference.com 的离线存档。
2. 将本项目下载并解压到存档的 reference 文件夹中。
3. 确保文件夹结构如下所示：

   Folders
   ├── common
   ├── en
   ├── ...（其他文件夹由脚本创建）
   

4. 运行相应的脚本来构建文档。

构建 Visual Studio 帮助文件

• 对于 C 语言文档，运行 compile_c.cmd。
• 对于 C++ 语言文档，运行 compile_cpp.cmd。

这些脚本会创建 cppreference.cab 和 creference.cab 文件，以及相应的 .msha 配置文件，用于安装创建的帮助文件。

构建 CHM 帮助文件

• 运行 make_chm.php 脚本。

该脚本会创建 .chm 帮助文件。

3、应用案例和最佳实践

• 请参考项目的 README 文件以及 MIT 许可协议。
• 在构建帮助文件之前，确保正确设置了所有的环境和依赖项。
• 使用本项目提供的预构建和签名文件，可以直接安装到 Visual Studio 2012、Visual Studio 2013（可能还有 2015 和 2017 版本）。

4、典型生态项目

• cppreference.com：本项目依赖于此网站提供的离线 HTML 存档。
• Microsoft Help System：本项目生成的帮助文件需要与 Microsoft Help System 兼容。
• HTML Help Workshop：用于创建 CHM 文件的工具。

以上是 cppreference2mshelp 项目的使用教程，希望能帮助您顺利使用该项目。

cppreference2mshelp cppreference.com html archive converter to microsoft help (for Visual Studio 2012+) and chm help (for Windows) 项目地址: https://gitcode.com/gh_mirrors/cpp/cppreference2mshelp