更新文档 (#37)

* 更新文档说明

README.md

@@ -1,12 +1,42 @@
 # NKThesis
 南开大学硕士毕业论文(博士论文)Latex模板
 
-核心标准 [南开大学研究生学位论文写作规范（修订版）20200311](https://graduate.nankai.edu.cn/2021/0122/c23238a337256/page.htm)
+当前标准 [南开大学研究生学位论文写作规范（2024版）](https://graduate.nankai.edu.cn/2017/0222/c23238a56863/page.htm)
 
-## 编写
+## 下载
+
+### 使用 GitHub 管理你的论文 [推荐]
+
+* 直接点击 [use this template](https://github.com/new?template_name=NKThesis&template_owner=NewFuture) 创建一个自己的仓库。（不要fork,除非你想修改进模板）
+* 注意选择私有库 （**`Private`** ），除非你想公开你的论文原始稿。
+* 设置 Repository name等必选项目完点击 `Create Repository` 即可创建
+
+### 下载 Zip 包 （灵活）
+
+* 你也可以直接下载 [NKthesis-maser.zip](https://github.com/NewFuture/NKThesis/archive/refs/heads/master.zip) 在任何地方使用。
+
+## 环境准备
+
+### 安装编译环境
+
+ * 安装 `xelatex`(Tex编译) 
+ * 安装 `biber`(参考文献编译)
+ * Linux 和 MAC 等可能会确实部分字体，如有报错，请自行搜索安装.
+
+### 编译
+
+环境准备好之后，可手动运行 `./buid.cmd` 查看是否正确生成 `main.pdf`.
+
+### 编辑器
+
+基本要求: 自动补全，语法高亮，错误提示,实时预览,光标同步，
+如果不知道用什么编辑器，推荐使用 VSCode, 其他浏览器可自行配置。
+
+* [VS code](https://code.visualstudio.com/) + [LaTeX-Workshop插件](https://github.com/James-Yu/LaTeX-Workshop)
+* [sublime](https://www.sublimetext.com/) + [LatexTools插件](https://github.com/SublimeText/LaTeXTools) +[Sumatra pdf](https://www.sumatrapdfreader.org/download-free-pdf-viewer.html)
 
-### 编译方式
-`xelatex`(Tex编译)+`biber`(参考文献编译)
+
+## 编写
 
 #### 编译脚本
 
@@ -22,13 +52,6 @@ xelatex main
 xelatex main
 ```
 
-### 推荐编辑器和工具
-
-基本要求: 自动补全，语法高亮，错误提示,实时预览,光标同步
-
-* [VS code](https://code.visualstudio.com/) + [LaTeX-Workshop插件](https://github.com/James-Yu/LaTeX-Workshop)
-* [sublime](https://www.sublimetext.com/) + [LatexTools插件](https://github.com/SublimeText/LaTeXTools) +[Sumatra pdf](https://www.sumatrapdfreader.org/download-free-pdf-viewer.html)
-
 ## 说明
 
 ### 文件
@@ -52,9 +75,12 @@ xelatex main
 
 关于此Latex模板, 最早源自网上流传的 Ctex 论坛 milksea 所作版本 (之前无版本不可考，如有了解可补充)。
 
-2018年毕业季前, @darfux 和 @NewFuture 根据 `南开大学研究生学位论文写作规范（修订版）201709`, 以及实际的代码，绘图，等需求，进行修改，并以此作为开源初始本版，使用GitHub管理版本，由社区维护。
+2018年毕业季前, @darfux 和 @NewFuture 根据 `《南开大学研究生学位论文写作规范（修订版）201709》`, 以及实际的代码，绘图，等需求，进行修改，并以此作为开源初始本版，使用GitHub管理版本，由社区维护。
+
+此后主要由南开历届毕业生根据遇到的问题进行更新和维护，thanks to @zzeitt @qianchd @lazyfuzzypringle @gsxab @zlgNow @sszzsupersupersupersuper 等 更新至 《南开大学研究生学位论文写作规范（修订版）2020031》。
+
 
-此后主要由南开历届毕业生根据遇到的问题进行更新和维护，thanks to @zzeitt @qianchd @lazyfuzzypringle @gsxab @zlgNow 等。
+2024 由 @LoveBettygirl 更新至 《南开大学研究生学位论文写作规范（2024版）》
 
 模板格式和编译问题，欢迎之间修改提交Pull Request合并到模板，以便后人。如果对修改/维护模板感兴趣，欢迎加入[维护者](https://github.com/NewFuture/NKThesis/issues)
 

main.tex

@@ -58,16 +58,16 @@
 	论文作者       = 周恩来,
 	学号           = 19190062,
 	指导教师       = {张伯苓 \quad 教授},
-	申请学位       = 硕士, % 请参考2020版规范的2.2节，学术学位应包含类别（×学）和级别（硕士、博士）两部分，专业学位应写名称（如工程硕士）
-	培养单位       = 南开大学, % 请参考2020版规范的2.1节，应填写所在学院（所）的规范全称
+	申请学位       = 硕士, % 请参考规范的2.2节，学术学位应包含类别（×学）和级别（硕士、博士）两部分，专业学位应写名称（如工程硕士）
+	培养单位       = 南开大学, % 请参考规范的2.1节，应填写所在学院（所）的规范全称
 	学科专业       = 文科,
 	研究方向       = 国际政治,
 	答辩委员会主席 = {张伯苓},
 	评阅人 = {严范孙},
 	中图分类号     = ,
 	UDC            = ,
 	学校代码       = 10055,
-	论文完成时间   = 二〇一八年四月, % 请参考2020版规范的2.1节，应填写提交评审的时间
+	论文完成时间   = 二〇二四年五月, % 请参考2024版规范的2.1节，应填写提交评审的时间
 	% 保密设置
 	密级           = 公开,	% 公开 | 限制 | 秘密 | 机密, 若为公开, 不填以下三项
 	非公开论文编号 = ,

tex/abstract.tex

@@ -4,27 +4,34 @@
 
 \begin{zhaiyao}
 
-这里输入中文摘要。
+    这份文档系统地介绍了一个基于南开大学研究生学位论文写作规范的LaTeX模板。
+    内容涵盖了模板的历史、使用说明、常用包介绍以及致谢等部分。
+    模板通过集成绘图包和代码块插入功能，方便用户创建图形和插入代码。
+    同时，感谢前人和校友们的贡献与支持，使得模板得以不断完善，以满足用户的需求。
+
 \end{zhaiyao}
 
 
 
 
 \begin{guanjianci}
-毕业论文；模板
+    毕业论文；模板
 \end{guanjianci}
 
 
 
 \begin{abstract}
 
 
-This is the abstract.
+    This document systematically introduces a LaTeX template based on the writing standards for postgraduate theses at Nankai University.
+    It covers the template's history, usage instructions, introduction of common packages, and acknowledgments.
+    By integrating Tikz for drawing and inserting code blocks, the template facilitates users in creating graphics and inserting code. 
+    Gratitude is extended to predecessors and alumni for their contributions and support, enabling continuous improvement of the template to meet users' needs.
 
 \end{abstract}
 
 
 
 \begin{keywords}
-Thesis; template
-\end{keywords} 
+    Thesis; template
+\end{keywords}

tex/acknowledgements.tex

@@ -3,13 +3,36 @@
 
 %\makeschapterhead{致谢}
 \chapter*{致谢}
-{
-\fangsong
-\setlength{\baselineskip}{16pt}
-\setlength{\parskip}{0pt}
-% 2020版标准4.8
-% 附录：标题要求同各章标题。文字部分仿宋12磅(或小四)，固定值行距16磅，段前段后0磅
-% 实操中有看到未使用仿宋的附录未被图书馆指明格式问题，因此或可酌情选择不设置字体。
-
-感谢您使用本模板。
-}
+ {
+  \fangsong
+  \setlength{\baselineskip}{16pt}
+  \setlength{\parskip}{0pt}
+  % 2020版标准4.8
+  % 附录：标题要求同各章标题。文字部分仿宋12磅(或小四)，固定值行距16磅，段前段后0磅
+  % 实操中有看到未使用仿宋的附录未被图书馆指明格式问题，因此或可酌情选择不设置字体。
+
+  感谢您使用本模板。
+
+  感谢曾经互联网上的无数网友，Ctex 社区，和往年分享南开的Latex 的师生，
+  他们的积累和整理，以及无私奉献，让我们能够站在巨人的肩膀上。
+
+  感谢2018届校友 \href{https://github.com/darfux}{@darfux} 和 \href{https://github.com/newfuture}{@NewFuture}，
+  根据往年流传的南开论文Latex压缩包，结合《南开大学研究生学位论文写作规范（修订版）201709》，完善了第一个版本。
+  采用版本控制和协作维护的方式，将模板开源到GitHub，方便大家使用和贡献。
+
+  % 时间代考 https://github.com/NewFuture/NKThesis/pull/20
+  感谢2022届校友 \href{https://github.com/gsxab}{@gsxab}，
+  参照《南开大学研究生学位论文写作规范（修订版）2020031》更新至2022标准。
+
+  % https://github.com/NewFuture/NKThesis/pull/36
+  感谢 2024届校友 \href{https://github.com/lovebettygirl}{@LoveBettygirl}，
+  参照《南开大学研究生学位论文写作规范（2024版）》更新至2024标准。
+
+  同时感谢 \href{https://github.com/zzeitt}{@zzeitt} 对参考文献格式的更新,
+  以及
+  \href{https://github.com/sszzsupersupersupersuper}{@sszzsupersupersupersuper},
+  \href{https://github.com/qianchd}{@Chengde Qian},
+  \href{https://github.com/zlgnow}{@zlgNow}
+  等同学的对此模板的修改和完善。
+
+ }

tex/introduction.tex

@@ -7,23 +7,29 @@ \chapter{绪论}
 \label{chpt:introduction}
 
 
-本模板参照南开大学学位论文写作规范编写，
-仅仅提供了论文的基本格式，包括章节标题和正文字体、字号等等的设置。
-
+本模板参照南开大学学位论文写作规范《南开大学研究生学位论文写作规范（2024版）》编写，
+提供了论文的基本格式，包括章节标题和正文字体、字号等等的设置。
 
+此模板有主要由南开历届毕业生修改和完善，
+历经 《南开大学研究生学位论文写作规范（修订版）201709》，《南开大学研究生学位论文写作规范（修订版）2020031》修改而来。
 
 您自愿使用这个模板。
 提供本模板的目的是为了给您的论文写作带来方便，然而，
-作者不保证这个模板完全符合学校的要求，也不对由此产生的任何后果负责。
+我们不保证这个模板完全符合学校的要求，也不对由此产生的任何后果负责。
 如果您不同意这些条款，请不要使用这个模板。
 
+同时欢迎您完善此模板，使其更加规范易用，方便未来的学弟学妹们。
+此模板的说明可能不够准确或者过时，
+您可直接在此 \url{https://github.com/NewFuture/NKThesis} 修改对应文件，
+然后发起一个Pull Request，我们会及时更新。
+部分配置可能有误或有兼容问题, 可发起Pull Request或者Issue。
 
 \section{常用内容}
 
 \begin{itemize}
   \item 参考文献的录入请参考\ref{sec:relatedwork:ref};
   \item 图片插入参考\ref{sec:relatedwork:table};
-  \item 分数和公式参考\ref{sec:relatedwork:equation};  
+  \item 分数和公式参考\ref{sec:relatedwork:equation};
   \item Latex绘图工具参考\ref{sec:method:tikz};
-  \item 代码块参考\ref{sec:method:code}; 
+  \item 代码块参考\ref{sec:method:code};
 \end{itemize}

tex/summary.tex

@@ -2,6 +2,9 @@
 % -*- coding: utf-8 -*-
 \chapter{总结展望}
 
-任何问题可在GitHub上发起issue 
+任何问题可在GitHub上发起issue。
 
-\href{https://github.com/NewFuture/NKThesis/issues/new}{github.com/NewFuture/NKThesis/issues/}
+\href{https://github.com/NewFuture/NKThesis/issues/}{github.com/NewFuture/NKThesis/issues/}
+
+
+欢迎大家使用、修改、分享这个模板，也欢迎大家贡献代码，让这个模板更加完善。