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/cp/cppreference2mshelp

cppreference2mshelp是一个将cppreference.com的HTML归档转换成适用于Visual Studio 2012及以上版本的帮助文件以及传统的CHM帮助文件的开源工具。这个项目特别适合那些希望在开发环境中便捷访问C++参考文档的开发者。

1. 项目的目录结构及介绍

项目根目录大致结构如下：

cppreference2mshelp/
├── cppreference/       # 此目录用于存放生成的各种格式文档
│   ├── chm/            # 编译好的CHM文件所在位置
│   ├── html-book-*     # 处理完成的HTML文档集合
│   └── ...             # 包含其他可能的子目录如qch-book-*等，用于不同格式的输出
├── README.md          # 项目说明文件
└── LICENSE            # 许可证文件

• cppreference/：主要工作区，包含了生成的文档和中间文件。
• chm/：存储最终的CHM帮助文件。
• html-book-*：预处理后的HTML文档目录。
• README.md：提供了关于项目基本信息和快速入门的指导。
• LICENSE：定义了项目的使用许可条件。

2. 项目的启动文件介绍

项目的核心运行依赖于几个关键脚本文件，其中主要是compile_c.cmd和compile_cpp.cmd这两个批处理文件，分别用于生成C和C++文档的微软帮助文件。

• compile_c.cmd: 用于处理并构建C语言相关的帮助文档。
• compile_cpp.cmd: 专门用于构建C++语言的文档。这两个文件执行时会调用一系列脚本来完成从HTML到帮助文件格式的转换。

在使用之前，确保已经安装了必要的工具，比如HTML Help Workshop、Tidy等，并且配置了正确的环境。

3. 项目的配置文件介绍

• config.txt: 是一个重要的配置文件，它被tidy工具用来转换和修复HTML文档到XHTML格式，以及进行其他错误修正。配置项涉及tidy工具的行为调整，以满足项目特定的HTML处理需求。

此外，尽管不是传统意义上的“配置文件”，但cppreference.msha和creference.msha这两个文件也扮演着配置角色，它们作为微软帮助系统的头部文件，包含了帮助系统识别和安装这些帮助包所需的信息。

使用步骤摘要：

1. 下载cppreference.com的离线HTML归档。
2. 解压并将此项目解压到该归档的相应位置。
3. 根据需求运行对应的cmd文件来生成CHM或Microsoft帮助文件。
4. 完成后，利用生成的.cab文件通过相应的.msha文件安装帮助文档到你的开发环境中。

请确保阅读项目内的README.md文件获取最新的指令和潜在的更新信息，因为这些细节可能会随时间而改变。

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