开发手册 - sjtug/SJTUThesis GitHub Wiki

本文主要面向模版的开发者。

代码维护

在一代又一代同学们的努力下，SJTUThesis 的基础功能基本得到实现。从 1.0 版开始，模版开始使用 doc 和 DocStrip 工具进行代码的管理。这是一种代码文档化的方法，你可以直接编译 DocStrip 源文件 sjtuthesis.dtx 得到模版的说明文档，也可从中生成模版类的源文件。

相关文档请参阅：

• LaTeX2e for class and package writers
• How to Package Your LaTeX Package
• The DocStrip program

这里推荐一篇知乎用户孟晨的回答，可以帮助理解 doc 和 DocStrip 工具的工作流程： 「这几个\iffalse和\fi是什么意思？ - 孟晨的回答 - 知乎」。

发布新版本

开发仓库为 SJTUTeX，发布仓库为 SJTUThesis。发布新版本前，先给开发仓库分支打上版本号 tag，然后使用 make 工具生成发布用的文件。生成的文件默认在 release 目录下，各个文件的用途见下表：

文件名	描述
sjtuthesis.pdf	模版开发手册
sjtuthesis.tds.zip	按 TDS（TeX Directory Structure）组织的压缩包

发布新版本时，生成的文件除 sjtuthesis.tds.zip 之外，作为 attached binaries 发布。

之后在发布仓库打版本号 tag 以正式发布，GitHub Actions 将会自动生成论文样本变种：

文件名	描述
build-bachelor.pdf	学士学位论文样本
build-master.pdf	硕士学位论文样本