Skip to content

Commit

Permalink
docs: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
atxy-blip committed Sep 10, 2021
1 parent e70233b commit e5d103d
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 20 deletions.
2 changes: 1 addition & 1 deletion chapters/Environments.tex
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ \section{字体}
\subsection{修改字体配置}

本模板提供了若干个字体相关的控制选项,已于\cref{sec:classoptions}初步进行介绍。如果希望覆盖检测系统字体的命令(譬如在Linux编译时使用Windows字体样式),请将
UseSysFont设置为false,并通过CustomEnFont和CustomZhFont进行选择
systemfont设置为false,并通过customlatinfont和customchinesefont进行选择

全部字符集命令如下所示。

Expand Down
15 changes: 8 additions & 7 deletions chapters/Introduction.tex
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,13 @@ \subsection{文件说明}
\section{自定义选项}
\label{sec:classoptions}

njuthesis类提供了5个可以自定义的选项,如下所示。
njuthesis类提供了若干个可以自定义的选项,如下所示。
\begin{description}
\item[\texttt{TitleLength}] 标题长度,用于控制封面标题的行数。可选值为1、2、3,缺省值为1。
\item[\texttt{Degree}] 学位类型,本科生为UG,即Undergraduate的缩写。
\item[\texttt{Type}] 用于选择文档类型并将相关字段输出在封面和摘要页。可选值包括thesis(表示毕业论文)和design(表示毕业设计),缺省值为thesis。 \item[\texttt{UseSysFont}] Bool类型,用于选择是否使用系统预装字体,缺省值为true。
\item[\texttt{CustomEnFont}] 用于选择自定义英文字符集。可选值包括windows, macos, gyre, null,缺省值为windows。
\item[\texttt{CustomZhFont}] 用于选择自定义中文字符集。可选值包括windows, macos, fandol, founder, noto, null,缺省值为windows。
\item[\texttt{titlelength}] 标题长度,用于控制封面标题的行数。可选值为1、2、3,缺省值为1。
\item[\texttt{secondsupervisor}] 是否有第二导师,用于在封面和摘要添加第二导师,缺省值为false。
\item[\texttt{degree}] 学位类型,本科生为UG,即Undergraduate的缩写。
\item[\texttt{type}] 用于选择文档类型并将相关字段输出在封面和摘要页。可选值包括thesis(表示毕业论文)和design(表示毕业设计),缺省值为thesis。
\item[\texttt{systemfont}] 是否用系统字体,用于自动检测运行系统并使用预装字体,缺省值为true。
\item[\texttt{customlatinfont}] 用于选择自定义英文字符集。可选值包括windows, macos, gyre, null,缺省值为windows。
\item[\texttt{customchinesefont}] 用于选择自定义中文字符集。可选值包括windows, macos, fandol, founder, noto, null,缺省值为windows。
\end{description}

46 changes: 37 additions & 9 deletions chapters/Layout.tex
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,61 @@ \subsection{封面格式}

\texttt{cover.sty}中定义了生成封面的相关命令



\subsection{文档类型}

如果编写的是毕业设计,请参考\cref{sec:classoptions},将Type选项改为design。
\subsection{多行标题}

为了使较长的论文题目也能美观地呈现在封面页上,njuthesis类提供了\texttt{TitleLength}这一选项,用于控制封面标题的行数。该命令已于\cref{sec:classoptions}进行介绍,可以在\texttt{njuthesis.tex}文件开头的类定义中找到,可选值为1、2、3,缺省值为单行标题。

\subsection{第二导师}

secondsupervisor用于指定是否在封面打印第二导师

\subsection{输入个人信息}

主目录下的\texttt{coverinfo.sty}文件定义了用于文档封面的诸多属性参数,包括
主目录下的\texttt{coverinfo.sty}文件定义了用于文档封面的诸多属性参数。
写作时在此文件中修改相应字符串即可。

\subsubsection{论文标题}
\begin{description}
\item[\texttt{\textbackslash TitleA}] 单行标题,或多行标题的第一行。关于是否应该折行,单行能容纳的最长标题为\emph{15个中文字符},请自行选择合适的截断处。
\item[\texttt{\textbackslash TitleB}] 多行标题的第二行
\item[\texttt{\textbackslash TitleC}] 多行标题的第三行
\item[\texttt{\textbackslash Title\textunderscore EN}] 英文标题,注意空格要用波浪线(\textasciitilde)替代
\end{description}

\subsubsection{个人年级、学号、姓名}
\begin{description}
\item[\texttt{\textbackslash Grade}] 年级
\item[\texttt{\textbackslash StudentID}] 9位数字学号
\item[\texttt{\textbackslash StudentName}] 姓名
\item[\texttt{\textbackslash StudentName\textunderscore EN}] 姓名拼音
\end{description}

\subsubsection{就读院系专业}
\begin{description}
\item[\texttt{\textbackslash Department}] 学院名称
\item[\texttt{\textbackslash Department\textunderscore EN}] 学院英文名称
\item[\texttt{\textbackslash Major}] 专业名称
\item[\texttt{\textbackslash Major\textunderscore EN}] 专业英文名称
\item[\texttt{\textbackslash Mentor}] 导师姓名
\item[\texttt{\textbackslash Mentor\textunderscore EN}] 导师姓名的英文拼音
\item[\texttt{\textbackslash MentorTitle}] 导师职称
\item[\texttt{\textbackslash MentorTitle\textunderscore EN}] 导师职称英文
\item[\texttt{\textbackslash SubmitDate}] 论文提交日期
\end{description}
写作时在此文件中修改相应字符串即可。

为了使较长的论文题目也能美观地呈现在封面页上,njuthesis类提供了\texttt{TitleLength}这一选项,用于控制封面标题的行数。该命令已于\cref{sec:classoptions}进行介绍,可以在\texttt{njuthesis.tex}文件开头的类定义中找到,可选值为1、2、3,缺省值为单行标题。
\subsubsection{导师信息}
注意标注A的为第一导师
\begin{description}
\item[\texttt{\textbackslash Mentor<A/B>}] 导师姓名
\item[\texttt{\textbackslash Mentor<A/B>\textunderscore EN}] 导师姓名的英文拼音
\item[\texttt{\textbackslash Mentor<A/B>Title}] 导师职称
\item[\texttt{\textbackslash Mentor<A/B>Title\textunderscore EN}] 导师职称英文
\end{description}

如果编写的是毕业设计,请参考\cref{sec:classoptions},将Type选项改为design。
\subsubsection{提交日期}
\begin{description}
\item[\texttt{\textbackslash SubmitDate}] 论文提交日期
\end{description}

\section{摘要页}

Expand Down
6 changes: 3 additions & 3 deletions njuthesis.tex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% NJU Thesis Undergraduate
% 南京大学本科生毕业论文LaTeX模板
% Version 0.4.1 (2021-09-10)
% Version 0.5.0 (2021-09-10)
%
% 请关注项目地址以获取最新变化
% https://github.com/nju-lug/NJUThesisUndergraduate
Expand All @@ -17,15 +17,15 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\documentclass[
titlelength=2,% 选择标题行数,范围是1~3
% secondsupervisor=true,% 有第二导师请反注释此项
secondsupervisor=true,% 有第二导师请反注释此项
% degree=UG,% UG: 本科 本项不需更改
type=thesis,% thesis: 毕业论文,design: 毕业设计
% systemfont=false,% 自定义字体请反注释此项
% customlatinfont=windows,% 设置英文字符集
% customchinesefont=windows,% 设置中文字符集
]{njuthesis}

% 输入个人信息
% 输入封面信息
\input{coverinfo.tex}

% 导入参考文献源
Expand Down

0 comments on commit e5d103d

Please sign in to comment.