Skip to content

Latest commit

 

History

History
213 lines (139 loc) · 13.4 KB

README.md

File metadata and controls

213 lines (139 loc) · 13.4 KB

sysuthesis-unofficial

sysuthesis-unofficial是旨在为中山大学熟悉LaTeX语言的研究生提供一个方便易用的学位论文写作模版,其设置的排版格式力求尽可能符合《中山大学研究生学位论文格式要求》。

本模版暂时没有为本科生学位论文设置格式,如果您是本科生,请移步至sysu-thesis。如果您没有接触过LaTeX,又不打算花费时间和精力来入门,推荐您使用Microsoft Office套装来编写您的学位论文。

声明

本模版不是官方模版,无法保证它完全符合学校的相关要求,在开始使用前,您同意,任何由于本模板而引起的论文格式审查问题与本模板作者无关。

使用方法

本模版仅支持XeTeX排版引擎,其相应的编译命令称为 xelatex,字符编码仅支持UTF-8,进行编译时,您需要使用正确编译器。本模版需要编译的主文件为 thesis.tex,在编译时请选择 xelatex 编译命令,由于是中文文档并且与 BibTeX 配合使用,请遵从以下编译步骤:

  • xelatex: 生成 .aux 文件,里面包含了文档的结构信息和所有的内部引用(包括参考文献的引用);
  • bibtex: BibTeX 读取 .aux 文件,根据给定的 .bib 文件中指定的参考文献条目,生成 .bbl 文件,为格式化的参考文献列表;
  • xelatex: 将 .bbl 文件的参考文献列表嵌入到文档当中;
  • xelatex: 确保文档中的引用和编号与参考文献列表之间的对应关系是正确的,确保文档中的交叉引用(例如章节、图表、公式等)无误。

如此您将得到一个最终输出的正确的、完整的 PDF 文件。

Overleaf 用户请直接点击以下图片直接食用

Overleaf

然而 Overleaf 对免费用户只开放了1分钟以内的编译时长,如果您的项目编译时长超过1分钟,建议在本地编译,并养成时常备份的好习惯。

如果您使用 Visual Studio Code 来作为 LaTeX 编辑器,您需要设置 settings.json 来定制您的编译链,配置代码如 codes 文件夹里面的 vsc_config.json 所示。

模版选项说明

  • doctype=[thesis|proposal], 可选(默认:thesis),论文类型,thesis 为学位论文,proposal 为开题报告。
  • printmode=[final|checkmode|blindmode], 可选(默认:final),打印模式,final 为终稿,checkmode 为查重模式,blindmode 为盲审模式。
  • language= [chinese|english] or [zh|en], 可选(默认:chinese),论文的主要语言。
  • blankleft=[true|false], 可选(默认:false),使无内容的偶数页空白。

以下为 ctexbook 文档类的选项,可将此类参数从本模板传递过去

  • [openright|openany], 可选(默认:openright),章节分页,奇数页或任意页开始新章。

  • fontset=[fandol|windows|macnew|ubuntu], 可选(默认:fandol),字体设置,请根据使用的计算机系统选择适当的选项。

  • [fleqn|leqno], 可选,公式对齐方式,默认公式居中对齐编号居右对齐,fleqn 选项将使公式居左对齐,leqno 选项将使公式编号居左对齐。

  • [final|draft], 可选(默认:final),选择 draft 选项将启用草稿模式,这时:

    1. 文档中的图形(如图片)将以一个框的形式显示,而不是实际的图像内容。
    2. lstlisting 环境中的内容将不见,只留有标签。
    3. 异常长的行会显示为黑色盒子,需要调整文本以适应页面宽度。

    草稿模式主要用于在编辑文档时快速查看页面布局和图形位置,同时减少编译时间。注意要将此选项放在第一个,否则不起作用。

示例:

\documentclass[doctype=thesis,printmode=final,language=zh,blankleft,openright,fontset=fandol]{sysuthesis}

此外,关于论文信息的设置,您还需要按照 setup.tex 文件中的格式一一配置好。

注意事项

本模版预设的封面、原创性声明及使用授权说明页、摘要页均以物理与天文学院的格式要求为主。如果您所在学院的要求与本模版预设的不同,建议参考以下 项的说明,正文以及参考文献部分各学院的要求应该是一致的。

  • 一般而言,通常不需要在中英文之间添加额外的空格,但为了代码的可读性(良好的习惯),还是建议在中文字符和 English 字符之间加上空格。

  • 对于扉页,如果对本模版预设的扉页不满意,可以使用 pdfpages 宏包中的 \includepdf 命令导入您的扉页的 PDF 文件,例如

    \includepdf{titlepage.pdf}
    

    其中 titlepage.pdf 为扉页的 PDF 文件。

  • 同样的,对于原创性及使用授权说明页,也可以利用类似的方法:

    \includepdf{copyrightpage.pdf}
    

    其中 copyrightpage.pdf 为扉页的 PDF 文件(可以为签字过后的扫描文件)。

  • 对于摘要页,在使用类似上述的命令之后,此外还应将摘要加入目录,因此建议使用以下命令

    \addcontentsline{toc}{chapter}{\protect 摘\hspace*{2\ccwd}要}
    \addcontentsline{toe}{chapter}{Abstract (In Chinese)}
    \includepdf{abstract-zh.pdf}
    \addcontentsline{toc}{chapter}{ABSTRACT}
    \addcontentsline{toe}{chapter}{Abstract (In English)}
    \includepdf{abstract-en.pdf}
    

    其中 abstract-zh.pdfabstract-en.pdf 分别为中英文摘要页的 PDF 文件。

  • 对于插图和表格的标题,本模版推荐使用 bicaption 宏包的 \bicaption 命令,具体用法为:

    \bicaption[中文短标题]{中文标题}[英文短标题]{英文标题}
    

    其中,短标题在插图索引或者表格索引中展示,而标题则在插图下方或者表格上方展示。

  • 在图表标题中,出现了引用文献后字号变回正文字号的问题,该问题有一个简单的解决方法,即使用 {\cite{key}} 来避免上述问题发生。在弃用 cite 宏包之后,该问题似乎已经解决了。

更新描述

v1.1.5 2024/04/12

  • 增加了 blindthis[<replace>]{<content>} 命令,用于在盲审模式下(即 printmode=blindmode)替换内容。在非盲审模式下,该命令不会有任何效果。在盲审模式下,该命令会将 <content> 替换为 <replace>;如果直接使用 \blindthis{<content>} 命令,则内容不会打印出来。
  • 微调 publicationsachievements 环境中标签的左边距。

v1.1.4 2024/04/10

  • 修复了附录章在英文模式下的标签名,从 Chapter 改为 Appendix。并且新增了两个无标签章的命令 \notagchapter\notagchapteren,用于不带章节标签的章节。
  • 对图表标题的对齐方式进行了调整,使之居中,并将之前第二标题的额外空格去除。
  • 完善 algorithm2e 标题的格式,使之与图表标题一致。

v1.1.3 2024/03/30

  • 在模板参数中对 gbt7714 宏包进行参数传递,可以使用著者-出版年制的参考文献格式。
  • 使用 algorithm2e 宏包定制算法环境。
  • 增加 language 选项,可选 chinese | english ( <default> = chinese),或 zh | en。如果选项为 language=english(或 language=en),这将会将章节图表等的标题语言设置为英文。
  • \info 命令改为 \sysuset,对模版的一些参数(如图表标签名和 acknowledgements 环境名称等)任由用户自定义,详情见 setup.tex 文件。
  • openanyopenrightfontsetctexbook 文档类的选项,不应作为模板的选项,现已移除。
  • 撤销将 \ref 命令的引用格式重设为 (\autoref{key}) 的更改。
  • 解决了一些与 hyperref 宏包的冲突问题。

v1.1.2 2024/03/14

  • 放弃自制的 sysuthesis.bst,改用 gbt7714 宏包。
  • 增加 count_chinese.py Python 脚本,用于统计中文字数。
  • 重新设置论文信息的设置方式,即键值对(key-value)的格式,更加友好。
  • 修改了checkmode的版面,去除无效的空白页。
  • 添加了中山大学的颜色 sysugreensysuredspablue
  • 给出了长表格的示例,并配置了 tabularray 的风格。

v1.1.1 2023/03/30

  • 使用 \raggedbottom 调整页面的垂直对齐方式, 当页面内容不足时, 这将减少页面顶部和底部之间的间距,使得页面看起来更加紧凑。

  • 增加 fontset 选项 (<default> = fandol),指定CTeX宏集加载的字库,详情请查看CTeX宏集的具体说明。例如,如果您的系统为Windows,则可以用以下选项:

    \documentclass[doctype=thesis,printmode=final,openright,blankleft,fontset=windows]{sysuthesis}
    

    如果您在 Overleaf 上编译,则可以设置为:

    \documentclass[doctype=thesis,printmode=final,openright,blankleft,fontset=ubuntu]{sysuthesis}
    

    目前 Mac OS 可以暂时使用 fontset=macnew,依然解决不了找不到对应字体的警告问题,但无伤大雅。

  • 对一些笔误进行了修改。

v1.1.0 2023/03/03

  • 增加以下模版选项:

    • doctype,可选 thesis|proposal (<default> = thesis),分别为学位论文和开题报告的格式。

    • printmode,可选 final|checkmode|blindmode (<default> = final),分别为终稿、查重和盲审的打印模式。

    • openright|openany,互为 true|false (<default> = openright)。openright 选项为每一章在右页(奇数页)开始,openany 选项为在上一章结束的下一页开始。

    • blankleft (<default> = false),当 blankleft = true 时,章节结束的偶数页如果没有内容,使之空白,但页码计数器仍然有效。

  • 增加了 appendixenvpublicationsachievements 环境,分别为附录、学术论文发表列表和学术成果列表的环境。

  • 对论文扉页进行了微调。

  • 修改 lstlisting 双语标题格式,微调相关颜色。

  • 增加了 NASA/ADS Export Citation 的期刊名命令,不需要再手动修改以避免编译出错。

v1.0.1 2022/03/06

  • 最新适配物理与天文学院的格式要求,调整了参考文献的引用格式并添加文献类型标识,将中文与西文之间的一个半角字符的自动间距关闭。\texttt 命令只在本文档用以展示命令,不建议大家使用。

v1.0 2022/02/23

  • 最初版本。

致谢

本模版在编写的过程当中,遇到了不少问题,也参考了许多小组以及个人的工具和模版:

向你们致以真诚的敬意和由衷的感谢!

推荐读物

本文档不是LaTeX的入门教程,因此不会对复杂的LaTeX代码进行介绍。如果您只是用来编写您的学位论文,完全可以将源代码里的内容替换成你的内容,然后经过若干次复制、粘贴和修改,最终您会得到你所需要的文档。然而,有时候您想实现一些自己的个性化内容,希望下面推荐的读物可以帮助到您:

最后祝您使用愉快!

联系方式

任何有关本模版的问题以及建议,欢迎通过以下其一方式来联系我:

  • 本模版的企鹅交流群:929324613,主要用于本模版的维护和交流,常用,能够及时回复消息;
  • 我的个人B站号,常用,一般能很快看到消息;
  • 我的联系邮箱:[email protected]