sustechthesis

南方科技大学本科学位论文模板 sustechthesis

Southern University of Science and Technology Template for bachelor's thesis.

1. 下载

• 发布版：GitHub Release
• 开发版：直接 Git clone，或者点击绿色 Code 下载 ZIP 压缩包。此版本不保证稳定性，提供给有经验的 TeX 用户使用。

2. Liii STEM 模板

使用 Liii STEM 编辑该模板：

• SUSTech-thesis-undergraduate-v20260308.tmu：模板文件。
• 安装软件后即可打开 TMU 文件进行编辑，并在软件内直接导出 PDF。
• 详细操作请参考 Liii STEM 官方文档。

如遇问题请加入 南科大 墨干/Liii STEM 社区：775378763 进行反馈！

3. LaTeX 模板

请阅读 main.pdf 文档。

3.1 文档架构

• main.tex: 主文档，编排章节顺序。
• main_english.tex: 英文主文档，编排章节顺序。
• config/info.tex: 论文信息，例如：标题、作者等。
• config/preamble.tex: 导言区，导入宏包、宏定义。
• slides.tex: Beamer 幻灯片模板。

3.2 XeLaTeX 构建

• 使用 Makefile：make、make clean 等
• 或使用 latexmk：
  • 构建：latexmk main
  • 清理：latexmk -c main

3.3 使用 LaTeX 在线编辑器

• 使用 南科大 ShareLaTeX（校外地址），使用方式与 Overleaf 相同，上传 ZIP 压缩包后，更改编译器为 XeLaTeX。
• 使用 LoongTeX，使用方式与 VS Code 类似，上传 zip 压缩包后，选择编译的主文档，并将编译选项设置为 XeLaTeX。
• 使用 TeXPage，使用方式与 Overleaf 类似，上传 zip 压缩包后，选择编译的主文档，并将编译选项设置为 XeLaTeX。
• 使用 Overleaf（需要科学上网保证稳定使用），上传 zip 压缩包后，更改编译器为 XeLaTeX。
  • ⚠️ 由于 Overleaf 将免费账户的超时时间缩短到 20 秒，因此如果您在使用免费账户，可能无法成功完成项目的编译。Overleaf 官方声明

4. 更新日志

每个版本的详细更新日志，请见 CHANGELOG.md。

5. 致谢

• 本模板根据南方科技大学教学工作部发布的本科生毕业设计论文相关《撰写规范》和《样例》编写，如有冲突以官网规定为准。
  • 如果《样例》中存在与《撰写规范》中的规定不符之处，以《撰写规范》中的文字叙述为准。

6. 正式版本发布流程

1. 将 CHANGELOG.md 中待发布的内容归档到新版本，并填写发布日期。
2. 同步更新 sustechthesis.cls 中 \ProvidesClass 的日期、版本号，以及 \version 的版本号。
3. 确认所有发布修改已经提交，并且中文论文、英文论文和幻灯片均可正常编译。
4. 创建与类文件版本号一致的 tag，并推送到远端仓库。GitHub Actions 将自动构建并创建 Release。

VERSION=v1.4.0

# 创建并推送 tag
git tag -a "$VERSION" -m "$VERSION"
git push origin "$VERSION"

# 如需撤销尚未正式发布的 tag
git tag -d "$VERSION"
git push --delete origin "$VERSION"