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 Visual Studio的Help文件格式（.cab）和CHM帮助文件格式。该项目主要面向需要本地化C和C++参考文档的开发者。该项目使用的主要编程语言包括CSS、PHP和Shell脚本。

2. 项目使用的关键技术和框架

• PHP: 用于预处理和转换HTML文档。
• Shell脚本: 用于自动化文档转换和打包过程。
• Microsoft Help Workshop: 用于生成CHM帮助文件。
• Microsoft SDK工具: 包括makecab.exe和signtool.exe，用于生成和签名CAB文件。
• HTML Tidy: 用于清理和转换HTML文档到XHTML格式。

3. 项目安装和配置的准备工作

在开始安装和配置之前，请确保您的系统满足以下要求：

• Windows x64操作系统（尽管项目理论上可以在任何系统上运行，但生成CAB文件和数字签名可能需要特定的Windows工具）。
• PHP 5.6.1或更高版本。
• 从cppreference.com网站下载的离线HTML文档存档。
• Microsoft HTML Help Workshop，用于生成CHM帮助文件。
• Microsoft SDK中的makecab.exe和signtool.exe工具，用于生成和签名CAB文件。
• HTML Tidy工具，用于转换HTML文档。
• msys2环境，并安装以下包：p7zip、mingw-w64-x86_64-python3-pip、mingw-w64-x86_64-python3-lxml、mingw-w64-x86_64-iconv。
• 使用pip3安装premailer和mingw-w64-x86_64-python3-qt。

安装步骤

1. 下载并解压cppreference.com的离线HTML文档存档。
2. 将本项目的代码克隆或下载到解压后的文档目录中的reference文件夹内。
3. 确保文件夹结构如下所示：

   Folders
   ├── common
   ├── en
   ├── compile_c.cmd
   ├── compile_cpp.cmd
   ├── ...
   

4. 在项目目录中，运行compile_c.cmd或compile_cpp.cmd，根据需要生成C或C++的文档。
5. 运行相应的PowerShell脚本（如compile_c_zip.ps1），生成ZIP文件。
6. 使用Microsoft HTML Help Workshop打开cppreference.hhp项目文件，生成CHM帮助文件。
7. 使用makecab.exe和signtool.exe对生成的CAB文件进行打包和签名。
8. 使用cppreference.msha和creference.msha配置文件安装生成的帮助文件到Visual Studio。

请注意，以上步骤需要一定的计算机操作基础，如果您是初次进行此类操作，请耐心按照指南逐步进行。在操作过程中可能会遇到一些挑战，但按照指南操作通常能够成功安装和配置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