Windows平台下Sigil电子书编辑器的编译指南

Windows平台下Sigil电子书编辑器的编译指南

Sigil Sigil is a multi-platform EPUB ebook editor 项目地址: https://gitcode.com/gh_mirrors/si/Sigil

前言

Sigil是一款功能强大的开源电子书编辑器，支持EPUB格式的创建和编辑。本文将详细介绍在Windows平台上从源代码编译Sigil的完整过程，帮助开发者或高级用户构建自己的Sigil版本。

准备工作

在开始编译Sigil之前，需要准备以下工具和环境：

1. 开发工具链

• Visual Studio 2017或更高版本：社区版即可满足需求
• CMake 3.0或更高版本：用于生成构建系统
• Inno Setup 6或更高版本：用于创建安装程序

2. 依赖库

• Qt5.12.x或更高版本：需要包含QtWebEngine组件
• Python 3.5或更高版本：需与目标架构匹配(32位/64位)

详细安装步骤

1. 安装Visual Studio

建议安装Visual Studio 2017或2019社区版。安装时需注意：

• 选择"使用C++的桌面开发"工作负载
• 对于64位构建，后续需使用"x64 Native Tools Command Prompt"
• 对于32位构建，需使用"x86 Native Tools Command Prompt"

2. 安装CMake

从CMake官网获取最新版本，安装时注意：

• 勾选"Add CMake to the system PATH"选项
• 确保安装后能在命令行中直接调用cmake命令

3. 安装Inno Setup

获取Unicode版本的Inno Setup 6+，安装时：

• 确保勾选Preprocessor选项
• 将安装目录添加到系统PATH环境变量

4. 安装Qt5

建议使用Qt5.12.x版本：

1. 下载对应版本的Qt安装程序
2. 安装时选择与Visual Studio版本匹配的组件(msvc2017或msvc2019)
3. 必须安装QtWebEngine组件

重要提示：标准预编译的Qt5.12.7版本存在bug，建议使用5.12.6/8/9版本，或自行编译并应用补丁。

5. 安装Python

根据目标架构选择对应版本的Python 3.5+：

• 64位Sigil需要64位Python
• 32位Sigil需要32位Python

安装建议：

• 使用默认安装路径
• 勾选"Add Python to PATH"选项

6. 安装Python依赖包

使用pip安装以下依赖包：

pip install six html5lib regex cssselect css-parser chardet dulwich Pillow lxml

对于PyQt相关组件，建议安装特定版本：

pip install PyQt5==5.12.3 PyQt5-sip==4.19.18 PyQtWebEngine==5.12.1

获取Sigil源代码

可以通过两种方式获取源代码：

1. 克隆Git仓库
2. 下载特定版本的zip压缩包

建议使用第二种方式获取稳定版本。解压后将目录重命名为简洁的名称，如"sigil-src"。

构建Sigil

1. 配置构建环境

使用Visual Studio命令提示符，创建一个构建目录并运行CMake：

mkdir sigil-build
cd sigil-build
cmake -G "NMake Makefiles" -DWIN_INSTALLER_USE_64BIT_CRT=1 -DQt5_DIR="C:\Qt\Qt5.12.x\5.12.x\msvc2017_64\lib\cmake\Qt5" -DCMAKE_BUILD_TYPE=Release "C:\path\to\sigil-src"

2. 编译Sigil

配置成功后，执行编译命令：

nmake

3. 构建安装包

编译完成后，构建安装程序：

nmake makeinstaller

生成的安装程序将位于构建目录的"installer"子目录中。

高级配置选项

CMAKE高级选项

• -DUSE_ALT_ICONS=(0|1)：使用替代图标
• -DPKG_SYSTEM_PYTHON=0：禁用捆绑Python环境
• Python相关路径指定选项

环境变量

运行时可通过环境变量调整Sigil行为：

• SIGIL_PREFS_DIR：指定偏好设置目录
• SIGIL_USES_DARK_MODE=(0|1)：强制使用暗黑模式
• SKIP_SIGIL_UPDATE_CHECK：跳过更新检查

常见问题解决

1. Qt版本问题：确保使用正确版本的Qt，特别是QtWebEngine组件
2. Python架构匹配：Python版本必须与目标Sigil架构一致
3. 路径设置：确保所有工具的bin目录都已添加到PATH环境变量
4. 依赖包版本：严格按照推荐版本安装Python依赖包

结语

通过本文的详细指导，您应该能够在Windows平台上成功编译Sigil电子书编辑器。编译过程虽然涉及多个步骤和依赖项，但按照顺序逐步操作，大多数开发者都能顺利完成。自行编译Sigil不仅能让您获得最新功能，还能根据需要进行定制化修改。

Sigil Sigil is a multi-platform EPUB ebook editor 项目地址: https://gitcode.com/gh_mirrors/si/Sigil