docs: 更新文档

README.md

@@ -4,7 +4,7 @@
 [![overleaf](https://img.shields.io/badge/overleaf-supported-brightgreen)](https://tex.nju.edu.cn)
 ![build status](https://github.com/nju-lug/NJUThesis/actions/workflows/build.yml/badge.svg)
 
-> 此项目是基于[NJU thesis 2021](https://github.com/FengChendian/NJUThesis2021)的重构版本，目前本科生版本**已经基本重构完成**，硕博论文**正在**根据研究生院的文件重构，但研究生院的规定并不完善，因此部分格式可能会参考本科的，**如果院系另有要求，请自行修改**。
+> 此项目是基于[NJU thesis 2021](https://github.com/FengChendian/NJUThesis2021)的重构版本，目前本科生版本**已经基本重构完成**，硕博论文**正在**根据研究生院的文件重构，但研究生院的规定并不完善，因此部分格式可能会参考本科的，**如果院系另有要求，请自行修改或者提交issue**。
 
 原来的[NJU thesis 2021](https://github.com/FengChendian/NJUThesis2021)模板太过古老并且不支持硕士、博士论文，目前难以维护，因此为了模板的可持续发展，现在将对该项目进行重构，项目挂载于[NJU-LUG](https://github.com/nju-lug)组织仓库下，目前已[发布在CTAN](https://ctan.org/pkg/njuthesis)。
 
@@ -24,7 +24,7 @@
 - 模板支持`latexmk`、`xelatex`、`lualatex`三种编译方式
 - 如果使用`latexmk`，请务必使用完整的命令`latexmk -xelatex`以免产生不必要的问题
 - 如果使用`xelatex`或`lualatex`，需要按照`xelatex/lualatex` -> `biber` -> `xelatex/lualatex` -> `xelatex/lualatex`的顺序编译四次
-- 仓库中.vscode附带一份VScode的LaTeX WorkShop的配置文件，可根据需要使用
+- 仓库中`.vscode`附带一份VScode的LaTeX WorkShop的配置文件，可根据需要使用
 
 ### [南大TeX](https://tex.nju.edu.cn)编译
 
@@ -67,7 +67,7 @@
 
 ## 贡献
 
-如果你发现了模板的问题，欢迎在Github中提交issue或者PR。
+如果你发现了模板的问题，欢迎在Github中[提交issue](https://github.com/nju-lug/NJUThesis/issues)或者PR。
 
 ## 许可
 

chapters/Layout.tex

@@ -105,6 +105,18 @@ secondmentor 用于指定是否在封面打印第二导师
 
 \texttt{profile/abstract.sty}提供了摘要页格式的定义。
 
+\begin{lstlisting}
+\begin{abstract}
+    <text>
+    \keywords{<keywords>}
+\end{abstract}
+
+\begin{englishabstract}
+    <text>
+    \englishkeywords{<keywords>}
+\end{englishabstract}
+\end{lstlisting}
+
 摘要页一般不插入目录，默认只添加pdf书签。如确实有插入目录的需求，请在\texttt{abstract.sty}文件中定位到如下语句
 \begin{lstlisting}[language=TeX]
 % \phantomsection\addcontentsline{toc}{chapter}{中文摘要}
@@ -122,6 +134,12 @@ secondmentor 用于指定是否在封面打印第二导师
 
 使用preface环境定义
 
+\begin{lstlisting}
+\begin{preface}
+    <text>
+\end{preface}
+\end{lstlisting}
+
 \section{目录页}
 
 目录页格式定制于\texttt{profile/page.sty}
@@ -142,6 +160,12 @@ secondmentor 用于指定是否在封面打印第二导师
 
 同前言，使用acknowledgement环境
 
+\begin{lstlisting}
+\begin{acknowledgement}
+    <text>
+\end{acknowledgement}
+\end{lstlisting}
+
 \section{附录页}
 
 附录放在\lstinline|\appendix|命令后，以英文字母进行编号

chapters/Preface.tex

@@ -2,7 +2,9 @@
 
 我想，每个\hologo{LaTeX}极客的最终目标都是写一个属于自己的class，而自己很幸运地在\href{https://git.nju.edu.cn/nju-lug/lug-introduction}{NJU Linux User Group}获得了这样的机会。
 
-这个模板也算送给自己的毕业礼物好了。
+感慨万千，一时语塞。实在不知道写啥好，表演个朗诵课文吧。
+
+\zhlipsum[108-110][name=zhufu]
 
 \vspace{1cm}
 \begin{flushright}

chapters/Reference.tex

@@ -4,6 +4,9 @@
 \hologo{LaTeX}的一大优势在于可以自动生成带超链接的引用条目。
 
 \section{超链接}
+
+\lstinline|\href{<url>}{<name>}|
+
 \section{文档内容的引用}
 
 使用\lstinline|cleveref|宏包实现了带图、表等项目名称的智能引用，仅需使用\lstinline|\cref{<label>}|命令。相关定义位于\lstinline|profile/reference.sty|。

njuthesis.cls

 \NeedsTeXFormat{LaTeX2e}
-\ProvidesExplClass{njuthesis}{2021-09-12}{0.8.2}{NJU Thesis LaTeX Template}
+\ProvidesExplClass{njuthesis}{2021-09-12}{0.8.3}{NJU Thesis LaTeX Template}
 
 % 通过类传递参数
 \RequirePackage{l3keys2e}

njuthesis.tex

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % NJU Thesis
 % 南京大学毕业论文LaTeX模板
-% Version 0.8.2 (2021-09-12)
+% Version 0.8.3 (2021-09-12)
 %
 % 请关注项目地址以获取最新变化
 % https://github.com/nju-lug/NJUThesis