Skip to content
Snippets Groups Projects
njuthesis.dtx 183 KiB
Newer Older
% \begin{variable}{\g_@@_latin_font_tl,\g_@@_cjk_font_tl}
% 用于存储所使用字体名称的全局变量
%    \begin{macrocode}
\tl_new:N \g_@@_latin_font_tl
\tl_new:N \g_@@_cjk_font_tl
%    \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_info_sm_date_tl,\l_@@_info_sm_date_en_tl,\l_@@_info_df_date_tl}
% 用于存储格式化后的论文提交日期和答辩日期的变量。
%    \begin{macrocode}
\tl_new:N \l_@@_info_sm_date_tl
\tl_new:N \l_@@_info_sm_date_en_tl
\tl_new:N \l_@@_info_df_date_tl
%    \end{macrocode}
% \end{variable}
%
% \begin{variable}{\c_@@_today_tl}
% 编译当天日期,格式为 |yyyy-mm-dd|。
%    \begin{macrocode}
\tl_const:Nx \c_@@_today_tl
  {
    \int_to_arabic:n { \c_sys_year_int  } -
    \int_to_arabic:n { \c_sys_month_int } -
    \int_to_arabic:n { \c_sys_day_int   }
  }
%    \end{macrocode}
% \end{variable}
%
Yu Xiong's avatar
Yu Xiong committed
% \begin{variable}{\c_@@_name_type_clist,\c_@@_name_type_en_clist,
%   \c_@@_name_degree_clist,\c_@@_name_degree_en_clist}
% 论文类型与学位类型。
%    \begin{macrocode}
\clist_const:Nn \c_@@_name_type_clist
  { 毕业论文, 毕业设计 }
\clist_const:Nn \c_@@_name_type_en_clist
  { THESIS, DESIGN }
\clist_const:Nn \c_@@_name_degree_clist
  { 学士, 硕士, 硕士专业, 博士 }
\clist_const:Nn \c_@@_name_degree_en_clist
  { Bachelor, Master, Master, Doctor~of~Philosophy }
%    \end{macrocode}
% \end{variable}
%
% \begin{variable}{\c_@@_month_en_clist}
% 英文月份名称。
%    \begin{macrocode}
\clist_const:Nn \c_@@_month_en_clist
  {
    January, February, March, April, May, June,
    July, August, September, October, November, December
  }
%    \end{macrocode}
% \end{variable}
%
% \subsection{内部函数}
% \begin{macro}{\@@_quad:,\@@_qquad:}
% 等价于 \LaTeXe{} 中的 \tn{quad} 和 \tn{qquad}。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
\cs_new:Nn \@@_quad:  { \skip_horizontal:n { 1 em } }
\cs_new:Nn \@@_qquad: { \skip_horizontal:n { 2 em } }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
Yu Xiong's avatar
Yu Xiong committed
%
% \begin{macro}{\@@_vskip:,\@@_hskip:}
% 生成一个较小的 skip。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
\cs_new:Nn \@@_vskip: { \skip_vertical:n   { 1   ex } }
\cs_new:Nn \@@_hskip: { \skip_horizontal:n { 0.3 em } }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% \end{macro}
% \begin{macro}{\@@_vskip:N}
% 类似于 \hologo{LaTeX2e} 中的 \tn{vspace*},从上一个页面元素底部开始生成 |skip|。
%    \begin{macrocode}
\cs_new_protected:Npn \@@_vskip:N #1
  {
    \hrule height \c_zero_dim
    \nobreak
    \skip_vertical:n { - \baselineskip - \lineskip }
    \skip_vertical:N #1
  }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_define_name:nn,\@@_define_name:nnn}
% 用来定义默认名称的辅助函数。
%    \begin{macrocode}
\cs_new_protected:Npn \@@_define_name:nn #1#2
  { \tl_const:cn { c_@@_name_ #1    _tl } { #2 } }
\cs_new_protected:Npn \@@_define_name:nnn #1#2#3
  {
    \tl_const:cn { c_@@_name_ #1    _tl } { #2 }
    \tl_const:cn { c_@@_name_ #1 _en_tl } { #3 }
% \begin{macro}{\@@_name:n,\@@_info:n}
Yu Xiong's avatar
Yu Xiong committed
% 根据变量名调用名称和内容信息。
\cs_new:Npn \@@_name:n #1 { \tl_use:c { c_@@_name_ #1 _tl } }
\cs_new:Npn \@@_info:n #1 { \tl_use:c { l_@@_info_ #1 _tl } }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_ulined_center_box:nn}
% 带有下划线的水平盒子。
% \begin{arguments}
%   \item 宽度,|dim| 型变量
%   \item 内容,可带有格式
% \end{arguments}
%    \begin{macrocode}
\cs_new_protected:Npn \@@_ulined_center_box:nn #1#2
    \mode_leave_vertical:
    \rule [ -0.5 ex ] { #1 } { 0.4 pt }
    \skip_horizontal:n { -#1 }
    \hbox_to_wd:nn { #1 } { \hfil #2 \hfil }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_spread_box:nnn}
% 分散对齐的水平盒子。
% \begin{arguments}
%   \item 宽度,|dim| 型变量
%   \item 格式
%   \item 内容,不可带有格式
% \end{arguments}
%    \begin{macrocode}
\cs_generate_variant:Nn \tl_map_inline:nn { xn }
\cs_new_protected:Npn \@@_spread_box:nnn #1#2#3
    \mode_leave_vertical:
    \hbox_to_wd:nn { #1 }
      { #2 \tl_map_inline:xn { #3 } { ##1 \hfil } \unskip }
% \end{macro}
% \begin{macro}{\@@_multiline_box:nnnn}
% 多行固定长度的下划线内容,用于国家图书馆封面。
% \begin{arguments}
%   \item 用于循环的 |int| 型变量
%   \item 内容,|clist| 型变量
%   \item 行数
%   \item 宽度,|dim| 型变量
% \end{arguments}
%    \begin{macrocode}
\cs_new_protected:Npn \@@_multiline_box:nnnn #1#2#3#4
    \int_set:Nn #1 { 1 }
    \int_do_until:nn { #1 > #3 }
      {
        \@@_ulined_center_box:nn { #4 }
          { \clist_item:Nn #2 { #1 } } \\
        \int_incr:N #1
      }
  }
%    \end{macrocode}
% \end{macro}
% \begin{macro}{\@@_put_inempty_seg:nnn}
% 将固定长度的非空字符串插入 |clist|。
% \begin{arguments}
%   \item 原始字符串
%   \item 起始位置
%   \item 长度
% \end{arguments}
%    \begin{macrocode}
\cs_new_protected:Npn \@@_put_inempty_seg:nnn #1#2#3
  {
    \tl_set:Nx \l_@@_tmp_tl
      { \tl_range:Nnn { #1 } { #2 } { #2 + #3 - 1 } }
    \tl_if_empty:NF \l_@@_tmp_tl
      { \clist_put_right:NV \l_@@_tmp_clist { \l_@@_tmp_tl } }
  }
%    \end{macrocode}
% \end{macro}
% \begin{macro}{\@@_uline:n}
% 指定宽度的下划线。
% \begin{arguments}
%   \item 宽度,|dim| 型变量
% \end{arguments}
%    \begin{macrocode}
\cs_new_protected:Npn \@@_uline:n #1
  {
    \mode_leave_vertical:
    \rule [ -0.5 ex ] { #1 } { 0.4 pt }
    \skip_horizontal:n { -#1 }
  }
%    \end{macrocode}
% \end{macro}
% \begin{macro}{\@@_uuline:n}
% 指定宽度的双层下划线。
% \begin{arguments}
%   \item 宽度,|dim| 型变量
% \end{arguments}
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
\cs_new_protected:Npn \@@_uuline:n #1
  {
    \mode_leave_vertical:
    \rule [ -0.5 ex ] { #1 } { 0.4 pt }
    \skip_horizontal:n { -#1 }
    \rule [ -0.6 ex ] { #1 } { 0.4 pt }
    \skip_horizontal:n { -#1 }
  }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% \end{macro}
Yu Xiong's avatar
Yu Xiong committed
%
% \begin{macro}{\@@_get_text_width:Nn,\@@_get_text_width:NV}
% 获取文本宽度。
% \begin{arguments}
%   \item 存储宽度的 |dim| 型变量
%   \item 文本
% \end{arguments}
% 将内容放入 \tn{hbox} 后读取其宽度,存入 |dim| 型变量。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
\cs_new:Npn \@@_get_text_width:Nn #1#2
  {
Yu Xiong's avatar
Yu Xiong committed
    \hbox_set:Nn \l_@@_tmp_box {#2}
    \dim_set:Nn #1 { \box_wd:N \l_@@_tmp_box }
  }
\cs_generate_variant:Nn \@@_get_text_width:Nn { NV }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_full_uline:Nn,\@@_full_uline:NV}
% 横跨整页的下划线。
% \begin{arguments}
%   \item 宽度,|dim| 型变量
%   \item 文本
% \end{arguments}
% 先使用 \cs{@@_get_text_width:Nn} 获取文本内容宽度,该宽度存储在调用的 |dim| 型变量中。随后输出文本内容。
%    \begin{macrocode}
\cs_new_protected:Npn \@@_full_uline:Nn #1#2
  {
    \@@_get_text_width:Nn #1 { #2 }
    \dim_set:Nn #1 { \textwidth - #1 } #2
  }
\cs_generate_variant:Nn \@@_full_uline:Nn { NV }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_uline_entry:Nnnn}
% 生成占整页宽度的下划线条目。
% \begin{arguments}
%   \item 宽度,|dim| 型变量
%   \item 文本
%   \item 文本
%   \item 分隔符
% \end{arguments}
%    \begin{macrocode}
\cs_new_protected:Npn \@@_uline_entry:Nnnn #1#2#3#4
  {
    \@@_full_uline:NV #1 { \@@_name:n { #2 } #4 }
    \@@_ulined_center_box:nn { #1 } { \@@_info:n { #3 } }
  }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_uline_bientry:Nnnn}
% 生成占半页宽度的下划线条目。
% \begin{arguments}
%   \item 宽度,|dim| 型变量
%   \item 文本
%   \item 文本
%   \item 分隔符
% \end{arguments}
%    \begin{macrocode}
\cs_new_protected:Npn \@@_uline_bientry:Nnnn #1#2#3#4
  {
    \@@_full_uline:NV #1 { \@@_name:n { #2 } #4 }
    \dim_sub:Nn #1 { \textwidth / 2 }
    \@@_ulined_center_box:nn { #1 } { \@@_info:n { #3 } }
  }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_date:www,\@@_date_en:www}
% 将形如 |yyyy-mm-dd| 的 ISO 日期格式字符串转化为日期表示。该格式符合国际标准 ISO 8601 以及国内标准 GB/T 7408--2005《数据元和交换格式 信息交换 日期和时间表示法》。
% \begin{arguments}
%   \item 年份
%   \item 月份
%   \item 日期
% \end{arguments}
% 中文日期表示通过封装 \pkg{zhnumber} 的内部函数实现;英文日期表示通过用于研究生英文封面。其中,变量类型 |w| 表明参数符合特定语法格式。
%    \begin{macrocode}
\cs_new:Npn \@@_date:www #1-#2-#3 \q_stop
  { \__zhnum_date_aux:nnn { #1 } { #2 } { #3 } }
\cs_new:Npn \@@_date_en:www #1-#2-#3 \q_stop
  { \clist_item:Nn \c_@@_month_en_clist { #2 } ~#3 , ~#1  }
%    \end{macrocode}
% \end{macro}
%
%
% \subsection{模板选项}
% \changes{v0.11}{2021/11/15}{进行了效率优化。}
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
\keys_define:nn { nju }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
%
% \begin{macro}{degree}
% 学位类型,默认为本科。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
    degree            .choices:nn = { ug, mg, mf, phd }
      {
        \int_set_eq:NN \l_@@_info_degree_int \l_keys_choice_int
        \tl_set:Nn \l_@@_info_degree_tl
            \clist_item:Nn \c_@@_name_degree_clist
              { \l_@@_info_degree_int }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% 进行学位的判断。
%    \begin{macrocode}
Yu Xiong's avatar
Yu Xiong committed
        \int_compare:nTF { \l_@@_info_degree_int == 1 }
          { \tl_set:Nn \l_@@_info_diploma_tl { ug } }
          { \tl_set:Nn \l_@@_info_diploma_tl { g  } }
    degree            .initial:n  = ug,
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{type}
% 论文类型,默认为毕业论文。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
    type              .choices:nn = { thesis, design }
        \int_set_eq:NN \l_@@_info_type_int \l_keys_choice_int
        \tl_set:Nn \l_@@_info_type_tl
          { \clist_item:Nn \c_@@_name_type_clist { \l_@@_info_type_int } }
        \tl_put_left:Nn \l_@@_info_type_tl
          { \tl_use:c { c_@@_name_ \l_@@_info_diploma_tl _tl } }
      },
    type              .initial:n    = thesis,
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% \end{macro}
Yu Xiong's avatar
Yu Xiong committed
% \begin{macro}{nlcover}
Yu Xiong's avatar
Yu Xiong committed
% 是否需要国家图书馆封面(仅对研究生有效,默认关闭)。
% \footnote{nl 代表 National Library。}
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
    nlcover          .bool_set:N  = \g_@@_nlcover_bool,
    nlcover           .initial:n  = false,
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% \end{macro}
% \begin{macro}{decl-page}
% \changes{v0.13}{2021/12/15}{新增诚信承诺书选项。}
% \changes{v0.14}{2022/01/06}{修改选项名称。}
% 是否需要诚信承诺书或原创性声明(默认关闭)。
% \footnote{原创性声明的英文翻译为 Declaration of Originality,为了使选项表义更清晰同时缩减名称长度,将其修改为“声明页”这一名称。}
%    \begin{macrocode}
    decl-page        .bool_set:N  = \g_@@_orig_decl_bool,
    decl-page         .initial:n  = false,
%    \end{macrocode}
% \end{macro}
%
Yu Xiong's avatar
Yu Xiong committed
% \begin{macro}{draft}
% \changes{v0.13}{2021/12/15}{新增草稿模式选项。}
% 是否开启草稿模式(默认关闭)。
%    \begin{macrocode}
    draft           .bool_gset:N  = \g_@@_draft_bool,
    draft             .initial:n  = false,
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{oneside,twoside}
% \changes{v0.14}{2022/01/14}{新增单双面模式选项。}
% 单双面模式(默认为双面)。
%    \begin{macrocode}
    oneside   .value_forbidden:n  = true,
    twoside   .value_forbidden:n  = true,
Yu Xiong's avatar
Yu Xiong committed
    oneside .bool_gset_inverse:N  = \g_@@_twoside_bool,
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% \end{macro}
% \begin{macro}{latin-font,cjk-font}
% \changes{v0.14}{2021/12/12}{简化字体选项名称。}
% 定义字体选项。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
    latin-font        .choices:nn =
      { gyre, mac, win, none }
      { \tl_set_eq:NN \g_@@_latin_font_tl \l_keys_choice_tl },
    cjk-font          .choices:nn =
      { fandol, founder, mac, noto, source, win, none }
      { \tl_set_eq:NN \g_@@_cjk_font_tl   \l_keys_choice_tl },
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
Yu Xiong's avatar
Yu Xiong committed
% \end{macro}
% 在定义完全部设置以后从导言区输入参数。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
\ProcessKeysOptions { nju }
%    \end{macrocode}
% \subsection{用户接口}
%
% \begin{macro}{bib,info,style}
% 定义元(meta)键值对。
%    \begin{macrocode}
\keys_define:nn { nju }
  {
    bib   .meta:nn = { nju / bib   } { #1 },
    info  .meta:nn = { nju / info  } { #1 },
    style .meta:nn = { nju / style } { #1 }
  }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\njusetup}
% \changes{v0.6}{2021/09/10}{改用键值对输入信息。}
% 定义用于设置信息的命令。
%    \begin{macrocode}
\NewDocumentCommand \njusetup { m } { \keys_set:nn { nju } { #1 } }
%    \end{macrocode}
% \end{macro}
%
%
% \subsection{配置常量}
% TODO: 分离为单独文件
% 通用默认名称。注意空格是忽略掉的。
%    \begin{macrocode}
\clist_map_inline:nn
  {
    { acknowledgement } { 致\hspace{2em}谢              },
    { id              } { 学号                          },
Yu Xiong's avatar
Yu Xiong committed
    { notation        } { 符号表                        },
    { orig_date       } { 日期                          },
    { paperlist       } { 发表文章目录                  },
    { pdf_creator     } { LaTeX~ with~ njuthesis~ class },
    { preface         } { 前\hspace{2em}言              },
    { supv_ii         } { 第二导师                      },
    { supv_ttl        } { 职称                          }
  }
  { \@@_define_name:nn #1 }
%    \end{macrocode}
%
% 定义同时使用到中英文名称的常量。
%    \begin{macrocode}
\clist_map_inline:nn
  {
    { abstract  } { 摘要     } { ABSTRACT            },
    { appendix  } { 附录     } { appendix            },
    { dept      } { 院系     } { DEPARTMENT          },
    { figure    } { 图       } { figure              },
    { keywords  } { 关键词: } { Keywords:~          },
    { lang      } { 中文     } { 英文                },
    { nju       } { 南京大学 } { Nanjing~ University },
    { table     } { 表       } { table               }
  }
  { \@@_define_name:nnn #1 }
%    \end{macrocode}
%
% 针对学位的特定名称。需要放在 \cs{ProcessKeysOptions} 导入设置选项后,以使用学位信息。
%    \begin{macrocode}
Yu Xiong's avatar
Yu Xiong committed
\int_compare:nTF { \l_@@_info_degree_int == 1 }
  {
%    \end{macrocode}
% 本科默认名称。
%    \begin{macrocode}
    \clist_map_inline:nn
      {
        { author_full } { 本科生姓名                      },
        { grade       } { 年级                            },
        { orig_decl   } { 本科毕业论文(设计)诚信承诺书  },
        { orig_sign   } { 作者签名                        },
        { sm_date     } { 提交日期                        },
        { supv        } { 导师                            },
        { title       } { 题目                            },
        { type        } { 本科生毕业论文(设计、作品)    },
        { ug          } { 本科                            }
      }
      { \@@_define_name:nn #1 }
      \clist_map_inline:nn
        {
          { author    } { 学生姓名               } { UNDERGRADUATE  },
          { major     } { 专业                   } { SPECIALIZATION },
          { supv_full } { 指导教师(姓名、职称) } { MENTOR         }
        }
        { \@@_define_name:nnn #1 }
%    \end{macrocode}
%
% \begin{variable}{\c_@@_orig_decl_text_tl}
% 学位论文诚信承诺书。
%    \begin{macrocode}
      \tl_const:Nn \c_@@_orig_decl_text_tl
        {
          本人郑重承诺:所呈交的毕业论文(设计)(题目:)是在指导教师的指导下
          严格按照学校和院系有关规定由本人独立完成的。本毕业论文(设计)中引用
          他人观点及参考资源的内容均已标注引用,如出现侵犯他人知识产权的行为,
          由本人承担相应法律责任。本人承诺不存在抄袭、伪造、篡改、代写、买卖毕
          业论文(设计)等违纪行为。
        }
% \end{variable}
%
% 研究生默认名称。
%    \begin{macrocode}
  {
    \clist_map_inline:nn
      {
        { abstract_r  } { 摘要首页用纸       },
Yu Xiong's avatar
Yu Xiong committed
        { author_r    } { 生姓名             },
        { chairman    } { 答辩委员会主席:   },
        { clc         } { 分类号             },
        { confer      } { 学位授予单位和日期 },
        { df_date     } { 论文答辩日期       },
        { degree      } { 申请学位级别       },
        { apply       }
        { (申请 \l_@@_info_degree_tl 学位) },
        { field       } { 研究方向           },
        { g           } { 研究生             },
        { grade       } { 级                 },
        { major_s     } { 专业               },
        { major_nl    } { 专业名称           },
        { orig_decl   } { 学位论文原创性声明 },
        { orig_sign   } { 研究生签名         },
        { reviewer    } { 评阅人:           },
        { seclv       } { 密级               },
        { sign        } { (签字)           },
        { sm_date     } { 论文提交日期       },
        { supv        } { 导师               },
        { supv_r      } { (姓名、职称)     },
        { supv_info   } { 指导教师姓名、职务、
                  职称、学位、单位名称及地址 },
        { title       } { 论文题目           },
        { title_nl    } { (题名和副题名)   },
        { title_s     } { 题目               },
        { udc         } { U D C              }
      }
      { \@@_define_name:nn #1 }
      \clist_map_inline:nn
        {
          { author    } { 作者姓名 } { POSTGRADUATE   },
          { major     } { 专业方向 } { SPECIALIZATION },
          { supv_full } { 指导教师 } { MENTOR         }
        }
        { \@@_define_name:nnn #1 }
%    \end{macrocode}
% \begin{variable}{\c_@@_cover_en_text_tl}
% 英文封面字样。
%    \begin{macrocode}
    \tl_const:Nn \c_@@_cover_en_text_tl
      {
        A~ dissertation~ submitted~ to \\
        the~ graduate~ school~ of~ Nanjing~ University \\
        in~ partial~ fulfilment~ of~ the~ requirements~ for~ the~ degree~ of
      }
%    \end{macrocode}
% \end{variable}
%
% \begin{variable}{\c_@@_orig_decl_text_tl}
% 学位论文原创性声明。
%    \begin{macrocode}
    \tl_const:Nn \c_@@_orig_decl_text_tl
      {
        本人郑重声明,所提交的学位论文是本人在导师指导下独立进行科学研究工作
        所取得的成果。除本论文中已经注明引用的内容外,本论文不包含其他个人或
        集体已经发表或撰写过的研究成果,也不包含为获得南京大学或其他教育机构
        的学位证书而使用过的材料。对本文的研究做出重要贡献的个人和集体,均已
        在论文的致谢部分明确标明。本人郑重申明愿承担本声明的法律责任。
      }
  }
%    \end{macrocode}
% \end{variable}
% \begin{variable}{\c_@@_theorem_type_clist}
% 默认定理类型。
%    \begin{macrocode}
\clist_const:Nn \c_@@_theorem_type_clist
  { axiom, corollary, definition, example, lemma, theorem }
%    \end{macrocode}
% \end{variable}
%
% 默认定理头名称。
%    \begin{macrocode}
\clist_map_inline:nn
  {
    { axiom      } { 公理 } { Axiom      },
    { corollary  } { 推论 } { Corollary  },
    { definition } { 定义 } { Definition },
    { example    } { 例   } { Example    },
    { lemma      } { 引理 } { Lemma      },
    { proof      } { 证明 } { Proof      },
    { theorem    } { 定理 } { Theorem    }
  }
  { \@@_define_name:nnn #1 }
%    \end{macrocode}
Yu Xiong's avatar
Yu Xiong committed
% \subsection{载入宏包}
%
% \changes{v0.12}{2021/12/07}{重新组织宏包载入顺序。}
% 将选项传入 \cls{ctexbook} 文档类。
\PassOptionsToClass
  {
    a4paper,
    UTF8,
    scheme=chinese,
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% 传入单双面模式选项。
%    \begin{macrocode}
    \bool_if:NTF \g_@@_twoside_bool { twoside, } { oneside, }
%    \end{macrocode}
% 开启草稿模式后传入 |draft| 选项。
%    \begin{macrocode}
    \bool_if:NT \g_@@_draft_bool { draft, }
%    \end{macrocode}
% 关于行距,\hologo{LaTeX} 默认1.2行距,word 默认行距是1.3,要求1.5倍 word 行距,故
Yu Xiong's avatar
Yu Xiong committed
% $1.5\times\frac{1.3}{1.2} = 1.625$
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
    linespread=1.625,
%    \end{macrocode}
% 默认不载入任何字体,供本模板自行设置。
%    \begin{macrocode}
    fontset=none,
%    \end{macrocode}
% 正文字体设置为小四号。
%    \begin{macrocode}
    zihao=-4
  }
  { ctexbook }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
%
% 传入各宏包选项。
%    \begin{macrocode}
\clist_map_inline:nn
  {
    { no-math           } { fontspec     },
    { perpage           } { footmisc     },
    { amsmath, thmmarks } { ntheorem     },
    { hyphens           } { url          },
    { warnings-off={ mathtools-colon, mathtools-overbracket } }
                          { unicode-math },
    { capitalise, nameinlink, noabbrev }
  }
  { \PassOptionsToPackage #1 }
%    \end{macrocode}
%
% 使用\pkg{ctexbook}作为基础文档类。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
\LoadClass { ctexbook } [ 2018/04/01 ]
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
%
% \changes{v0.14}{2021/12/21}{移除内置的 \pkg{hologo}。}
Yu Xiong's avatar
Yu Xiong committed
% \changes{v0.15}{2022/01/17}{移除内置的 \pkg{url}。}
Yu Xiong's avatar
Yu Xiong committed
% 载入各种宏包。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
Yu Xiong's avatar
Yu Xiong committed
\RequirePackage
  {
    geometry,
    fancyhdr,
    setspace,
%    \end{macrocode}
% 南京大学视觉形象化标准宏包 \pkg{njuvisual} 用于绘制学校 logo。
%    \begin{macrocode}
    njuvisual,
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% \changes{v0.13}{2021/12/13}{使用 \pkg{ntheorem} 创建定理环境,删除 \pkg{amsthm} 和 \pkg{thmtools}。}
Yu Xiong's avatar
Yu Xiong committed
% 数学,\pkg{amsmath} 必须在 \pkg{unicode-math} 前加载。
% \pkg{unicode-math} 指定了 \hologo{XeTeX} 和 \hologo{LuaTeX} 下所使用的数学字体。
% 用于配置数学环境的 \pkg{mathtools} 会与 \pkg{unicode-math} 发生冲突,此处手动消除其警告。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
    amsmath,
    mathtools,
    unicode-math,
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% \changes{v0.14}{2021/12/21}{移除内置的 \pkg{multirow}、\pkg{subcaption} 和 \pkg{wrapfig}。}
% 图片与表格。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
    booktabs,
    caption,
    graphicx,
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
    enumitem,
%    \end{macrocode}
% 按以下顺序加载两个关于引用的包。
% \pkg{hyperref} 覆写了大量命令,因此需要在其他包最后载入。
% 仅有 \pkg{cleveref} 需要在 \pkg{hyperref} 后载入,否则会报错。
%    \begin{macrocode}
    hyperref,
    cleveref
  }
% 在双面模式下,使用 \pkg{emptypage} 清除空白页的页眉、页脚和页码。
%    \begin{macrocode}
\bool_if:NT \g_@@_twoside_bool { \RequirePackage{ emptypage } }
%    \end{macrocode}
%
% \changes{v0.13}{2021/12/13}{删除会与 \pkg{ntheorem} 冲突的 \pkg{microtype}。}
% \begin{macro}{\njuline}
% 针对编译引擎,使用不同的宏包构建可以对中文正常换行的下划线命令。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
\sys_if_engine_xetex:T
  {
    \RequirePackage{xeCJKfntef}
    \NewDocumentCommand \njuline { m } { \CJKunderline{#1} }
  }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
% \pkg{lua-ul} 中需要在结尾使用 \tn{null} 保护尾部空白。
\sys_if_engine_luatex:T
  {
    \RequirePackage{lua-ul}
    \NewDocumentCommand \njuline { m } { \underLine{#1} \null }
  }
% \end{macro}
% \begin{macro}{\@@_check_package:nnn}
% 检查过时宏包。
%    \begin{macrocode}
\msg_new:nnn { njuthesis } { package-too-old }
  {
    Package~ "#1"~ is~ too~ old. \\
Yu Xiong's avatar
Yu Xiong committed
    The~ njuthesis~ class~ only~ supports~ "#1"~ with~
    a~ version higher~ than~ v#2.\\
    Please~ update~ an~ up-to-date~ version~ of~ it~
Yu Xiong's avatar
Yu Xiong committed
    using~ your TeX~ package~ manager~ or~ from~ CTAN.
  }
\cs_new_protected:Npn \@@_check_package:nnn #1#2#3
  {
    \@ifpackagelater {#1} {#2}
      { } { \msg_error:nnnn { njuthesis } { package-too-old } {#1} {#3} }
  }
%    \end{macrocode}
% \end{macro}
%
% 检查绘制下划线所需的 \pkg{luatexja} 包版本。该宏包在2021-09-18的更新解决了下划线中断问题,然而在2021-10-24的更新才提供了正确的内嵌日期。
%    \begin{macrocode}
\sys_if_engine_luatex:T
  { \@@_check_package:nnn { luatexja } { 2021/10/24 } { 20211024.0 } }
%    \end{macrocode}
%
% \subsection{个人信息}
% \changes{v0.11}{2021/10/01}{将个人信息变量名改为小写字母加连字符的形式。}
% \changes{v0.15}{2022/01/22}{将个人信息设置移到载入宏包后。}
%
%    \begin{macrocode}
\keys_define:nn { nju / info }
  {
%    \end{macrocode}
%
% \begin{macro}{info/title,info/title*}
% \changes{v0.13}{2021/12/12}{简化多行标题的输入方式。}
% \changes{v0.14}{2022/01/14}{将标题断行控制符修改为 |\\|。}
% 题目。中文题目可使用 |\\| 手动断行。以下标注星号(|*|)的皆为对应的英文字段。
%    \begin{macrocode}
    title               .tl_set:N = \l_@@_info_title_tl,
    title              .initial:n = { 空 },
    title*              .tl_set:N = \l_@@_info_title_en_tl,
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{info/keywords,info/keywords*}
% \changes{v0.11}{2021/10/01}{修改了添加关键词的方式。}
% 关键词列表。
%    \begin{macrocode}
    keywords         .clist_set:N = \l_@@_info_keywords_clist,
    keywords*        .clist_set:N = \l_@@_info_keywords_en_clist,
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{info/grade,info/student-id,info/author,info/author*}
% 年级、学号、姓名。
%    \begin{macrocode}
    grade               .tl_set:N = \l_@@_info_grade_tl,
    student-id          .tl_set:N = \l_@@_info_id_tl,
    author              .tl_set:N = \l_@@_info_author_tl,
    author*             .tl_set:N = \l_@@_info_author_en_tl,
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{info/department,info/department*,info/major,info/major*,info/field,info/field*}
% 院系、专业、方向。
%    \begin{macrocode}
    department          .tl_set:N = \l_@@_info_dept_tl,
    department*         .tl_set:N = \l_@@_info_dept_en_tl,
    major               .tl_set:N = \l_@@_info_major_tl,
    major*              .tl_set:N = \l_@@_info_major_en_tl,
    field               .tl_set:N = \l_@@_info_field_tl,
    field*              .tl_set:N = \l_@@_info_field_en_tl,
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{info/supervisor,info/supervisor*}
% \changes{v0.13}{2021/12/11}{修改了导师选项的变量名称。}
% \changes{v0.14}{2022/01/12}{精简导师信息选项。}
% 导师信息。中文导师全称使用 |clist| 存储,便于在本科生封面中进行分割。
%    \begin{macrocode}
    supervisor       .clist_set:N = \l_@@_info_supv_clist,
    supervisor*         .tl_set:N = \l_@@_info_supv_en_tl,
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{info/supervisor-ii,info/supervisor-ii*}
% 第二导师信息。
%    \begin{macrocode}
    supervisor-ii    .clist_set:N = \l_@@_info_supv_ii_clist,
    supervisor-ii*      .tl_set:N = \l_@@_info_supv_ii_en_tl,
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{info/submit-date}
% \changes{v0.14}{2022/01/14}{精简提交日期选项。}
% 提交日期,初始值为编译当天日期。
%    \begin{macrocode}
    submit-date         .tl_set:N = \l_@@_info_sm_date_raw_tl,
    submit-date        .initial:V = \c_@@_today_tl,
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{info/defend-date}
% \changes{v0.14}{2022/01/14}{精简答辩日期选项。}
% 答辩日期。
%    \begin{macrocode}
    defend-date         .tl_set:N = \l_@@_info_df_date_raw_tl,
    defend-date        .initial:V = \c_@@_today_tl,
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{info/defend-date,info/chairman,info/reviewer}
% 答辩委员会信息。
%    \begin{macrocode}
    chairman            .tl_set:N = \l_@@_info_chairman_tl,
    reviewer         .clist_set:N = \l_@@_info_reviewer_clist,
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{info/clc,info/secret-level,info/udc,info/supervisor-contact}
% 国家图书馆封面相关信息。
%    \begin{macrocode}
    clc                 .tl_set:N = \l_@@_info_clc_tl,
    secret-level        .tl_set:N = \l_@@_info_seclv_tl,
    udc                 .tl_set:N = \l_@@_info_udc_tl,
    supervisor-contact  .tl_set:N = \l_@@_info_supv_cont_tl,
  }
%    \end{macrocode}
% \end{macro}
%
% \changes{v0.15}{2022/01/22}{正确处理双导师信息。}
% 在导言区录入用户信息后进行变量设置。此处使用到了 \pkg{ctex} 提供的命令,应当位于载入文档类之后。
%    \begin{macrocode}
\ctex_at_end_preamble:n
  {
%    \end{macrocode}
% 拼合双导师的姓名和职称。
%    \begin{macrocode}
    \bool_set:Nn \l_@@_second_supv_bool
      { ! \clist_if_empty_p:N \l_@@_info_supv_ii_clist }
    \tl_set:Nx \l_@@_info_supv_full_tl
      {
        \clist_use:Nn \l_@@_info_supv_clist { \@@_hskip: }
        \bool_if:NT \l_@@_second_supv_bool
          {
            \@@_quad:
            \clist_use:Nn \l_@@_info_supv_ii_clist { \@@_hskip: }
          }
      }
    \tl_set:Nx \l_@@_info_supv_full_en_tl
      {
        \l_@@_info_supv_en_tl
        \bool_if:NT \l_@@_second_supv_bool
          { \@@_quad: \l_@@_info_supv_ii_en_tl }
      }
%    \end{macrocode}
% 将 ISO 格式的原始日期字符串格式化为中文日期表示,该字符串需要进行展开。
%    \begin{macrocode}
    \tl_set:Nn \l_@@_info_sm_date_tl
      {
        \exp_last_unbraced:NV
          \@@_date:www \l_@@_info_sm_date_raw_tl \q_stop
      }
%    \end{macrocode}
% 英文提交日期以及答辩日期仅用于研究生封面。
%    \begin{macrocode}
    \int_compare:nF { \l_@@_info_degree_int == 1 }
      {
        \tl_set:Nn \l_@@_info_sm_date_en_tl
          {
            \exp_last_unbraced:NV
              \@@_date_en:www \l_@@_info_sm_date_raw_tl \q_stop
          }
        \tl_set:Nn \l_@@_info_df_date_tl
          {
            \exp_last_unbraced:NV
              \@@_date:www \l_@@_info_df_date_raw_tl \q_stop
          }
      }
  }
%    \end{macrocode}
%
%
Yu Xiong's avatar
Yu Xiong committed
% \subsection{字体设置}
% \pkg{fontspec} 包含于 \pkg{ctex} 宏集,无需另行载入。
Yu Xiong's avatar
Yu Xiong committed
% \subsubsection{操作系统检测}
Yu Xiong's avatar
Yu Xiong committed
% 判断用户是否自定义了中英文字体。如果其中任意一种未被定义,
Yu Xiong's avatar
Yu Xiong committed
% 则使用系统预装字体覆盖字体选项。
\tl_if_empty:NTF \g_@@_latin_font_tl
  { \bool_gset_true:N \g_@@_load_sys_font_bool }
  {
    \tl_if_empty:NT \g_@@_cjk_font_tl
      { \bool_gset_true:N \g_@@_load_sys_font_bool }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
%
% 进行系统检测。
% 检测 Windows 的命令由 \pkg{l3kernel} 提供,
% 检测 macOS 的命令由 \pkg{ctex} 提供,
Yu Xiong's avatar
Yu Xiong committed
% 这两种情况外的系统被判断为 Linux,一律使用自由字体。
%    \begin{macrocode}
\bool_if:NT \g_@@_load_sys_font_bool
Yu Xiong's avatar
Yu Xiong committed
    \sys_if_platform_windows:TF
      { \tl_set:Nn \g_@@_latin_font_tl   { win    }
        \tl_set:Nn \g_@@_cjk_font_tl     { win    } }
Yu Xiong's avatar
Yu Xiong committed
      { \ctex_if_platform_macos:TF
        { \tl_set:Nn \g_@@_latin_font_tl { mac    }
          \tl_set:Nn \g_@@_cjk_font_tl   { mac    } }
        { \tl_set:Nn \g_@@_latin_font_tl { gyre   }
          \tl_set:Nn \g_@@_cjk_font_tl   { fandol } } }
Yu Xiong's avatar
Yu Xiong committed
% \subsubsection{定义英文字库}
%
Yu Xiong's avatar
Yu Xiong committed
% 接下来逐个定义所需要使用的字库。
% \begin{macro}{\@@_load_latin_font_win:}
% Windows 西文字体
%    \begin{macrocode}
\cs_new_protected:Npn \@@_load_latin_font_win:
Yu Xiong's avatar
Yu Xiong committed
  {
    \setmainfont{Times~New~Roman}
    \setsansfont{Arial}
    \setmonofont{Courier~New}[Scale=MatchLowercase]
  }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
Yu Xiong's avatar
Yu Xiong committed
%
% \begin{macro}{\@@_load_latin_font_mac:}
Yu Xiong's avatar
Yu Xiong committed
% macOS 西文字体。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
\cs_new_protected:Npn \@@_load_latin_font_mac:
Yu Xiong's avatar
Yu Xiong committed
  {
    \setmainfont{Times~New~Roman}
    \setsansfont{Arial}
    \setmonofont{Menlo}[Scale=MatchLowercase]
  }
Yu Xiong's avatar
Yu Xiong committed
%    \end{macrocode}
Yu Xiong's avatar
Yu Xiong committed
%
% \begin{macro}{\@@_load_latin_font_gyre:}
Yu Xiong's avatar
Yu Xiong committed
% 开源的 gyre 西文字体。
Yu Xiong's avatar
Yu Xiong committed
%    \begin{macrocode}
\cs_new_protected:Npn \@@_load_latin_font_gyre:
Yu Xiong's avatar
Yu Xiong committed
  {
    \setmainfont{texgyretermes}[
      Extension=.otf,
      UprightFont=*-regular,
      BoldFont=*-bold,
      ItalicFont=*-italic,
      BoldItalicFont=*-bolditalic]
    \setsansfont{texgyreheros}[
      Extension=.otf,
      UprightFont=*-regular,
      BoldFont=*-bold,
      ItalicFont=*-italic,
      BoldItalicFont=*-bolditalic]
    \setmonofont{texgyrecursor}[
      Extension=.otf,
      UprightFont=*-regular,
      BoldFont=*-bold,
      ItalicFont=*-italic,
      BoldItalicFont=*-bolditalic,