Commit a6265512 authored by liziwl's avatar liziwl
Browse files

feat: 添加本科毕业论文模板支持

parent 41d0c50b
Loading
Loading
Loading
Loading
+2 −3
Original line number Diff line number Diff line
@@ -13,8 +13,7 @@ thuthesis-ctan/
dtx-style.sty
*thesis.cls
*thesis.pdf
*example.pdf
*example-report.pdf
*example-*.pdf
spine.pdf
*.hd

+29 −12
Original line number Diff line number Diff line
# 南方科技大学研究生学位论文模板 sustechthesis (SUSTech Thesis Template for Graduate Students)
# 南方科技大学学位论文模板 sustechthesis (SUSTech Thesis Template)

> 支持本科生、硕士、博士学位论文

[![Actions Status](https://github.com/SUSTech-CRA/sustech-master-thesis/actions/workflows/verify-compile.yml/badge.svg)](https://github.com/SUSTech-CRA/sustech-master-thesis/actions/workflows/verify-compile.yml)
[![GitHub downloads](https://img.shields.io/github/downloads/SUSTech-CRA/sustech-master-thesis/total)](https://github.com/SUSTech-CRA/sustech-master-thesis/releases)
@@ -12,10 +14,13 @@
推荐下载 **[发布版](https://github.com/SUSTech-CRA/sustech-master-thesis/releases/latest)****[开发版-预构建](https://github.com/SUSTech-CRA/sustech-master-thesis/releases/tag/dev-latest)** 的模板,里面包括模板使用说明以及示例文档:

* 模板使用说明(**sustechthesis.pdf**
* 学位论文示例文档(**sustechthesis-example.tex**
* 研究生学位论文示例文档(**sustechthesis-example.tex**
* **本科生学位论文示例文档****sustechthesis-example-bachelor.tex**
* 报告示例文档(**sustechthesis-example-report.tex**),包括开题报告、年度考核报告

> 注:模板使用说明尚不完善,仅供参考。主要功能在 `sustech-setup.tex` 配置文件中已有注释说明。
> 注:模板使用说明尚不完善,仅供参考。主要功能在配置文件中已有注释说明:
> - 研究生:`sustech-setup.tex`
> - 本科生:`sustech-setup-bachelor.tex`

**发布版** 包含预生成的 `cls` 模板类文件和文档。**发布版** 一般会比 **开发版-预构建** 晚更新,如急需使用最新版可以使用 **开发版-预构建**

@@ -54,10 +59,11 @@
* `build cls (sustechthesis style file)`:生成 cls 文件,仅供开发者使用。**发布版****开发版-预构建** 已包含 cls 文件,无需自行生成

### 使用 Latexmk(Windows / Linux / macOS)
1. `latexmk sustechthesis-example.tex` 生成学位论文示例文档 sustechthesis-example.pdf;
2. `latexmk sustechthesis-example-report.tex` 生成报告示例文档 sustechthesis-example-report.pdf;
3. `latexmk sustechthesis.dtx` 生成说明文档 sustechthesis.pdf;
4. `latexmk -c` 清理编译生成的辅助文件;
1. `latexmk sustechthesis-example.tex` 生成研究生学位论文示例文档 sustechthesis-example.pdf;
2. `latexmk sustechthesis-example-bachelor.tex` 生成本科生学位论文示例文档 sustechthesis-example-bachelor.pdf;
3. `latexmk sustechthesis-example-report.tex` 生成报告示例文档 sustechthesis-example-report.pdf;
4. `latexmk sustechthesis.dtx` 生成说明文档 sustechthesis.pdf;
5. `latexmk -c` 清理编译生成的辅助文件;

### 使用 Makefile 编译
* `make thesis`     生成论文
@@ -113,10 +119,19 @@ docker run -it --rm \
## 模板结构

### 文档内容
* `sustech-setup.tex` 示例文档基本配置(论文标题、作者等元数据)
* `sustechthesis-example.tex` 学位论文示例文档

#### 研究生论文
* `sustech-setup.tex` 研究生论文基本配置(论文标题、作者等元数据)
* `sustechthesis-example.tex` 研究生学位论文示例文档
* `sustechthesis-example-report.tex` 报告示例文档,包括开题报告,年度考核报告
* `data/` 示例文档章节具体内容
* `data/` 研究生示例文档章节具体内容

#### 本科生论文
* `sustech-setup-bachelor.tex` 本科生论文基本配置
* `sustechthesis-example-bachelor.tex` 本科生学位论文示例文档
* `bachelor-data/` 本科生示例文档章节具体内容

#### 共用资源
* `figures/` 示例文档图片目录
* `ref/` 示例文档参考文献目录

@@ -163,5 +178,7 @@ xetex sustechthesis.ins
## 致谢

* 本模板基于清华大学模板 [ThuThesis v7.1.0](https://github.com/tuna/thuthesis/releases/tag/v7.1.0) 修改。
* 本模板根据南方科技大学研究生院发布的 [《研究生学位论文写作指南》](https://gs.sustech.edu.cn/#/common/index?current_id=9&id=161&article_id=19) 编写,如有冲突以官网规定为准。
  * 如果范例中存在与《写作指南》中的规定不符之处,以《写作指南》中的文字叙述为准。
* 本科生模板部分整合自 [sustechthesis](https://github.com/Iydon/sustechthesis),感谢梁钰栋同学的贡献。
* 研究生模板根据南方科技大学研究生院发布的 [《研究生学位论文写作指南》](https://gs.sustech.edu.cn/#/common/index?current_id=9&id=161&article_id=19) 编写。
* 本科生模板根据南方科技大学教学工作部发布的本科生毕业设计论文相关[《撰写规范》](https://tao.sustech.edu.cn/xueshengfuwu/biyelunwen/)编写。
* 如有冲突以官网规定为准,如果范例中存在与规定不符之处,以官方文字叙述为准。
+29 −0
Original line number Diff line number Diff line
% !TeX root = ../sustechthesis-example-bachelor.tex

% 中英文摘要和关键字

\begin{abstract}
  本模板是南方科技大学本科毕业设计(论文)的 \LaTeX{} 模板。
  
  笔者见到的毕业论文模板,大多是以文类的形式,少部分以宏包的形式,并且在模板中大多掺杂着各式各样的例子(除了维护频率高的模板),
  导致模板文件使用了大部分与形式格式不相关的内容,代码量巨大文档欠缺且不容易修改,出现问题需要查看宏包或者文类的源代码。
  于是,秉着仅提供实现最基本要求的理念,重构了之前所写的 \TeX{} 形式。
  
  模板这种东西不能保证一劳永逸,一方面学校的标准制度都在发生着改变,
  另一方面 \LaTeX{} 的宏包也在发生着改变,早先流行的宏包可能几年后就被"淘汰"掉。
  因此,您的使用与反馈是我不断更新的动力,希望各位不吝赐教。

  \thusetup{
    keywords = {\LaTeX{}, 接口, 本科论文, 南方科技大学},
  }
\end{abstract}

\begin{abstract*}
  This template is a \LaTeX{} template for the undergraduate thesis of Southern University of Science and Technology.
  
  For theses written in English, the English abstract should be placed before the Chinese abstract.

  \thusetup{
    keywords* = {LaTeX, Interface, Undergraduate Thesis, SUSTech},
  }
\end{abstract*}
+18 −0
Original line number Diff line number Diff line
% !TeX root = ../sustechthesis-example-bachelor.tex
% !Mode:: "TeX:UTF-8"

\sustechthesis\ 目前版本为 \version\LaTeX\ 毕业论文模板项目从提出到现在已有两年了。
感谢为本项目贡献代码的开发人员们:
\begin{itemize}
  \item 梁钰栋(南方科技大学,本科 17 级);
  \item 张志炅(南方科技大学,本科 17 级)。
\end{itemize}
以及使用本项目,并提出诸多宝贵的修改意见的使用人员们:
\begin{itemize}
  \item 李未晏(南方科技大学,本科 15 级);
  \item 张尔聪(南方科技大学,本科 15 级)。
\end{itemize}

此外,目前的维护者并非计算机系,可能存在对协议等的错误使用,如果你在本模板中发现任何问题,
请在 GitHub 中提出 \href{https://github.com/SUSTech-CRA/sustech-master-thesis/issues}{Issues}
同时也非常欢迎对代码的贡献!
+15 −0
Original line number Diff line number Diff line
% !TeX root = ../sustechthesis-example-bachelor.tex
% !Mode:: "TeX:UTF-8"

\chapter{附录示例}

这是附录的示例内容。

\section{代码示例}

可以在此处放置代码或其他补充材料。

\begin{verbatim}
def hello_world():
    print("Hello, World!")
\end{verbatim}
Loading