docs: 更新文档

3d006948 · Yu Xiong · f82a7774 · 3d006948 · 3d006948 · 3d006948
Commit 3d006948 authored 3 years ago by Yu Xiong
--- a/chapters/Environments.tex
+++ b/chapters/Environments.tex
@@ -14,7 +14,7 @@
        Windows 10 & \hologo{MiKTeX} & ✔ \\
        Windows 10 & \hologo{TeX}\,Live 2020 & ✔  \\
        Ubuntu 20.04 & \hologo{TeX}\,Live 2021 & ✔ \\
-        南大Tex\footnote{由于未知原因，南大Tex不能使用\hologo{XeLaTeX}编译，请务必选择\hologo{LuaLaTeX}进行编译。} & Overleaf & ✔ \\
+        南大\hologo{TeX}\footnote{由于未知原因，南大\hologo{TeX}不能使用\hologo{XeLaTeX}编译，请务必选择\hologo{LuaLaTeX}进行编译。} & Overleaf & ✔ \\
        \bottomrule
    \end{tabular}
 \end{table}
@@ -47,44 +47,50 @@
 编译产物为\lstinline|njuthesis.pdf|。
-\section{南大Tex在线编译}
+\section{南大\hologo{TeX}在线编译}
-理论上在\href{https://doc.nju.edu.cn/books/latex}{这个网站}能找到一段简介，实际上大家都鸽了。
+本地编译器占用空间过大，对于磁盘空间紧张或者处理器性能有限的同学，不妨尝试本节介绍的在线编译方法\footnote{理论上在\href{https://doc.nju.edu.cn/books/latex}{这个网站}能找到一段平台简介，实际上大家都有意无意地鸽了，下次一定补上。}。
-\subsection{操作步骤}
+\subsection{平台简介}
-1. 下载\href{https://github.com/nju-lug/NJUThesisUndergraduate/archive/refs/heads/master.zip}{模板全部文件}
-2. 使用南京大学统一身份认证信息登录\href{https://tex.nju.edu.cn}{南大Tex}，点击New Project -> Upload Project上传刚刚得到的zip文件，上传后njuthesis.tex、njuthesis.cls等文件应在根目录，目录结构如\cref{{sec:directory}}所示
-3. 在南大Tex项目内页面左上角的Menu中，将编译器改为\hologo{LuaLaTeX}
+\href{https://tex.nju.edu.cn}{南大\hologo{TeX}}基于开源的ShareLaTeX平台，于2021年3月4日正式上线，面向南京大学全体师生开放。
-4. 编写tex文件
+\subsection{操作步骤}
+\begin{enumerate}
+    \item 下载\href{https://github.com/nju-lug/NJUThesisUndergraduate/archive/refs/heads/master.zip}{模板全部文件}
+    \item 访问\href{https://tex.nju.edu.cn}{南大\hologo{TeX}}，点击界面右上方Register，使用\emph{南京大学邮箱}注册账号并登录
+    \item 点击New Project -> Upload Project上传刚刚得到的zip文件，上传后njuthesis.tex、njuthesis.cls等文件应在根目录，目录结构如\cref{{sec:directory}}所示
+    \item 在南大\hologo{TeX}项目内页面左上角的Menu中，将编译器改为\hologo{XeLaTeX}
+    \item 编写论文
+    \item 点击Compile按钮进行预览
+\end{enumerate}
 \section{字体}
-学校论文格式要求的字体一般已经在电脑上包含，如果遇到以下问题，可以依照给出的方案解决。
+学校论文格式要求的字体一般已经在电脑上包含，
+本模板已对不同平台进行了适配。
-不同系统上的字体有所差别，实际输出结果可能会与其他环境有细微不同, 使用时请注意。
+在\cref{tab:fontset}中可以看到，不同系统上使用的字体有所差别，实际输出结果可能存在细微不同, 使用时请注意。出于美观考虑\footnote{以及出于编译速度考虑}，不推荐在Windows平台进行编译\footnote{因为SimSun没有原生粗体，AutoFakeBold效果实在难堪大用}，在Linux平台或者使用了Ubuntu后端的南大\hologo{TeX}上效果更佳。
-\begin{enumerate}
+% \begin{enumerate}
-    \item Ubuntu 下遇到缺失字体 WenQuanYi Zen Hei Mono 或 Times New Roman的问题：
+%     \item Ubuntu 下遇到缺失字体 WenQuanYi Zen Hei Mono 或 Times New Roman的问题：
-       安装对应字体即可。使用以下指令下载：
+%        安装对应字体即可。使用以下指令下载：
-       \begin{lstlisting}
+%        \begin{lstlisting}
-sudo apt install fonts-wqy-zenhei ttf-mscorefonts-installer
+% sudo apt install fonts-wqy-zenhei ttf-mscorefonts-installer
-        \end{lstlisting}
+%         \end{lstlisting}
-    \item macOS 下提示 Package fontspec Warning: Font "STSong" does not contain requested Script "CJK"
+%     \item macOS 下提示 Package fontspec Warning: Font "STSong" does not contain requested Script "CJK"
-       忽略即可，不影响使用。该警告已被抑制。
+%        忽略即可，不影响使用。该警告已被抑制。
-\end{enumerate}
+% \end{enumerate}
 \subsection{字体列表}
-字体定义写于\texttt{profile/font.sty}
+各个系统的默认字体请参考\cref{tab:fontset}。指定字体的相关命令写于\texttt{profile/font.sty}。
+该文件中也预留有使用方正字体或者思源字体的命令，可根据个人喜好进行修改选择。
 \begin{table}[htbp]
    \caption{默认字体清单}
@@ -102,4 +108,4 @@ sudo apt install fonts-wqy-zenhei ttf-mscorefonts-installer
        楷体 & KaiTi & Kaiti~SC & FandolKai-Regular \\
        \bottomrule
    \end{tabular}
 \end{table}
\ No newline at end of file
--- a/chapters/Introduction.tex
+++ b/chapters/Introduction.tex
 \chapter{绪论}
 \section{简介}
-南京大学学士学位论文\LaTeX 模板\cite{njuthesis}基于本科生院的论文撰写规范修改，用于生成符合南京大学学位论文排版要求和相应的国家规范、行业标准的学位论文。
+南京大学学士学位论文\hologo{LaTeX}模板\cite{njuthesis}基于本科生院的论文撰写规范修改，用于生成符合南京大学学位论文排版要求和相应的国家规范、行业标准的学位论文。
-此模板旨在为同学提供毕业论文书写的方便，如有模板问题或者版权问题，请于Github上提出issue。
+此模板通过LPPL协议开源，旨在为同学提供毕业论文书写的方便，如有模板问题或者版权问题，请于Github上提出issue。
 \section{开发环境}
-本模板的开发维护主要在\hologo{MiKTeX}与\hologo{TeX}\,Live\,2020下进行，内部代码主要由\lstinline|expl3|宏包提供的\hologo{LaTeX3}语法实现。
+本模板的开发维护主要在\hologo{MiKTeX}与\hologo{TeX}\,Live\,2021下进行，内部代码主要由\lstinline|expl3|宏包提供的\hologo{LaTeX3}语法实现。
 \section{目录结构}
 \label{sec:directory}
@@ -32,8 +32,6 @@
            reference.sty
 \end{lstlisting}
-\footnote{目录树里面想必可爱温柔的xygg会加上各个文件对应功能的说明的。}
 \subsection{文件说明}
 \begin{description}
    \item [\texttt{abstract.sty}] 定义中英文摘要环境及相关格式

--- a/chapters/Layout.tex
+++ b/chapters/Layout.tex
 \chapter{页面布局}
-\section{总体要求}
+本模板格式依照《11-南京大学毕业论文（设计）的撰写规范和装订要求》进行调整，文件内容详见\cref{chap:standard}
-摘录自《11-南京大学毕业论文（设计）的撰写规范和装订要求》，内容详见\cref{chap:standard}
-\begin{description}
-    \item[论文题目] 三号宋体加粗
-    \item[各部分标题] 四号黑体
-    \item[中文摘要、关键词内容] 小四号楷体
-    \item[英文摘要、关键词内容] 小四号新罗马体（Time New Roman）
-    \item[目录标题] 三号宋体加粗
-    \item[目录内容中章的标题] 四号黑体
-    \item[目录中其他内容] 小四号宋体
-    \item[正文] 小四号宋体（行距1.5倍）
-    \item[参考文献标题] 四号黑体
-    \item[参考文献内容] 小四号宋体
-    \item[注释内容] 五号宋体
-    \item[致谢、附录标题] 四号黑体
-    \item[致谢、附录内容] 小四号宋体（行距1.5倍）
-    \item[非正文部分的页码] 五号罗马数字（Ⅰ、Ⅱ……）
-    \item[论文页码] 页脚居中、五号阿拉伯数字（新罗马体）连续编码
-\end{description}
 \section{封面页}
 \subsection{封面格式}
+\texttt{cover.sty}中定义了生成封面的相关命令
 \subsection{输入个人信息}
 主目录下的\texttt{coverinfo.sty}文件定义了用于文档封面的诸多属性参数，包括
@@ -48,27 +30,38 @@
    \item[\texttt{\textbackslash MentorTitle\textunderscore EN}] 导师职称英文
    \item[\texttt{\textbackslash SubmitDate}] 论文提交日期
 \end{description}
+写作时在此文件中修改相应字符串即可。
-为了使较长的论文题目也能美观地呈现在封面页上，njuthesis类提供了\texttt{TitleLength}这一选项，用于控制封面标题的行数。该命令已于
+为了使较长的论文题目也能美观地呈现在封面页上，njuthesis类提供了\texttt{TitleLength}这一选项，用于控制封面标题的行数。该命令已于\cref{sec:classoptions}进行介绍，可以在\texttt{njuthesis.tex}文件开头的类定义中找到，可选值为1、2、3，缺省值为单行标题。
-\cref{sec:classoptions}进行介绍，可以在\texttt{njuthesis.tex}文件开头的类定义中找到，可选值为1、2、3，缺省值为单行标题。
-如果编写的是毕业设计，请参考\cref{sec:classoptions}，将选项改为design。
+如果编写的是毕业设计，请参考\cref{sec:classoptions}，将Type选项改为design。
 \section{摘要页}
-摘要页一般不插入目录，如有需求请在abstract.sty文件中反注释相关代码
+\texttt{profile/abstract.sty}提供了摘要页格式的定义。
+摘要页一般不插入目录，默认只添加pdf书签。如确实有插入目录的需求，请在abstract.sty文件中定位到如下语句
+\begin{lstlisting}[language=TeX]
+% \phantomsection\addcontentsline{toc}{chapter}{中文摘要}
+\pdfbookmark[0]{中文摘要}{中文摘要}
+\end{lstlisting}
+将其修改为
+\begin{lstlisting}[language=TeX]
+\phantomsection\addcontentsline{toc}{chapter}{中文摘要}
+% \pdfbookmark[0]{中文摘要}{中文摘要}
+\end{lstlisting}
 \section{目录页}
-目录页格式定制于page.sty
+目录页格式定制于\texttt{profile/page.sty}
 \section{正文}
-正文格式定制于page.sty，页边距在package.sty
+正文格式定制于\texttt{profile/page.sty}，页边距在\texttt{profile/packages.sty}
 \section{参考文献页}
-需要使用biber手动编译才会显示
+需要使用biber手动编译才会显示，具体内容参考\cref{chap:reference}
 \section{致谢页}
@@ -80,4 +73,4 @@
 \section{附录页}
-附录放在最后，以英文字母进行编号
+附录放在\texttt{\appendix}命令后，以英文字母进行编号
--- a/chapters/Reference.tex
+++ b/chapters/Reference.tex
 \chapter{引用参考材料}
+\label{chap:reference}
 \hologo{LaTeX}的一大优势在于可以自动生成带超链接的引用条目。
 \section{文档内容的引用}
-使用\lstinline|cleveref|宏包实现了带图、表等项目名称的智能引用。相关定义位于\lstinline|profile/reference.sty|。
+使用\lstinline|cleveref|宏包实现了带图、表等项目名称的智能引用，仅需使用\lstinline|\cref{<label>}|命令。相关定义位于\lstinline|profile/reference.sty|。
 \subsection{图片}

--- a/njuthesis.tex
+++ b/njuthesis.tex
@@ -19,8 +19,8 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \documentclass[
    TitleLength=2,% 选择标题行数，范围是1~3
-    Degree=UG,% 学位 本科：UG
+    Degree=UG,% UG: 本科
-    Type=thesis% thesis：毕业论文，design:毕业设计
+    Type=thesis% thesis: 毕业论文，design: 毕业设计
 ]{njuthesis}
 % 导入参考文献源