disc0ver-csu / csu-thesis

中南大学学术论文LaTex模板。Central South University Thesis LaTeX Template.

CSUThesis Latex 模板

模板说明

本模板是中南大学论文 Latex 模板 CSUThesis，即 Central South University Thesis LaTeX Template.

学校的指导文件仅提供大致的格式描述与 word 示例，并没有提供官方的 LaTeX 模板，本项目意在维护一个学位论文的非官方标准（De facto standard），创建符合指导文件要求的 LaTeX 模板，供所有本科生研究生使用。

获取模板

下载至本地

由于目前模板更新频繁，我们强烈建议您使用稳定的发布版本，同时请确保您已经阅读了示例文档。

下载途径：

目前仅提供克隆完整 Github 仓库和获取打包的稳定发布版本两个途径

• Github Repository:

  git clone https://github.com/disc0ver-csu/csu-thesis.git

  如果 clone 速度过慢，我们建议您使用代理并添加--depth参数。

  git clone https://github.com/disc0ver-csu/csu-thesis.git --depth=1

• Github Releases:

  Release 页面

Overleaf

随着v1.0.5发布，我们正式提供了 Overleaf 模板，链接见Overleaf Gallery。这次真的不是愚人节玩笑。习惯在 Overleaf 上进行写作的同学可以从上面的模板链接创建自己的项目。

⚠️ 目前 Overleaf 上虽然已是正式版本，英文字体使用默认设置，中文字体适配上传了simhei.tff，simsun.ttc等中易字体（即Word中熟悉的黑体与宋体），但不确定是否还存在其他 Linux 系统适配的问题。另外由于学校写作指导文件要求的部分商用字体（比如 Times New Romance）不可在 Linux 上使用，我们采取的方案是进行相近字体的替换。所以即便你的写作过程是在Overleaf上完成的，我们仍建议您在 Windows 操作系统上编译最终版论文。

环境配置

如果希望在本地使用本模板，除了获取模板文件以外，您还需要自行配置 TeX 排版系统环境。我们常说的 TeX 并不是一个单独的程序，而是一套由排版引擎，编译程序，各类宏包与说明文档等构成的复杂排版系统，被称为 Tex document production system。为了方便用户使用，软件开发者们开发了 TeX 的发行版，提供了整套系统以及便捷的配置方式。

我们推荐使用Tex Live和MiKTeX的最新版，因为这两种发行版，对 GNU/Linux，macOS 以及 Windows 都提供了较好的支持。需要说明的是，我们不建议使用CTeX 套装，该套装对 Windows 环境下 MikTeX 基础上增加了中文的支持，但是 2012 年后不再更新，已经相对过时，故不推荐使用（一些使用过 CTeX 的同学在配置环境时会出现冲突导致编译失败）。

下图是一些常见的 TeX 发行版以及支持的操作系统

TeX 发行版	GNU/Linux	macOS	Windows
TeX Live	✔️	✔️	✔️
MiKTeX	✔️	✔️	✔️
MacTeX	❌	✔️	❌
CTeX	❌	❌	✔️

模板使用

在content 目录下撰写文章内容，之后使用如下方式编译生成 pdf 格式文件。我们希望模板使用者有基本的 latex 撰写经验以及命令行使用能力，模板也配置了一些相关工具来帮助编译。

GUI 界面

如果你使用的开发环境是 Visual Studio Code + (Tex Live | MiKTex)，我们在 .vscode 目录中提供了对应的 LaTeX 插件的配置。需要你在 Visual Studio Code 中安装 LateX Workshop 插件，然后将 .vscode 目录中 setting.json 文件中的配置，拷贝添加至用户配置（ Ctrl+p 然后点击 设置 (json) ）中，该配置全局有效，类似教程可参考配置 VSCode 作为 LaTeX 编辑器。

完成配置后，在任意的 .tex 文件下执行倒数第二个 recipe，即 ▷ Recipe: xelatex -> biber -> xelatex 即可编译你的论文。

如果你需要令配置文件仅对本项目生效，可以 setting.json 将重命名为 settings.json ，再在 Visual Studio Code 中按 ctrl + p，输入 reload win，回车，重载 Visual Studio Code 即可。

注意，第一次编译时需要下载大量宏包，请不要担心，耐心等待一段时间。编译过程正式开始时，Visual Studio Code 的底部将会出现一个字符绘制的进度条。如果等待时间过长，请考虑配置 Tex Live | MiKTeX 的软件源，或者配置代理服务器。

命令行

• Windows 用户

  你可以在项目目录使用latexmk进行编译，推荐latexmk是因为参考文献等带来的交叉引用问题需要多次编译（使用xelatex和biber），而latexmk可以帮助我们免除此苦恼。相关配置在latexmkrc中。你可以按如下方式使用该工具。

  latexmk                     # 编译生成 csuthesis_main.pdf
  latexmk csuthesis_main.tex  # 给出完整参数，编译生成 csuthesis_main.pdf
  latexmk -c                  # 删除除 pdf 文件外的生成文件
  latexmk -C                  # 删除包含 pdf 文件在内的所有生成文件

  你也可以直接使用xelatex和biber来进行编译，一般而言这是不必要的，但是如果你改动了模板参数想要进行测试，或者希望编译生成没有参考文献的文件，这种方式可以提供更多帮助。

  xelatex -interaction=nonstopmode -file-line-error csuthesis_main.tex  # 编译生成无目录与参考文献的文件
  biber csuthesis_main                                                  # 编译参考文献
  xelatex -interaction=nonstopmode -file-line-error csuthesis_main.tex  # 再次编译

• Linux 和 macOS 用户

  由于写作指导所要求的 Times New Roman 等字体在 Linux 下并不可用，虽然模板会替换字体为对应环境下其他字体，我们强烈建议模板使用者在 Windows 系统环境下进行最终版本文章的编译。

  你可以使用模板提供的Makefile工具进行编译：

  make all                      # 编译生成 csuthesis_main.pdf
  make clean                    # 删除除 pdf 文件外的生成文件
  make cleanall                 # 删除包含 pdf 文件在内的所有生成文件
  make wordcount                # 字数统计

  当然你也可以使用latexmk或者xelatex配合biber编译生成 pdf 文件。

参与维护

欢迎大家参与项目维护！

请阅读 docs 目录中的项目开发者指导等文档，明确开发流程和注意事项 😉。

其他

关于 LaTeX

LaTeX is not a word processor! Instead, LaTeX encourages authors not to worry too much about the appearance of their documents but to concentrate on getting the right content.

TeX 作为一个优秀的排版软件，在学术界特别是数学、物理学和计算机科学界十分流行，而建立在其上的 LaTeX 也成为国外许多出版商一直在使用的工具。Office Word 虽然具备强大的功能与灵活性，但对于形式固定的论文，排版、编号、参考文献等简单事务反而会带来很多困难与麻烦，对于一些需要通篇修改的问题，要想达到 LaTeX 的效率，Word 对使用者并不算友好。使用 Latex 模板的一大好处是可以避免繁琐的格式设置，使作者可以专注于内容创作。对于全篇格式的修改，仅需要修改 tex 文件所使用的模板一行内容，重新编译便可得到具备新样式的文档，这对于习惯使用 Word 创作的人来说很不可思议。

关于项目

清华大学、上海交通大学、**科学技术大学、**科学院大学、武汉大学等国内高校都有长期维护、较为稳定的学术论文 LaTeX 模板，相比较之下，中南大学虽有一些前辈做出实践，比如最初设计出中南大学博士学位论文 LaTeX 模板的@CSGrandeur，参考武汉大学学术论文自行设计出本科毕业设计论文 LaTeX 模板的@burst-bao等。但目前这些在 Github 上可查到的项目多数已有相当时间没有维护，或者缺乏像上述高校的学术论文模板简易、高效且可靠的设计。

本项目在我校各位前辈们设计的模板基础上进行了重构，使用部分 LaTex3 语法，吸收借鉴清华大学、上海交通大学和**科学技术大学的学术论文 LaTeX 模板设计的经验，并针对最新的《中南大学毕业设计(论文)模版》文件进行修订。项目已从之前的个人转移至 disc0ver 组织下进行维护，希望更多的同学可以贡献力量，一起维护该项目。

一些毕业流程上与 word 差异的考虑

• 首要条件：和你的导师沟通好，如果他知道 Latex 最好，不知道的话询问他是否接受在 PDF 上进行审阅
• 查重 ：未测试生成的 PDF 是否可以被正确识别，有勇士直接使用 PDF 查重失败或成功的可以提 issue 告诉我，附上编译环境和查重系统。变通方法如下：直接打开 Latex 生成的 PDF 文件，word 会提示将 PDF 转为 docx 文件，转换后字体样式可能会回到 word 自带（Linux 下 texlive 使用的宋体和黑体是 Fandol 系列字体,windows 没有）,但是内容全部保留，格式也会保留大部分,直接用该 docx 可以完美通过查重。如果因为各种原因有转为 docx 的需求也可以采用此方法！
• 格式审查: 各不同院系尺度不同，无法一概而论。

更新日志

• 2021/02/07：发布 v0.1.4 版本提供不同选项接口，配置不同的封面。
• 2021/01/29: 添加开发者文档，Git 使用文档，提供 Overleaf 上测试版链接。
• 2021/01/26: 发布 v0.1.2 版本，支持代码段和算法描述，修复附录编号问题，完善 README
• 2021/01/25: Edwardzcn 重构项目，发布 v0.1.1 版本，对照学校指导文件重新修改样式，并修复目录显示的问题
• 2019/12/13: BlurryLight 进行了一些代码更新
• 2019/05/01: BlurryLight 在CSU-Thesis-Latex-Template 的基础上进行修改出本科学位论文模板

致谢

• 感谢最先制作出中南大学博士学位论文 LaTeX 模板的郭大侠@CSGrandeur
• 感谢添加本科学位论文样式支持的@BlurryLight
• 感谢帮助重构项目并进行测试的@burst-bao和@Wp-Zhang以及为独立使用 LaTeX 进行毕业论文写作提供宝贵经验的 16 级姜析阅学长
• 感谢CTeX-kit 提供了 LaTeX 的中文支持
• 感谢上海交通大学学位论文 LaTeX 模板的维护者们@sjtug 与清华大学学位论文 LaTeX 模板的维护者们@tuna给予的宝贵设计经验

csu-thesis's Issues

关于图片的编号1.1能否修改为1-1

图片的编号1.1能否修改为1-1

bug: 无法自定义扉页底部月份

问题描述

在undergraduate.cls文件中将扉页底部的月份强制限定为了6月，导致info.tex中自定义的月份失效

关于正文的标点符号

在模板正文中，标点符号不对，而摘要里的中文标点符号是对的，请问在哪里修改呢？

截图

本地环境 (请补充下面信息):

• OS: [e.g. Windows 10]
• TeX 发行版: [e.g. TeXLive2020, MiKTeX20
  
  19]
• TeX 编辑器: [e.g. TeXStudio, Visual Studio Code]
  

README：重新编排内容以及修复错别字

使用说明中编译过程custhesis_main.tex应修改为csuthesis_main.tex，需要测试完整的编译流程，最好提供一个便捷脚本或者makefile。

部分内容需要重写or转移至Wiki（比如TeX环境配置教学）。

再次求助，公式的1.1能否改为1-1

#26
对于表格和图表的编号已经可以修改了，请问公式的需要怎么修改呢

设置type=doctor/master编译报错的问题

作者您好，我目前准备采用该模板撰写研究生学位论文，但是生成过程中一直报错，不知该设置是否可用？或者是我的设置错误导致的？

mac的Texpad无法编译

请确认

• 是当前最新的 Release 版本
• 在项目 README 指南 中没有找到解决办法

问题描述

mac的Texpad无法编译， 一直在转圈，无法生成pdf。

截图

本地环境 (请补充下面信息):

• OS: MacOS
• TeX 发行版: MacTex 2022
• TeX 编辑器: TexPad 1.9.6

关于README中错别字的修改建议

README——其他——关于项目 中第一段最后一句“并且缺乏像上述高校的学术论文模板的高校、易用的设计”中的“高校”为错别字，应改为“高效”。

Times New Roman在Linux平台可以Nimbus Roman开源字体替代

其字体差异可以见以下连接，不仔细对比很难看出差异，有相关的文章讨论此话题Times New Roman 与 LaTeX 。使用 newtx 系列宏包可以很方便的引入此字体。

feat: 中英文摘要部分不支持先定义环境再定义关键字

描述

目前的版本，编辑摘要页面时必须先使用指令keywordscn或keywordsen定义关键字，然后才可以使用abstractzh或abstracten摘要环境。如果顺序相反则会导致编译不通过。

更符合使用习惯的方式是摘要内容，再给出关键字。现有实现中，由于在摘要环境中使用了关键字定义中全局定义的指令，如果交换顺序，会出现使用未定义指令的问题。

要求

• 尽量兼容原有接口
• 实际输出内容应与环境与关键字定义顺序无关

已知bug：Windows环境下编译的目录页一级标题错位

使用环境

• OS: Windows 10
• Tex发行版: Tex Live 2020

问题描述

Windows环境下编译可能会产生目录页一级标题错位如下图：

日志报错为hbox溢出，不过在我本地和Overleaf上的测试版(Linux环境)，都没有出现类似问题，bug还在定位，不影响使用，后续应该会修复。

摘要“关键词”三个字未加黑

请确认

• 是当前最新的 CSUThesis Release 版本
• 本地已安装好 TeXLive 或其他 TeX 发行版
• 重新安装 TeXLive 和本模板后，问题仍然存在

Bug 描述

中文摘要处，“关键词”部分未加黑。

复现步骤

直接编译就能看到，overleaf或本地编译都是这样

截图

但是在undergraduate.cls文件中第358行处，已经使用加黑命令了，不过还是没有加黑。

bug: 图表编号相关问题

请确认

• [ √] 是当前最新的 Release 版本
• [ √] 在项目 README 指南 中没有找到解决办法

问题描述

使用overleaf进行图片插入时，图片的序号错乱了，如何更改
如果我想要自定义图片的序号，该如何操作

截图

本地环境 (请补充下面信息):

• OS: [e.g. Windows 11]
• TeX 发行版: [e.g. TeXLive2021, MiKTeX2019]
• TeX 编辑器: [e.g. overleaf]

📜 Issue 提交模板

请描述该需求尝试解决的问题

目前在 Github 上提供了三种 Issue 模板，与 CSU Thesis LaTeX Template 本身相关的问题需求与 Bug 反馈请按照模板格式提交。

截图

参考文献标号右对齐问题

请确认

• 是当前最新的 CSUThesis Release 版本
• 本地已安装好 TeXLive 或其他 TeX 发行版
• 重新安装 TeXLive 和本模板后，问题仍然存在

Bug 描述

学校要求参考文献标号应该是左对齐的，然而模板是右对齐的，如图所示：

[9]和[10]应该是左括号对齐，但是模板是右括号对齐的。

请问目录的第n章的字体能否调成不加粗的呢

如题

关于代码环境美化的问题

请描述该需求尝试解决的问题

目前这个代码环境有点丑

请描述您认为可行的解决方案

使用monaco字体->MONACO.zip
并将在csuthesis.cls文件中更改\lstset如下：

\newfontfamily\menlo{MONACO.ttf}
\RequirePackage{listings}
\lstset{
    breaklines,                                 % 自动将长的代码行换行排版
    extendedchars=false,                        % 解决代码跨页时，章节标题，页眉等汉字不显示的问题
    backgroundcolor=\color[rgb]{0.96,0.96,0.96},% 背景颜色
    keywordstyle=\color{blue}\bfseries,         % 关键字颜色
    identifierstyle=\color{black},              % 普通标识符颜色
    commentstyle=\color[rgb]{0,0.6,0},          % 注释颜色
    stringstyle=\color[rgb]{0.58,0,0.82},       % 字符串颜色
    showstringspaces=false,                     % 不显示字符串内的空格
    numbers=left,                               % 显示行号
    numberstyle=\tiny\menlo,                    % 设置数字字体
    basicstyle=\small\menlo,                    % 设置基本字体
    captionpos=t,                               % title在上方(在bottom即为b)
    frame=single,                               % 设置代码框形式
    rulecolor=\color[rgb]{0.8,0.8,0.8},         % 设置代码框颜色
}  

经过以上设置代码界面如下图所示：

这样就美观一些了

feat: Overleaf需求

越来越多的同学习惯用Overleaf编写latex项目，由于维护者已经毕业，目前移植Overleaf还未完成。

英文摘要“ABSTRACT”与英文摘要标题标题间距不对的问题

请确认

• 是当前最新的 CSUThesis Release 版本
• 本地已安装好 TeXLive 或其他 TeX 发行版
• 重新安装 TeXLive 和本模板后，问题仍然存在

Bug 描述

英文摘要“ABSTRACT”与英文摘要标题标题的上下间距是不相等的，更改行间距后这个不相等会很明显

是不是因为在undergraduate.cls这个地方少了一行\vspace{0pt}

希望作者能上传一份到scienhub.com的LaTex共享写作平台

请描述该需求尝试解决的问题

请描述您认为可行的解决方案

考虑过的替代方案

请问如何设置1.5倍行距

请确认

• 是当前最新的 Release 版本
• 在项目 README 指南 中没有找到解决办法

问题描述

截图

本地环境 (请补充下面信息):

• OS: [e.g. Windows 10]
• TeX 发行版: [e.g. TeXLive2020, MiKTeX2019]
• TeX 编辑器: [e.g. TeXStudio, Visual Studio Code]

最后一次求助了！关于封面字体

封面内容要求小二号楷体GB2312，现在字体大小是三号，请问应该怎么修改呢

Wiki: 考虑搬运部分内容至wiki页面

目前经过 @loctempt 的填充，我们的开发者文档以及Git指导都在项目docs目录下，我考虑可以向项目Wiki进行迁移。

个人认为主要有以下两个优势：

• Wiki界面可以生成侧栏，使文档目录更加清晰，对不了解Git环境配置、TeX环境配置等多项内容的新人更加友好，同时也方便查阅。
• 可以进行在线编辑，撰写Wiki。

不过考虑到有一些大型项目比如Angular也不提供Wiki页面，而是保留仓库中的docs目录，这种方式也不是最优，我能想到的一个缺点就Wiki从docs目录迁出会导致不易同时维护项目中的文档内容，虽然说从git底层看，二者并无区别，参见本地添加或编辑wiki页面。

可以略作讨论，决定是否迁出。

feat: 同步 Overleaf 和 GitHub

请描述该需求尝试解决的问题

Overleaf 的版本是 v1.0.5， 而当前的仓库版本是 v1.0.7，懒人希望能在 Overleaf 用上最新版本hhhh。

请描述您认为可行的解决方案

将 Overleaf 的项目与仓库绑定，这样就能同步了，可以参考一下 https://www.overleaf.com/learn/how-to/Using_Git_and_GitHub 的 Overleaf GitHub Synchronization。

考虑过的替代方案

如果想要确保版本稳定性，可以手动传 release 上去，但根据需求感觉项目稳定性没必要这么高。