Skip to content
Snippets Groups Projects
njuthesis.dtx 99 KiB
Newer Older
% \iffalse meta-comment
% !TeX program  = XeLaTeX
% !TeX encoding = UTF-8
% Copyright (C) 2021 
% by Nanjing University Linux User Group <nju.lug@yaoge123.cn>
% It may be distributed and/or modified under the conditions of the
% LaTeX Project Public License (LPPL), either version 1.3c of this
% license or (at your option) any later version.  The latest version
% of this license is in the file
%    https://www.latex-project.org/lppl.txt
% This work has the LPPL maintenance status `maintained'.
%
% The Current Maintainer of this work is Yu Xiong.
%
% This work consists of the files njuthesis.dtx,
%           and the derived files njuthesis.ins,
%                                 njuthesis.cls,
%                                 njuthesis.pdf,
%                             and README.md.
%
% -----------------------------------------------------------------------
% The development version of the template can be found at
%    https://github.com/nju-lug/NJUThesis
%
% for those people who are interested.
%
%<*internal>
\iffalse
%</internal>
%
%<*internal>
\fi
\begingroup
  \def\NameOfLaTeXe{LaTeX2e}
\expandafter\endgroup\ifx\NameOfLaTeXe\fmtname\else
\csname fi\endcsname
%</internal>
%
%<*install>
\input docstrip.tex
\keepsilent
\askforoverwritefalse

\preamble

Copyright (C) 2021 
by Nanjing University Linux User Group <nju.lug@yaoge123.cn>

This file may be distributed and/or modified under the conditions of
the LaTeX Project Public License, either version 1.3c of this license
or (at your option) any later version.  The latest version of this
license is in:

   http://www.latex-project.org/lppl.txt

and version 1.3 or later is part of all distributions of LaTeX version
2005/12/01 or later.

To produce the documentation run the original source files ending with `.dtx'
through XeTeX.
    
\endpreamble

\generate{
  \usedir{tex/latex/njuthesis}
    \file{\jobname.cls}        {\from{\jobname.dtx}{class}}
%</install>
%<*internal>
  \usedir{source/latex/njuthesis}
    \file{\jobname.ins}        {\from{\jobname.dtx}{install}}
%</internal>
%<*install>
}

\obeyspaces
\Msg{*************************************************************}
\Msg{*                                                           *}
\Msg{* To finish the installation you have to move the following *}
\Msg{* files into a directory searched by TeX:                   *}
\Msg{*                                                           *}
\Msg{* The recommended directory is TDS:tex/latex/njuthesis      *}
\Msg{*                                                           *}
\Msg{*     njuthesis.cls                                         *}
\Msg{*     njuthesis.ins                                         *}
\Msg{*                                                           *}
\Msg{* To produce the documentation, run the file njuthesis.dtx  *}
\Msg{* through XeLaTeX.                                          *}
\Msg{*                                                           *}
\Msg{* Happy TeXing!                                             *}
\Msg{*                                                           *}
\Msg{*************************************************************}

\endbatchfile
%</install>
%
%<*internal>
\fi
%</internal>
%
%<class>\NeedsTeXFormat{LaTeX2e}
%<class>\RequirePackage{expl3}
%<class>\GetIdInfo  $Id: njuthesis.dtx 0.12.2 2021-12-03 23:00:00 +0800  NJU LUG <nju.lug@yaoge123.cn> $
%<class>  { Thesis template for Nanjing University }
%<class>\ProvidesExplClass{njuthesis}
%<class>{\ExplFileDate}{\ExplFileVersion}{\ExplFileDescription}
\ProvidesFile{njuthesis.dtx}
\documentclass{ctxdoc}
\usepackage{floatrow,tabularray,njuvisual}
\usepackage[firstpage=true]{background}
\backgroundsetup{contents={\njuemblem[white!85!gray]{22cm}{!}},scale=1,angle=0,hshift=-4cm}
Yu Xiong's avatar
Yu Xiong committed
\setlist[1]{labelindent=0.5em}
\UseTblrLibrary{booktabs,siunitx,diagbox}
\DefTblrTemplate{caption-tag}{default}{表\hspace{0.25em}\thetable}
\SetTblrStyle{caption-tag}{font=\bfseries}
\DefTblrTemplate{caption-sep}{default}{\quad}
\begin{document}
  \DocInput{njuthesis.dtx}
Yu Xiong's avatar
Yu Xiong committed
  \PrintChanges
\end{document}
%</driver>
% \fi
%
Yu Xiong's avatar
Yu Xiong committed
% \title{\color{njuviolet}{The \cls{njuthesis} class\\ 南京大学学位论文模板}}
Yu Xiong's avatar
Yu Xiong committed
% 
% \author{^^A
Yu Xiong's avatar
Yu Xiong committed
% Nanjing University Linux User Group
% \thanks{E-mail: \href{mailto:nju.lug@yaoge123.cn}{nju.lug@yaoge123.cn}}}
% \date{v0.12.2 \\ Released 2021-12-03}
Yu Xiong's avatar
Yu Xiong committed
% \changes{v0.1}{2021/09/04}{开始开发。}
% \changes{v0.2}{2021/09/07}{初步搭建了可用的模板。}
% \changes{v0.3}{2021/09/09}{使用自动构建工具进行测试。}
% \changes{v0.4}{2021/09/09}{将个人信息使用内置命令输入。}
% \changes{v0.5}{2021/09/10}{新增了对第二导师的支持。}
% \changes{v0.6}{2021/09/10}{封装个人信息}
% \changes{v0.6}{2021/09/10}{实现自动打包发布。}
Yu Xiong's avatar
Yu Xiong committed
% \changes{v0.7}{2021/09/11}{增加对研究生模板的支持}
% \changes{v0.7}{2021/09/12}{将njuthesis发布在CTAN。}
Yu Xiong's avatar
Yu Xiong committed
% \changes{v0.8}{2021/09/12}{修复已知问题,进行公开宣传。}
Yu Xiong's avatar
Yu Xiong committed
% \changes{v0.9}{2021/09/15}{使用DocStrip合并模板文件。}
Yu Xiong's avatar
Yu Xiong committed
% \changes{v0.9}{2021/09/15}{大幅度修改宏名称以符合\hologo{LaTeX3}规范。}
% \changes{v0.9}{2021/09/15}{进一步完善文档。}
Yu Xiong's avatar
Yu Xiong committed
% \changes{v0.10}{2021/09/24}{删除了生成自述文件的代码。}
% \changes{v0.12}{2021/11/28}{删除内置的 \pkg{njuvisual} 代码。}
% \changes{v0.12}{2021/11/29}{更新了说明文档封面设计。}
% \changes{v0.12}{2021/11/30}{区分测试文件和空白模板。}
Yu Xiong's avatar
Yu Xiong committed
%
% \begin{abstract}
Yu Xiong's avatar
Yu Xiong committed
% 南京大学学位论文 \hologo{LaTeX} 模板 \cls{njuthesis} 基于本科生院的论文撰写
% 规范制作,同时参考研究生院提供的硕士、博士学位材料包,用于生成符合南京大学学
% 位论文排版要求和相应的国家规范、行业标准的学位论文,旨在为同学提供毕业论文书
% 写的方便。
Yu Xiong's avatar
Yu Xiong committed
% \end{abstract}
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% \def\abstractname{Abstract}
% \begin{abstract}
Yu Xiong's avatar
Yu Xiong committed
% The \cls{njuthesis} class is intended for typesetting Nanjing University
% dissertations with \hologo{LaTeX}, providing support for bachelor, masters,  
% and doctoral thesis. 
Yu Xiong's avatar
Yu Xiong committed
% \end{abstract}
%
Yu Xiong's avatar
Yu Xiong committed
% \vspace{2cm}
Yu Xiong's avatar
Yu Xiong committed
% \def\abstractname{特别声明}
% \begin{abstract}
Yu Xiong's avatar
Yu Xiong committed
% 请注意,本模板仍未完成开发,出现bug或者文档不完善属于正常情况,欢迎提交
% issue 或 Pull Request。
%
% 本模板未经学校官方部门的审核,作者不对使用本模板产生的格式审查问题负责。
Yu Xiong's avatar
Yu Xiong committed
% 
% \href{https://git.nju.edu.cn/nju-lug/lug-introduction}{NJU LUG}始终欢迎
% 您的加入!
Yu Xiong's avatar
Yu Xiong committed
% \end{abstract}
%
Yu Xiong's avatar
Yu Xiong committed
% \clearpage
Yu Xiong's avatar
Yu Xiong committed
%
% \setcounter{tocdepth}{4}
Yu Xiong's avatar
Yu Xiong committed
% \tableofcontents
% \EnableDocumentation
% 
% \begin{documentation}
Yu Xiong's avatar
Yu Xiong committed
% \section{模板介绍}
% \cls{njuthesis},即南京大学学位论文模板,是一个由南京大学 LUG 组织维护的,用于处理本校学生毕业论文排版需求的 \hologo{LaTeX} 模板。
Yu Xiong's avatar
Yu Xiong committed
%
% \subsection{历史沿革}
% 十几年来,多位热心校友发布过自己编写的模板,在GitHub上可考的包括
% \begin{enumerate}
%  \item 杨文博(\href{http://yangwenbo.com/}{@solrex})的\href{https://github.com/solrex/njuthesis}{南京大学学位论文\hologo{LaTeX}模板}(2010) 
%  \item \href{https://github.com/fireblue}{@fireblue}基于solrex模板的的\href{https://github.com/fireblue/NJUThesis}{南京大学学位论文\hologo{LaTeX}模板}(2013)
%  \item \href{https://github.com/wenhai-zheng}{@wenhai-zheng}的\href{https://github.com/wenhai-zheng/NJUThesis}{NJUThesis}(2013)  
%  \item 曹增乐(\href{https://github.com/ZLCao}{@ZLCao})的\href{https://github.com/ZLCao/NJUBachelor}{NJUBachelor}(2013-2016)
%  \item 胡海星(\href{http://haixing-hu.github.io/}{@Haixing-Hu})的\href{https://github.com/Haixing-Hu/nju-thesis}{NJU-Thesis}(2013 - 2018)
%  \item 张楚珩(\href{https://github.com/zhangchuheng123}{@zhangchuheng123})基于胡海星模板的\href{https://github.com/zhangchuheng123/NJUThesis}{NJUThesis}(2016)
%  \item 蒋炎岩(\href{http://ics.nju.edu.cn/~jyy/}{@jiangyy})的\href{https://github.com/jiangyy/njuthesis}{南京大学山寨\hologo{LyX}研究生毕业论文模板}(2017)
%  \item \href{https://github.com/njuHan}{@njuHan}基于胡海星模板的\href{https://github.com/njuHan/njuthesis-nju-thesis-template/}{NJU-Thesis}(2018 - 2021)
%  \item 饶安逸(\href{https://anyirao.com/}{@AnyiRao})基于张楚珩模板的\href{https://github.com/AnyiRao/NJUThesis2018/}{NJU Thesis 2018}(2018)
%  \item 赵懿晨(\href{https://fengchendian.github.io/about.html}{@FengChendian})基于饶安逸模板的\href{https://github.com/FengChendian/NJUThesis2021}{NJU Thesis 2021}(2021)
% \end{enumerate}
% 至于不幸而未进行代码版本管理的,甚至于说以压缩包形式流传于各人硬盘中的,就更不可计数了。
%
Yu Xiong's avatar
Yu Xiong committed
% 与其让一千个学生做一千种不同的模板,不如有人牵起头来,集中力量办大事。因此,南京大学 Linux User Group 的有志之士在2021年暑期联合起来,参考以上的现成模板,兼顾友校\href{https://ctan.org/pkg/thuthesis}{thuthesis}、\href{https://ctan.org/pkg/fduthesis}{fduthesis}等优秀项目,构建了这一全新模板,力求通过\hologo{LaTeX3}语法和清晰的接口实现良好的易用性和可维护性。
% 目前,本模板的主要维护者包括:
%
% \begin{itemize}
%     \item 赵懿晨
%     \item 熊煜
Yu Xiong's avatar
Yu Xiong committed
%     \item 马畅
% \subsection{君\hologo{LaTeX}本当上手}
% \hologo{LaTeX}并不是一种零门槛的语言,亦不是南京大学学生的必备技能。有同学听到“\emph{给毕业论文交差也得写代码}”这种事情就头疼,实在是我们不愿意见到而必须要面对的情况。目前,中文互联网上的 \hologo{LaTeX} 写作教程不能说屈指可数,起码也是汗牛充栋,比较著名的包括刘海洋的《\hologo{LaTeX}入门》等等都是不错的参考资料。然而如何快速准确找到所需要的用法,尤其是 \hologo{LaTeX3} 的新接口,需要一定的时间或者良好的英文阅读能力。在本文档的写作中,我们无力从盘古开天辟地开始从头构建您的相关知识体系,只能\emph{尽力做到有求必应},在需要的地方顺带提一嘴,保证您少走点弯路。
%
% \subsection{关于本说明手册}
%
Yu Xiong's avatar
Yu Xiong committed
% 本模板通过\textsc{DocStrip}进行维护,实际上是一种\emph{文学编程}。文学编程的本体是那些用来说明的文字,按写书写文章的方式组织。
% \file{njuthesis.dtx}包含njuthesis模板的所有信息。前半部分为模板说明,即各种常用命令与必要的使用方法;后半部分为代码实现,为带有详细注释的\hologo{TeX}源代码。后者配合附录,为有意了解本模板细节的同学提供简明的指引。
Yu Xiong's avatar
Yu Xiong committed
% 下文中将出现若干特殊格式,用来指示代码组件。譬如,\file{file-example.xxx}为文件名,\pkg{pkg-example}为宏包名,\opt{opt-example}为选项名,\env{env-example}为需要|\begin{}|和|\end{}|的环境名,等。
Yu Xiong's avatar
Yu Xiong committed
%
% 如果您在使用最新版模板时发现了任何问题,抑或有意向参与本模板的维护,请通过GitHub issue或者QQ群聊联系LUG。
% \section{安装}
Yu Xiong's avatar
Yu Xiong committed
% \label{sec:setup}
Yu Xiong's avatar
Yu Xiong committed
% 本节主要介绍本宏包的获取、安装以及编译方式。
Yu Xiong's avatar
Yu Xiong committed
% \subsection{获取模板}
Yu Xiong's avatar
Yu Xiong committed
% \subsubsection{自动安装}
Yu Xiong's avatar
Yu Xiong committed
% \href{https://ctan.org/pkg/njuthesis}{\cls{njuthesis}} 已经于2021年9月12日发布在
% CTAN(Comprehensive \hologo{TeX} Archive Network).
% \href{https://ctan.org/pkg/njuvisual}{\pkg{njuvisual}} 也已于同年11月28日发布。
Yu Xiong's avatar
Yu Xiong committed
% 两者将进入\hologo{TeX}\,Live 2022。目前,南大\hologo{TeX}已预先安装本模板,详见
% \ref{subsec:onlinecompile}。
% 您可以通过 \hologo{TeX}\,Live Manager 或者 \hologo{MiKTeX} Console 等图形化包管理器
% 直接安装并使用以上两个宏包最新的稳定版,也可以使用 \pkg{tlmgr} 的终端命令:
Yu Xiong's avatar
Yu Xiong committed
% \begin{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%   tlmgr install njuthesis njuvisual
Yu Xiong's avatar
Yu Xiong committed
% \end{ctexexam}
% 
Yu Xiong's avatar
Yu Xiong committed
% 我们\emph{强烈建议}使用这一类安装方式。
Yu Xiong's avatar
Yu Xiong committed
% 另一方面,CTAN版需要开发者手动上传,版本更新具有滞后性。
% 如果使用时遇到了问题,推荐使用以下方式获取最新正式版。
Yu Xiong's avatar
Yu Xiong committed
% \subsubsection{下载正式版}
Yu Xiong's avatar
Yu Xiong committed
% \label{subsubsec:downloadrtm}
Yu Xiong's avatar
Yu Xiong committed
% 本模板不定期将已有的新功能和问题修复打包为新的正式发行版,下载方式包括:
Yu Xiong's avatar
Yu Xiong committed
% \href{https://github.com/nju-lug/NJUThesis/releases/latest}{Github Releases 页面}
% 以及 \href{https://mirror.nju.edu.cn/download/app/NJUThesis%20%E8%AE%BA%E6%96%87%E6%A8%A1%E6%9D%BF}{南大镜像下载页}
% (在校内使用时后者具有显著更快的速度)。可供下载的文件包括:
% \begin{description}
%   \item[\file{njuthesis-v*.pdf}] 模板说明文档(本文件)。
%   \item[\file{njuthesis-v*.zip}] 空白模板,包括格式文件、范本以及编辑器配置文件。可以直接用于本地或上传在线编译。
%   \item[\file{njuthesis-ctan-v*.zip}] 用于上传 CTAN 的源码包,普通用户请忽略。
% \end{description}
Yu Xiong's avatar
Yu Xiong committed
% \subsubsection{下载开发版}
Yu Xiong's avatar
Yu Xiong committed
% 最新开发进度会提交在本项目的
% \href{https://github.com/nju-lug/NJUThesis}{Github仓库}。
% 如果由于网络原因不便访问,也可以从
% \href{https://git.nju.edu.cn/nju-lug/nju-latex-templates/njuthesis}{NJU Git 同步镜像} 下载项目工程文件。
%
% 仓库主目录下提供了自动安装脚本,用于释放供编译的空白模板和格式文件。Windows 用户请直接双击打
% 开 \file{install-win.bat};其他平台(包括 macOS 和 Linux)用户请在终端使用 bash 运行 
% \file{install-unix.sh} 。该脚本会生成一个 \file{mythesis/} 目录以便从头写作,仓库内其
% 余内容都可以尽情删除。
%
% 请注意,如果仅仅是希望使用这个模板撰写论文,请无论如何都不要从编译 \file{source/} 文件夹下
% 的源代码开始,这样做只会浪费生命中宝贵的数分钟时间。如果遇到了问题,请优先提出 issue。我们只
% 推荐希望参与开发的同学接触 \file{.dtx} 文件。
Yu Xiong's avatar
Yu Xiong committed
% \subsection{文件构成}
%
% \cls{njuthesis}由数量众多的文件组成,\emph{所有可能遇到的}文件如表 \ref{tab:njuthesisfiles} 所示。
Yu Xiong's avatar
Yu Xiong committed
% 其中标注为黄色的内容仅供开发使用,并不会在发行版中出现。
Yu Xiong's avatar
Yu Xiong committed
%
% \begin{table}[ht]
%   \caption{\cls{njuthesis}文件构成}
%   \label{tab:njuthesisfiles}
%   \centering
%   \begin{tabular}{lp{18em}}
%     \toprule
%     名称 & 说明 \\
%     \midrule
Yu Xiong's avatar
Yu Xiong committed
%     \file{.vscode}                        & Visual Studio Code 配置文件 \\
%     \file{latexmkrc}                      & latexmk 配置文件 \\
%     \file{LICENSE}                        & 许可证 \\
%     \file{njuthesis.bib}                  & 示例参考文献列表 \\
%     \file{njuthesis.cls}                  & 模板文档类 \\
%     \color{njuyellow}\file{njuthesis.dtx} & 文档类源代码 \\
%     \color{njuyellow}\file{njuthesis.ins} & 文档类安装脚本 \\
%     \file{njuthesis.pdf}                  & 用户手册(本文档) \\
%     \file{njuthesis-sample.tex}           & 示例文档,不妨以此为基础撰写论文 \\
%     \file{README.md}                      & 自述文件 \\
Yu Xiong's avatar
Yu Xiong committed
%     \bottomrule
%   \end{tabular}
% \end{table}
%
% \subsection{本地编译}
Yu Xiong's avatar
Yu Xiong committed
% \label{subsec:localcompile}
Yu Xiong's avatar
Yu Xiong committed
% 本地编译的安装过程分为两个阶段:安装 \hologo{TeX} 发行版以及配置编辑器。前者提供了可以被命
% 令行终端调用的编译程序,后者则提供了语法高亮、自动编译等人性化功能。
% \subsubsection{安装\hologo{TeX}发行版}
%
Yu Xiong's avatar
Yu Xiong committed
% 首先需要下载并安装 \hologo{TeX} 软件发行版,各操作系统适用情况请参考表
% \ref {tab:texdistribution}。第一次编译前请务必通过 MiKTeX Console、TeX Live 
% Manager 等图形化程序或 \pkg{tlmgr}\emph{手动更新全部宏包}以避免潜在的兼容性问题。
%
% \begin{table}[H]
%   \centering
%   \caption{\hologo{TeX} 软件发行版一览}
%   \label{tab:texdistribution}
%   \begin{tabular}{cccc}
%     \toprule
%     \hologo{TeX}        & Windows   & macOS     & Linux     \\
%     \midrule
archxy's avatar
archxy committed
%     \hologo{TeX}\,Live  & $\bullet$ & $\bullet$ & $\bullet$ \\
%     mac\hologo{TeX}     &           & $\bullet$ &           \\
Yu Xiong's avatar
Yu Xiong committed
%     \hologo{MiKTeX}     & $\bullet$ & $\bullet$ & $\bullet$ \\
%     \bottomrule
%   \end{tabular}
% \end{table}
% 以下是一些值得注意的要点:
% \begin{itemize}
%   \item 校园网环境中访问\href{https://mirror.nju.edu.cn/download/app/TeX%20%E6%8E%92%E7%89%88%E7%B3%BB%E7%BB%9F}{南大镜像站}可以获得最佳的下载体验。
%   \item 使用最新的发行版,即版本号为2021或者21。
%   \item 对于 Windows 和 macOS 用户,更推荐轻量化的 \hologo{MiKTeX} 套件。
%   \item Linux用户请尽可能下载 full 版本,如 |texlive-full|。换言之,下载最大的软件包。
Yu Xiong's avatar
Yu Xiong committed
%   \item 对于一部分用到新版本特性的宏包,\cls{njuthesis}内置了版本检查\footnote{譬如遇到l3过时问题请运行 |tlmgr update l3packages|。},请确认各宏包已升级至最新版。
% \end{itemize}
Yu Xiong's avatar
Yu Xiong committed
%
% \subsubsection{配置编辑器}
% \changes{v0.11}{2021/11/23}{提供TeXstudio配置文件。}
Yu Xiong's avatar
Yu Xiong committed
%
% 配置完编译器后,还需要一个\emph{文本编辑器}来完成\file{.tex}文件内容的写作。
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% 关于具体使用哪一种,至今仍有相当一部分人认为Windows自带的\emph{记事本}是最好的文本编辑器。
% 但对于本项目而言,在此诚心诚意地推荐你使用\emph{更现代更美观更多功能}的编辑器,譬如
% \emph{安装了 LaTeX Workshop 插件的 \href{https://code.visualstudio.com/}{Visual Studio Code}}。你也可以根据个人的喜好随意使用 TeXworks、TeXstudio 等编辑器,顺手就行。
Yu Xiong's avatar
Yu Xiong committed
%
% \cls{njuthesis} 为一些常见编辑器提供了配置文件,如
% \begin{description}
%   \item[Visual Studio Code] 本模板在\file{.vscode/}中提供一份\hologo{LaTeX} Workshop 插件的简易配置,在打开文件夹后将自动导入,可以省略初始配置步骤直接使用。
%   \item[TeXstudio] 本模板提供 \file{conf.txsprofile},可以使用快捷键 |alt+O+P| 导入配置文件。为了简化流程\footnote{当然,也可以设置为使用 \hologo{XeLaTeX} 编译,然后按照 \ref{subsubsec:compileseq} 内容使用快捷键 |F8| 手动编译参考文献。},该配置文件使用 \pkg{latexmk},第一次编译前请参考下一节内容安装 Perl。
% \end{description}
Yu Xiong's avatar
Yu Xiong committed
%
% \subsubsection{编译顺序}
% \label{subsubsec:compileseq}
% \hologo{TeX} 本身是命令行程序,通过不同的命令调用所需的编译引擎。
% 尽管上述的文本编辑器已经提供了自动化编译的方法,为了便于排查运行错误,以下通过具体终端命令简要描述编译过程。
%
% 编译本模板概括为如下步骤:生成初始文档,编译参考文献,生成页码、编号、目录,需要编译4次。
Yu Xiong's avatar
Yu Xiong committed
% \emph{假设即将使用的文件名为 \file{njuthesis-sample.tex}},
% 应采用以下命令顺序进行编译,以生成内容正确的 \file{njuthesis-sample.pdf}。输出的 PDF 文档位于同一目录下。
Yu Xiong's avatar
Yu Xiong committed
% 编译命令具体为引擎名称加文件名,在编译 \file{.tex} 文件时,文件扩展名可以省略不写。
% 现阶段 \cls{njuthesis} 仅支持 \hologo{XeLaTeX} 与 \hologo{LuaLaTeX}。请注意,几种命令的输出文件基本相同,可以任取一种;但如果你不清楚这两种编译引擎的区别,我们建议优先使用|latexmk -xelatex|。
%
% \subparagraph{使用 \hologo{XeLaTeX}}
% \begin{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%   xelatex njuthesis-sample
%   biber njuthesis-sample
%   xelatex njuthesis-sample
%   xelatex njuthesis-sample
% \end{ctexexam}
% \subparagraph{使用 \hologo{LuaLaTeX}}
% \begin{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%   lualatex njuthesis-sample
%   biber njuthesis-sample
%   lualatex njuthesis-sample
%   lualatex njuthesis-sample
% \end{ctexexam}
%
% \subparagraph{使用 \pkg{latexmk}}
% \href{https://mg.readthedocs.io/latexmk.html}{\pkg{latexmk}} 是一个基于 Perl 脚本的自动编译工具,宗旨是通过单一命令简化上述的多次编译流程。在使用该命令前,请确保安装了以下软件:
% \begin{description}
%   \item[Perl] 一般预装于 macOS 和 Linux,而 Windows 用户需要单独安装 \href{https://strawberryperl.com/}{Strawberry Perl}。
%   \item[\pkg{latexmk}] \hologo{MiKTeX}已预装;如果终端找不到|latexmk|命令,\hologo{TeX}\,Live 用户需使用 \pkg{tlmgr} 单独安装。
% \end{description}
%
% 该命令的使用方法为
% \begin{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%   latexmk njuthesis-sample
% \end{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
% 如需指定编译器,可以加入 |-xelatex| 或 |-lualatex| 参数,例如指定 \hologo{XeLaTeX} 的命令为
% \begin{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%   latexmk -xelatex njuthesis-sample
% 此外可以选择使用以下命令清理编译生成的临时文件。
% \begin{ctexexam}
%   latexmk -c
% \end{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%
% \subsection{在线编译}
Yu Xiong's avatar
Yu Xiong committed
% \label{subsec:onlinecompile}
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% 相信你在接触了本地编译以后,很快就会意识到一些十分显然的事实,譬如\hologo{TeX}编译器安装过程较为漫长\footnote{因此对于 Windows 推荐 \hologo{MiKTeX}。},占用空间过大,而且在一部分处理器性能不佳的电脑上需要较长编译时间\footnote{同一个模板在 Linux 编译可以相对 Windows 节省一半耗时。}。拒绝接受这些麻烦的同学不妨尝试本节介绍的在线编译方法。
Yu Xiong's avatar
Yu Xiong committed
%
% \subsubsection{南大\hologo{TeX}平台简介}
Yu Xiong's avatar
Yu Xiong committed
% \changes{v0.2}{2021/09/07}{添加对南大\hologo{TeX}的支持。}
Yu Xiong's avatar
Yu Xiong committed
%
% \href{https://tex.nju.edu.cn}{南大\hologo{TeX}}基于开源的 ShareLaTeX 平台\footnote{理论上在\href{https://doc.nju.edu.cn/books/latex}{这个网站}能找到一段平台简介,实际上大家都有意无意地鸽了,下次一定补上。},于2021年3月4日正式上线,是 \href{https://sci.nju.edu.cn/}{eScience 中心}为南大在校师生提供的 \hologo{LaTeX} 在线编译平台,首次使用需凭学校邮箱自助注册账号。
Yu Xiong's avatar
Yu Xiong committed
%
% \subsubsection{操作步骤}
%
% \begin{enumerate}
%     \item 访问\href{https://tex.nju.edu.cn}{南大\hologo{TeX}},点击界面右上方Register,使用\emph{南京大学邮箱}注册账号并登录
%     \item 在项目页面左上角的Menu中,将编译器改为\hologo{XeLaTeX}或者\hologo{LuaLaTeX}
%     \item 仿照 \file{njuthesis-sample.tex} 编写论文
Yu Xiong's avatar
Yu Xiong committed
%     \item 点击Compile按钮进行编译和预览
% \end{enumerate}
%
Yu Xiong's avatar
Yu Xiong committed
% 注意,由于南大\hologo{TeX}已预装\cls{njuthesis},可以直接编写正文,无需\file{.cls}等格式文件。如果需要使用新版模板,也可以点击New Project -> Upload Project上传 \ref{subsubsec:downloadrtm} 得到的压缩文件。
%
% \subsubsection{关于Overleaf}
Yu Xiong's avatar
Yu Xiong committed
%
% 由于\href{https://www.overleaf.com/}{Overleaf} 平台的\hologo{TeX}\,Live版本停留在2020,\texttt{cleveref}包在引用章节时会生成错误的标签,引发格式错误;而南大\hologo{TeX}通过及时更新规避了若干问题。因此\emph{请务必不要使用Overleaf官网进行编译}。
Yu Xiong's avatar
Yu Xiong committed
%
% \subsubsection{关于TeXPage}
Yu Xiong's avatar
Yu Xiong committed
%
% \href{https://www.texpage.com/}{TeXPage} 是国人研发的\hologo{LaTeX}在线编辑器,当前版本已具备较为完善的编辑编译功能,而且免费版相对 Overleaf 增加了公式识别、编辑历史等实用工具,也可以作为一个备选项。目前的缺憾是对于 \cls{njuthesis} 的编译速度较慢。 
Yu Xiong's avatar
Yu Xiong committed
%
% \section{使用方法}
Yu Xiong's avatar
Yu Xiong committed
% \subsection{标准结构}
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% 典型的\cls{njuthesis}主文件结构应该如下所示:
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% \begin{ctexexam}
%   \documentclass[<options>]{njuthesis}
%   \njusetup { info = {<info>} }
%   \graphicspath{{figure/}}
%   \addbibresource{njuthesis.bib}
%   \begin{document}
%   \maketitle
%   <abstract>
%   <preface>
%   \tableofcontents
%   \listoffigures
%   \listoftables
%   \mainmatter
%   <text>
%   \printbibliography[heading=bibintoc,title=参考文献]
%   <acknowledgement>
%   \appendix
%   <appendix>
%   \end{document}
% \end{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% \subsection{模板选项}
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% 模板选项位于\tn{documentclass}后的方括号内,用于指定模板的行为。
Yu Xiong's avatar
Yu Xiong committed
% 下文中尖括号内列出了若干个允许的选项,其中加粗的为默认选项。
Yu Xiong's avatar
Yu Xiong committed
%
%
% 
% \subsubsection{学位信息}
Yu Xiong's avatar
Yu Xiong committed
% \begin{function}[added=2021-09-07]{degree}
%   \begin{syntax}
Yu Xiong's avatar
Yu Xiong committed
%     degree = <(ug)|mg|mf|phd>
%   \end{syntax}
% 选择学位,分别为学士、学术型硕士、专业硕士、博士。
% \end{function}
Yu Xiong's avatar
Yu Xiong committed
% \begin{function}[added=2021-09-07]{nlcover}
%   \begin{syntax}
%     nlcover = <\TTF>
%   \end{syntax}
% 通过此项可选择是否用国家图书馆封面替换普通封面。
% 由于本科生院文件中并未提及相关规定,故本选项仅对于研究生有效。
Yu Xiong's avatar
Yu Xiong committed
% \end{function}  
Yu Xiong's avatar
Yu Xiong committed
% \begin{function}[added=2021-09-07]{type}
%   \begin{syntax}
Yu Xiong's avatar
Yu Xiong committed
%     type = <(thesis)|design>
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
Yu Xiong's avatar
Yu Xiong committed
% 用于选择文档类型并将相关字段输出在封面和摘要页,可选值分别为毕业论文和毕业设计。
Yu Xiong's avatar
Yu Xiong committed
% \end{function}
%   
%
% \subsubsection{指定字体}
Yu Xiong's avatar
Yu Xiong committed
% 学校论文格式要求使用的字体一般已经预装在各个操作系统,本模板针对不同平台进行了自动检测适配,可以开箱即用。
%
% 如果希望更改本模板使用的字体,请填写以下两个选项以覆盖操作系统检测得到的设置。
Yu Xiong's avatar
Yu Xiong committed
% 
Yu Xiong's avatar
Yu Xiong committed
% \begin{function}[added=2021-09-07]{customchinesefont,customlatinfont}
%   \begin{syntax}
%     customchinesefont = <(windows)|macos|fandol|founder|noto|none>
Yu Xiong's avatar
Yu Xiong committed
%     customlatinfont = <(windows)|macos|gyre|none>
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
Yu Xiong's avatar
Yu Xiong committed
% 手动指定字体。
Yu Xiong's avatar
Yu Xiong committed
% \end{function}
%
% 根据学校论文格式的要求,本模板使用的中文字体主要有{\songti 宋体}、{\heiti 黑体}、{\kaishu 楷体}、{\fangsong 仿宋}四种;
% 西文字体主要有衬线体(\textup{serif})、无衬线体(\textsf{sans-serif})和等宽字体(\texttt{monospace})三种。
% 在生成论文时,需要将每一种字体(宋体、楷体)与一种字库(操作系统中的 ttf 文件)相对应。
% 由于不同操作系统自带的字库不同,在不同的操作系统上使用同一套配置会导致缺字、编译出错等后果。
% 因此,本模板对于中文字体和西文字体都提供了多种字体配置。
% 本模板提供的中文字体配置如表 \ref{tab:chinesefontset} 所示。
Yu Xiong's avatar
Yu Xiong committed
% 在不指定字体配置的情况下,本模板默认使用与操作系统相对应的字体配置
% (见表中前三行,Windows 和 macOS 以外的系统采用 Fandol 配置)。
% 此外,我们也单独提供了方正和思源两套中文字体配置。
Yu Xiong's avatar
Yu Xiong committed
%
% \begin{table}[htbp]
%   \centering
%   \begin{talltblr}[
Yu Xiong's avatar
Yu Xiong committed
%   caption = {中文字体配置列表},
%   label = {tab:chinesefontset},
%   note{a} = {使用
%     \href{http://www.foundertype.com/index.php/FontInfo/index/id/164}{方正小标宋}
%     作为方正书宋的粗体,使用
%     \href{http://www.foundertype.com/index.php/FontInfo/index/id/131}{方正黑体}
%     作为方正细黑一的粗体},
%   note{b} = {思源字体并不包含楷书和仿宋,而Adobe楷体和仿宋难以直接下载,
%     因此使用方正字体代替;考虑到获取字体的难易程度,采用
%     \href{https://www.google.com/get/noto}{noto} 字体表示思源字体},
mc's avatar
mc committed
%   ] { cell{2}{2,4} = {njuyellow}, cell{4}{4} = {njuyellow}, colspec = {ccccc} }
Yu Xiong's avatar
Yu Xiong committed
%   \toprule
%   配置名称   & 宋体        & 黑体        & 楷书        & 仿宋 \\
%   \midrule
%   Windows    & 中易宋体    & 中易黑体    & 中易楷体    & 中易仿宋 \\
%   macOS      & 华文宋体    & 华文黑体    & 华文楷体    & 华文仿宋 \\
%   \href{https://www.ctan.org/pkg/fandol} {Fandol}           
%              & Fandol宋体  & Fandol黑体  & Fandol楷体  & Fandol仿宋 \\
%   \href{https://www.foundertype.com}     {方正}\TblrNote{a} 
%   & \href{http://www.foundertype.com/index.php/FontInfo/index/id/151}{方正书宋}
%   & \href{http://www.foundertype.com/index.php/FontInfo/index/id/161}{方正细黑一}
%   & \href{http://www.foundertype.com/index.php/FontInfo/index/id/137}{方正楷体}
%   & \href{http://www.foundertype.com/index.php/FontInfo/index/id/128}{方正仿宋} \\
%   \href{https://github.com/adobe-fonts}  {思源}\TblrNote{b} 
%   & \href{https://fonts.google.com/noto/specimen/Noto+Serif+SC}{思源宋体}
%   & \href{https://fonts.google.com/noto/specimen/Noto+Sans+SC}{思源黑体}
%                                          & 方正楷体    & 方正仿宋 \\
%   \bottomrule
%   \end{talltblr}
% \end{table}
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% 由于各操作系统对自带字体的支持程度不同,本模板对不同字体加粗的方式有所差别,
% 表 \ref{tab:chinesefontset} 中,黄色底色的字体采用算法加粗。
mc's avatar
mc committed
% 除此以外,各种字体在设计上也存在差异,因此本模板在不同操作系统下编译的结果可能存在细微不同,使用时请注意。
Yu Xiong's avatar
Yu Xiong committed
% 若想要获得与 Word 版本模板最为贴近的体验,
% 可以通过手动安装 Windows 自带的中易宋体、中易黑体、中易楷体和中易仿宋,并设置使用 Windows 字体来实现。
% 本模板提供的西文字体配置如表 \ref{tab:latinfontset} 所示。
Yu Xiong's avatar
Yu Xiong committed
% 在不指定字体配置的情况下,本模板默认使用与操作系统相对应的字体配置
% (见表中前三行,Windows 和 macOS 以外的系统采用 \opt{gyre} 配置)。
%
% \begin{table}[htbp]
%   \centering
%   \caption{西文字体清单}
%   \label{tab:latinfontset}
%   \begin{tabular}{cccc}
mc's avatar
mc committed
%       配置名称 & 衬线体 & 无衬线体 & 等宽字体 \\
mc's avatar
mc committed
%       Windows  & Times~New~Roman           & Arial                   & Courier~New \\
%       macOS    & Times~New~Roman           & Arial                   & Menlo \\
%       \href{http://www.gust.org.pl/projects/e-foundry/tex-gyre}{gyre} 
%                & \Hologo{TeX}~Gyre~Termes  & \Hologo{TeX}~Gyre~Heros & \Hologo{TeX}~Gyre~Cursor \\
%       \bottomrule
%   \end{tabular}
% \end{table}
Yu Xiong's avatar
Yu Xiong committed
%
% 若要手动选择字体,则需将字体设置为 \opt{none},再通过 \pkg{fontspec} 宏包或 \pkg{ctex} 宏包中给出的命令来实现。
Yu Xiong's avatar
Yu Xiong committed
% 最后,出于统一格式的需要,本模板还选取了与正文字体相似度最高的数学字体(\href{https://github.com/aliftype/xits}{XITS 字体})用于公式排版。
Yu Xiong's avatar
Yu Xiong committed
%
% 本节提及的字库中,中文字库只有方正书宋、方正黑体、方正楷体、方正仿宋、两种思源字体和四种Fandol字体能够\emph{免费商用};
Yu Xiong's avatar
Yu Xiong committed
% 英文字库中只有 Times New Roman、XITS 和三种\Hologo{TeX} Gyre字体能够\emph{免费商用}。
% 因此,若需要将本模板用于商业相关的活动,请咨询专业人士。
%
Yu Xiong's avatar
Yu Xiong committed
% \subsection{个人信息}
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% \begin{function}[updated=2021-10-01]{\njusetup}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
Yu Xiong's avatar
Yu Xiong committed
%     \tn{njusetup}\Arg{键值列表}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% 以下为各项个人信息,其中带星号的为对应的英文名称。
% 有空格的内容需要将空格替换为波浪线或者两端加上大括号,不需要的项目不填即可。
%
% \end{function}
%
% \begin{function}{info/titlea,info/titleb,info/titlec,info/title*}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
%     titlea = \Arg{第一行标题}
%     titleb = \Arg{第二行标题}
%     titlec = \Arg{第三行标题}
%     title* = \Arg{英文标题}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
Yu Xiong's avatar
Yu Xiong committed
% 题目。由于封面上提供给中文题目的横线长度有限(单行最长为15个汉字),这里将中文题目进行手动拆分,请自行选择合适的断行处。如果题目较短不需要二三行,留空即可。
Yu Xiong's avatar
Yu Xiong committed
% \end{function}
%
% \begin{function}{info/keywords,info/keywords*}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
%     keywords = \Arg{关键词}
%     keywords* = \Arg{英文关键词}
%   \end{syntax}
Yu Xiong's avatar
Yu Xiong committed
% 关键词列表。关键词之间需要使用英文半角逗号隔开,含有空格的关键字需要使用花括号包裹以避免歧义。可以参照示例模板中的填写方式。
% \end{function}
%
% \begin{function}{info/grade}
%   \begin{syntax}
%     grade = \Arg{20XX}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
% 年级,推荐格式为“20XX”。
% \end{function}
%
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
% 学号。南京大学本科生为9位数字学号,研究生为两位大写字母标识加上八位数字组成的学号。
% \end{function}
%
% \begin{function}{info/author,info/author*}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
%     author = \Arg{你的名字}
%     author* = \Arg{姓名拼音}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
% 姓名。
% \end{function}
% 
% \begin{function}{info/department,info/department*}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
%     department = \Arg{院系}
%     department* = \Arg{院系}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
% 院系。
% \end{function}
% 
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
% 专业。
% \end{function}
% 
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
% 研究领域。只有研究生有研究领域的说法。
% \end{function}
%  
% \begin{function}{info/supervisora,info/supervisora*,info/supervisora-title,info/supervisora-title*}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
%     supervisora = \Arg{导师}
%     supervisora* = \Arg{导师}
%     supervisora-title = \Arg{导师职称}
%     supervisora-title* = \Arg{导师职称}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
% 导师,如果有第二导师,填写第二导师时将A替换为B即可。
% \end{function}
%
% \begin{function}{info/submit-date,info/submit-date*}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
%     submit-date = \Arg{提交日期}
%     submit-date* = \Arg{提交日期}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
% 提交日期。
% \end{function}
%
% \begin{function}{info/defend-date,info/chairman,info/reviewer}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
%     defend-date = \Arg{答辩日期}
%     chairman = \Arg{答辩主席}
%     reviewer = \Arg{评委姓名职称}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
Yu Xiong's avatar
Yu Xiong committed
% 答辩相关的内容,只对研究生有效,包括答辩日期,评审委员会主席及四位成员的姓名加职称。其中,四位评审成员是以列表的形式存储的,填写方法同关键词。
Yu Xiong's avatar
Yu Xiong committed
% \end{function}
%
% \begin{function}{info/clc,info/secret-level,info/udc,info/supervisor-contact}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
%     clc = \Arg{中图分类号}
%     secret-level = <不涉密|秘密|机密|绝密>
%     udc = \Arg{udc}
%     supervisor-contact = \Arg{导师联系方式}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
Yu Xiong's avatar
Yu Xiong committed
% 国家图书馆封面相关,包括中图分类号、密级、udc和导师联系方式。
Yu Xiong's avatar
Yu Xiong committed
% \end{function}
%
Yu Xiong's avatar
Yu Xiong committed
% \subsubsection{输入示范}
Yu Xiong's avatar
Yu Xiong committed
% 本科生可以参考如下列表输入个人信息。注意不能有空行。
Yu Xiong's avatar
Yu Xiong committed
% \begin{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%   \njusetup {
%       info = {
%           titlea = 第一行标题,
%           titleb = 第二行标题,
%           title* = {My title in English}, 
%           keywords = {我,就是,充数的,关键词},
%           keywords* = {Dummy,Keywords,Here,{it is}},
%           grade = 2018,
%           student-id = 189114514,
%           author = 周煜华,
%           author* = Zhou~Yuhua,
%           department = 拉太赫科学与技术学院,
%           department* = School~of~\hologo{LaTeX},
%           major = 拉太赫语言学,
%           major* = \hologo{LaTeX}~Linguistics,
%           supervisora = 李成殿,
%           supervisora*= Li~Chengdian,
%           supervisora-title = 教授,
%           supervisora-title* = Professor,
%           supervisorb = 孙赫弥,
%           supervisorb* = Sun~Hemi,
%           supervisorb-title = 副教授,
%           supervisorb-title* = Associate professor,
%           submit-date = 2021年8月10日,
Yu Xiong's avatar
Yu Xiong committed
%       }
%   }
Yu Xiong's avatar
Yu Xiong committed
% \end{ctexexam}
%
% 研究生可以参考如下列表输入个人信息
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% \begin{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%   \njusetup {
%       info = {
%           titlea = 第一行标题,
%           titleb = 第二行标题,
%           titlec = 第三行标题,
%           title* = {My title in English}, 
%           keywords = {我,就是,充数的,关键词},
%           keywords* = {Dummy,Keywords,Here,{it is}},
%           grade = 2018,
%           student-id = dz18114514,
%           author = 周煜华,
%           author* = Zhou~Yuhua,
%           department = 拉太赫科学与技术学院,
%           department* = School~of~\hologo{LaTeX},
%           major = 拉太赫语言学,
%           major* = \hologo{LaTeX}~Linguistics,
%           field = 拉太赫语言在现当代的使用, 
%           field* = Contemporary~Usage~of~the~\hologo{LaTeX}~Language, 
%           supervisora = 李成殿,
%           supervisora*= Li~Chengdian,
%           supervisora-title = 教授,
%           supervisora-title* = Professor,
%           submit-date = 2021年8月10日,
%           submit-date* = {Aug 10, 2021}, 
%           defend-date = 2021年9月19日,
%           chairman = 张晓山~教授,
%           reviewer = {王瑞希~教授,郭德纲~副教授,华芈库~教授,戴菲菲~教授},
%           clc = 0175.2,
%           secret-level = 限制,
%           udc = 004.72,
%           supervisor-contact = {拉太赫科学与技术学院 枝江市结丘路 19 号 114514},
Yu Xiong's avatar
Yu Xiong committed
%       }
%   }
Yu Xiong's avatar
Yu Xiong committed
% \end{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%
%
%
Yu Xiong's avatar
Yu Xiong committed
% \subsection{编写正文}
Yu Xiong's avatar
Yu Xiong committed
%
Yu Xiong's avatar
Yu Xiong committed
% 与导言区相对的是正文,位于\env{document}环境内。
Yu Xiong's avatar
Yu Xiong committed
% 
% \begin{function}{\mainmatter}
%   \cs{mainmatter} 标志着正文的开始,重新开始字号计数并设置页眉。
% \end{function}
%
% \begin{function}{\chapter,\section,\subsection,\subsubsection}
%   \begin{syntax}
%     \tn{chapter}\oarg{短描述}\marg{完整的长标题}
%   \end{syntax}
% \pkg{ctex} 宏集提供了其中用于处理长标题的可选参数。对于过长的标题,目录中会使用其短描述。
% \end{function}
%
Yu Xiong's avatar
Yu Xiong committed
% \begin{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{document}
Yu Xiong's avatar
Yu Xiong committed
%     text
%   \end{document}
% \end{ctexexam}
%
% 加上空行就可以另起一段。
Yu Xiong's avatar
Yu Xiong committed
% 在页面布局方面,本科生无页眉,页面编号居中位于页脚;研究生无页脚,页眉包括章节名和页面编号(尚未确定)。
Yu Xiong's avatar
Yu Xiong committed
%
% \subsubsection{文字}
%
Yu Xiong's avatar
Yu Xiong committed
% \begin{function}[added=2021-09-22]{\njuline}
%   \begin{syntax}
%     \tn{njuline}\Arg{文字}
%   \end{syntax}
%
% 为了避免原生\tn{uline}命令在中文环境下不能正常换行的问题,本模板使用\tn{njuline}作为替代方案,分别对\hologo{XeLaTeX} 的\pkg{xeCJKfntef}包和\hologo{LuaLaTeX}的\pkg{lua-ul}包中的下划线命令进行了包装。
% \end{function}
Yu Xiong's avatar
Yu Xiong committed
% \begin{function}{\footnote}
%   \begin{syntax}
%     \tn{footnote}\Arg{脚注}
%   \end{syntax}
Yu Xiong's avatar
Yu Xiong committed
% 添加脚注
% \end{function}
%
% 
%  \subsubsection{图片}
%
% \begin{function}{\graphicspath}
%   \begin{syntax}
%     \tn{graphicspath}\{\marg{路径1}\marg{路径2}\}
%   \end{syntax}
% 使用自己的图片时,需要在导言区通过本命令添加图片存放路径,允许的文件名包括\file{*.jpg}, \file{*.png}, \file{*.pdf}, \file{*.eps}。
% \end{function}
Yu Xiong's avatar
Yu Xiong committed
% 下面这个例子展示了如何插入一张名称为\file{myfig.jpg},宽度占页面文字宽度一半的图片。注意标签命令\tn{label}必须放在图注命令\tn{caption}之后。
Yu Xiong's avatar
Yu Xiong committed
%
% \begin{ctexexam}
%   \begin{figure}[h]
Yu Xiong's avatar
Yu Xiong committed
%       \includegraphics[width=0.5\textwidth]{myfig}
%       \caption{我的图}
%       \label{fig:myfig}
%   \end{figure}
% \end{ctexexam}
%
% 
Yu Xiong's avatar
Yu Xiong committed
% 对于较为瘦长,或者仅起到辅助作用的图像,可以使用\env{wrapfigure}实现文字环绕效果。注意这个环境后紧跟的一行不能为空。
Yu Xiong's avatar
Yu Xiong committed
%
% \begin{ctexexam}
%   \begin{wrapfigure}{r}{0cm}
%       \includegraphics[width=0.15\textwidth]{myfig}
%       \caption{我的图}
%       \label{fig:myfig}
%   \end{wrapfigure}
%   <text>
% \end{ctexexam}
% 
Yu Xiong's avatar
Yu Xiong committed
% TODO:使用\pkg{subcaption}的\env{subfigure}实现多张图片并排的效果。较为老旧的\pkg{subfigure}并不在此受到支持。
%
% \begin{ctexexam}
%   \begin{figure}
%       \begin{subfigure}{.32\textwidth}
%          \centering
%          \includegraphics[width=\textwidth]{fig1}  
%          \caption{fig1}
%       \end{subfigure}
%       \begin{subfigure}{.32\textwidth}
%          \centering
%           \includegraphics[width=\textwidth]{fig2}  
%           \caption{fig2}
%       \end{subfigure}
%       \begin{subfigure}{.32\textwidth}
%           \centering
%           \includegraphics[width=\textwidth]{fig3}  
%           \caption{fig3}
%       \end{subfigure}
%       \caption{subfigures}
%   \end{figure}
% \end{ctexexam}
Yu Xiong's avatar
Yu Xiong committed
%
% \subsubsection{表格}
%
% 下面这个例子展示了如何插入一张表格。通过 \pkg{booktabs} 提供的 \tn{toprule}、\tn{midrule} 和 \tn{bottomrule},我们可以很轻松地绘制出一张漂亮规范的三线表。
Yu Xiong's avatar
Yu Xiong committed
% \begin{ctexexam}
%   \begin{table}[htbp]
%       \caption{我的表}
%       \label{tab:testtab}
%       \begin{tabular}{ccc}
%           \toprule
%           OS & TeX & 测试情况 \\
%           \midrule
%           南大TeX & Overleaf & √ \\
%           \bottomrule
%       \end{tabular}
%   \end{table}
% \end{ctexexam}
%
Yu Xiong's avatar
Yu Xiong committed
% \begin{function}{\multirow,\multicolumn}
%   \begin{syntax}
%     \tn{multirow}\Arg{nrows}\oarg{bigstructs}\Arg{width}[\oarg{fixup}\Arg{text}
%     \tn{multicolumn}\Arg{nrows}\Arg{width}\Arg{text}
%   \end{syntax}
%
% TODO:\pkg{multirow}\pkg{multicol}合并单元格
Yu Xiong's avatar
Yu Xiong committed
% \url{http://www.ctex.org/documents/packages/table/multirow.htm}
%
% \end{function}
Yu Xiong's avatar
Yu Xiong committed
%
% \subsubsection{代码}
%
% 由\pkg{listings}提供代码排版。代码块\env{lstlisting},注意这个环境中的缩进空格会如实输出
% \begin{ctexexam}
%   \begin{lstlisting}
%   <code>
%   \end{lstlisting}
% \end{ctexexam}
%
% 行间代码|\lstinline!<code>!|,其中包裹代码的两个感叹号并不是绝对的,可以替换成任何两个相同的没有在这段代码中出现过的符号。
Yu Xiong's avatar
Yu Xiong committed
%
%
% \subsubsection{数学}
%
Yu Xiong's avatar
Yu Xiong committed
% 符号表可以参考\url{https://www.caam.rice.edu/~heinken/latex/symbols.pdf}。单位请参考\pkg{siunitx}。\pkg{siunitx}是一个更新频繁的包,可能会引发兼容性问题。
Yu Xiong's avatar
Yu Xiong committed
% 行内公式形如|$\mathrm{e}^{(a+2b)x}$|
%
% 带有编号的行间公式\env{equation}
% \begin{ctexexam}
%   \begin{equation}\label{eq:myeqlabel}
%       \pi
%   \end{equation}
% \end{ctexexam}
%
% 如不需要编号,可以用\env{equation*}或者 |\[<eq>\]|
%
% 本模板也提供了一系列的数学环境。证明环境会在结尾添加证毕符号
Yu Xiong's avatar
Yu Xiong committed
% \begin{ctexexam}
%   \begin{proof}
%       证明我是我
%   \end{proof}
% \end{ctexexam}
%
% 普通环境
% \begin{ctexexam}
%   \begin{definition}[他人]
%       定义他人即地狱
%   \end{definition}
% \end{ctexexam}
% 
% 
Yu Xiong's avatar
Yu Xiong committed
% \subsubsection{引用}
Yu Xiong's avatar
Yu Xiong committed
% \begin{function}{\cref}
%   \begin{syntax}
%     \tn{cref}\Arg{标签}
%   \end{syntax}
%
% 使用\pkg{cleveref}宏包实现了带图、表等项目名称的智能引用。
% 
% \end{function}
%
% \begin{function}{\href,\url}
Yu Xiong's avatar
Yu Xiong committed
%   \begin{syntax}
%     \tn{href}\Arg{链接}\Arg{名称}
%     \tn{url}\Arg{链接}
Yu Xiong's avatar
Yu Xiong committed
%   \end{syntax}
% 超链接。\tn{href}会将特定字符显示为可点击的超链接,\tn{url}会输出可点击的链接原文。
Yu Xiong's avatar
Yu Xiong committed
% 
% \end{function}
Yu Xiong's avatar
Yu Xiong committed
% 
% \subsection{特殊页面}
Yu Xiong's avatar
Yu Xiong committed
% 
% 本模板还提供一系列环境用于生成所需的特殊页面
Yu Xiong's avatar
Yu Xiong committed
% \subsubsection{封面}
%
Yu Xiong's avatar
Yu Xiong committed
% \begin{function}{\maketitle}
%
% 用于生成封面。
Yu Xiong's avatar
Yu Xiong committed
% 本科生仅会生成中文封面;研究生会生成中英文封面。
% 如果选择了\opt{nlcover},仅会生成研究生的国家图书馆封面和原创性声明页。
Yu Xiong's avatar
Yu Xiong committed
% \end{function}
Yu Xiong's avatar
Yu Xiong committed
% \subsubsection{摘要页}
Yu Xiong's avatar
Yu Xiong committed
% \changes{v0.11}{2021/10/01}{简化了摘要的编写方式。}