推荐下载 发布版 模板或 开发版-预构建 的模版,里面包括模板使用说明以及示例文档:
- 模板使用说明(sustechthesis.pdf)本模版使用说明尚不完善,仅供参考。主要功能在
sustech-setup.tex
示例文档基本配置文件中已经进行注释。 - 示例文档(sustechthesis-example.pdf)
发布版 包含预生成的 cls
文件和文档,但是一般会比 开发版 晚更新。如急需使用最新版可以使用 开发版-预构建 的版本。
开发版仅供开发者与需要尚未发布的功能的有经验的 TeX 用户使用,不提供任何保证。
下载途径:
- 发布版:
- GitHub Releases:最新发布版的获取途径。
- SUSTech 镜像站:GitHub Releases 的镜像。
- 开发版:
- 预构建 Dev Build:最新预构建的获取途径,根据开发版 master 分支构建。
- GitHub:在 Github 上托管的源码。
- SUSTech-Git:在南方科技大学校内 Git 服务上托管的源码。
每个版本的详细更新日志,请见 CHANGELOG.md。使用文档中也包含了这一内容。
下载发布版的的 zip 包,复制其中的 sustechthesis.*
开头的文件,覆盖现有项目内的旧文件即可(必须包括 dtx
, ins
, cls
)。
从 GitHub clone 项目源码或者下载源码 zip 包,执行命令(Windows 用户在文件夹空白处按 Shift + 鼠标右键
,点击“在此处打开命令行窗口”):
xetex sustechthesis.ins
即可得到 sustechthesis.cls
等模板文件。
- 南科大研究生模板反馈群:320971126
- 南科大LaTeX学习交流群:119667812
- 提交 GitHub Issue
- 讨论区 Discussions
latexmk sustechthesis-example.tex
生成示例论文 sustechthesis-example.pdf;latexmk sustechthesis.dtx
生成说明文档 sustechthesis.pdf;latexmk -c
清理编译生成的辅助文件;
make thesis
生成论文;make viewthesis
生成论文,编译完成开启预览;make all
生成论文,与make thesis
等效;make clean
删除示例文件的中间文件(不含 pdf);make cleanall
删除示例文件的中间文件和 pdf;make wordcount
论文字数统计。make doc
生成文档;make cls
仅生成 cls 模版类文件;
- 使用 Overleaf(需要科学上网保证稳定使用),上传 zip 压缩包后,更改编译器为
XeLaTex
- 使用 南科大 ShareLaTex,使用方式与Overleaf相同,上传 zip 压缩包后,更改编译器为
XeLaTex
,并在主文档的头部\documentclass[degree=master,language=english,cjk-font=external]
设置cjk-font
参数 为external
.
- 在撰写论文时,我们不推荐使用原有的
sustechthesis-example.tex
这一名称。建议将其复制一份,改为其他的名字(如thesis.tex
或者main.tex
)。需要注意,如果使用了来 自data
目录中的tex
文件,则重命名主文件后,其顶端的!TeX root
选项也需要相应修改。 - 需要注意,如果更改了主文件的名称,则需要修改
Makefile
顶端的THESIS
变量定义;或修改latexmk
命令后的参数。 - 如果出现中文字体找不到的编译错误或期望与 Windows 下编译的字体一致,可以设置
cjk-font
参数 为external
,导入包内自带字体。 ⚠️ 提交最终正式版本时,建议在 Windows 下本地编译且设置fontset
参数 为windows
,以保证字体正确。
sustech-setup.tex
示例文档基本配置(论文标题、作者等元数据)sustechthesis-example.tex
示例文档主文件data/
示例文档章节具体内容figures/
示例文档图片路径ref/
示例文档参考文献目录
sustechthesis.cls
模板类文件,由同名 dtx 文件和 ins 文件生成,(开发版不含,运行时生成)。
Makefile
Makefilelatexmkrc
latexmk 配置文件README.md
Readme
- 本模板基于清华大学模板 ThuThesis v7.1.0 修改。
- 本模版根据南方科技大学研究生院发布的相关 学位授予的政策文件 编写,如有冲突以官网规定为准。
- 如果范例中存在与《写作指南》中的规定不符之处,以《写作指南》中的文字叙述为准。