开源项目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档案转换为Microsoft Help（适用于Windows Visual Studio 2012+）和CHM帮助文件（适用于Windows及一些其他平台）。以下是项目的目录结构及其文件介绍：

cppreference2mshelp/
├── css/                        # 存储CSS样式文件
├── .gitignore                  # 指定git应该忽略的文件和目录
├── LICENSE                     # 项目许可证文件，采用MIT协议
├── README.md                   # 项目说明文件
├── compile_c.cmd               # 用于生成C语言文档的主要命令文件
├── compile_c_zip.ps1           # 使用PowerShell生成C语言文档的ZIP文件
├── compile_cpp.cmd             # 用于生成C++语言文档的主要命令文件
├── compile_cpp_zip.ps1         # 使用PowerShell生成C++文档的ZIP文件
├── config.txt                  # 配置文件，用于tidy工具的配置
├── cppreference.msha           # Microsoft Help System的配置文件
├── creference.msha             # Microsoft Help System的配置文件
├── folders.png                 # 项目文件夹结构图
├── make_chm.php                # PHP脚本，用于生成CHM帮助文件
├── make_chm.sh                 # Shell脚本，用于生成CHM帮助文件
├── make_chm_en.sh              # Shell脚本，用于生成英文版CHM帮助文件
├── make_xhtmls.php             # PHP预处理脚本，用于转换HTML文件到XHTML和Microsoft Help格式
├── makecab.exe                 # 用于生成CAB文件的工具，可在Microsoft SDK中找到
├── signtool.exe                # 用于签名CAB文件的工具，可在Microsoft SDK中找到
├── tidy.exe                    # HTML修正工具，用于转换HTML到XHTML并修正错误
└── zh-p12tic.diff              # 差异文件，可能用于修正中文文档的特定问题

2. 项目的启动文件介绍

项目的启动主要涉及以下两个命令文件：

• compile_c.cmd：该文件用于生成C语言文档的cab文件。在命令行中执行此文件将开始生成过程。
• compile_cpp.cmd：该文件用于生成C++语言文档的cab文件。同样，在命令行中执行此文件将开始生成过程。

这两个文件是生成帮助文件的主要执行入口。

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行：

• config.txt：此文件是tidy工具的配置文件，用于指定HTML转换为XHTML时的行为和规则。

确保正确配置此文件对于生成格式正确的帮助文档至关重要。

以上即为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