Skip to content

Commit

Permalink
docs: better description of heading options
Browse files Browse the repository at this point in the history
  • Loading branch information
NemoYuan2008 committed Feb 7, 2025
1 parent d718adc commit 1287baf
Showing 1 changed file with 40 additions and 26 deletions.
66 changes: 40 additions & 26 deletions sjtutex/source/sjtutex.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -1275,23 +1275,16 @@
% 在文档开始后进行内容编写,文档内容由 |document| 环境包裹。
% \end{function}
%
% 本节部分环境或命令提供 \meta{局部参数},可以使用逗号分隔的选项列表作为可选参数
% 传入该环境,例如:
% \subsection{用于本节环境或命令的参数}
%
% 本节描述的部分环境和命令提供 \meta{标题参数},用于进行局部的标题相关设置。
% 可以使用逗号分隔的选项列表作为可选参数传入该环境,例如:
% \begin{latex}
% \begin{abstract}[lang=en,intoc]
% \begin{abstract}[intoc,title={自定义标题}]
% \end{abstract}
% \end{latex}
% 注意,索引中的 \texttt{private/} 前缀只是为了表明其是 \meta{局部参数}
% 注意,索引中的 \texttt{private/} 前缀只是为了表明其是 \meta{标题参数}
% 的可用选项,请不要在实际使用时添加该前缀。
% 部分环境在说明 \meta{局部参数} 时会添加前置局部参数,表明覆盖了默认参数。
%
% \begin{function}[added=2025-01-12]{private/lang}
% \begin{syntax}
% \OPT{lang} = <(zh)|en|de|ja>
% \end{syntax}
% 设置该环境的局部语言选项,默认与全局语言选项相同。
% 该选项会设置该环境的局部语言排版设置。
% \end{function}
%
% \begin{function}[added=2025-01-12]{private/intoc, private/notintoc}
% 指明该环境的小标题是否在目录中出现。
Expand All @@ -1315,6 +1308,21 @@
% 只有在设置 \opt{intoc} 小标题出现在目录中才会显示。
% \end{function}
%
% 部分环境还提供了参数 \opt{lang},用于设置环境的语言。
% \begin{function}[added=2025-01-12]{private/lang}
% \begin{syntax}
% \OPT{lang} = <(zh)|en|de|ja>
% \end{syntax}
% 设置该环境的局部语言选项,默认与全局语言选项相同。
% 该选项会设置该环境的局部语言排版设置。
% \end{function}
%
% 对于同时提供了 \meta{标题参数} 和 \opt{lang} 参数的环境,二者可以一同使用,例如:
% \begin{latex}
% \begin{abstract}[lang=en,intoc,title={自定义标题},marking={目录中的标题}]
% \end{abstract}
% \end{latex}
%
% \subsection{标题页和声明页}
%
% \begin{function}[updated=2022-12-03]{\maketitle}
Expand Down Expand Up @@ -1353,7 +1361,7 @@
%
% \begin{function}[updated=2024-12-20]{abstract}
% \begin{syntax}
% \BEV{abstract}\oarg{局部参数}
% \BEV{abstract}\oarg{lang=<(zh)|en|de|ja>,标题参数}
% \ \meta{\textup{\cls{sjtuthesis}} 中的摘要}
% \EEV{abstract}
% \BEV{abstract}
Expand All @@ -1369,8 +1377,14 @@
% \end{function}
%
% \begin{function}[updated=2024-12-20]{\tableofcontents,\listoffigures,\listoftables,\listofalgorithms}
% \begin{syntax}
% \TNA{tableofcontents}\oarg{标题参数}
% \TNA{listoffigures}\oarg{标题参数}
% \TNA{listoftables}\oarg{标题参数}
% \TNA{listofalgorithms}\oarg{标题参数}
% \end{syntax}
% 目录、插图、表格和算法等索引命令如表 \ref{tab:list} 所示,将其插入到期望的
% 位置即可,这些命令可以使用 \meta{局部参数} 作为可选参数
% 位置即可,这些命令可以使用可选的 \meta{标题参数} 来调整标题相关设置
% \begin{table}[H]
% \centering\small
% \begin{threeparttable}
Expand Down Expand Up @@ -1445,18 +1459,18 @@
%
% \begin{function}[rEXP,updated=2024-12-20]{nomenclature}
% \begin{syntax}
% \BEV{nomenclature}\oarg{局部参数}
% \BEV{nomenclature}\oarg{标题参数}
% \ \meta{符号对照表}
% \EEV{nomenclature}
% \end{syntax}
% 符号对照表环境。可以使用局部参数手动设置标题
% 符号对照表环境。可以使用 \meta{标题参数} 手动设置标题
% 符号对照表环境仅设置标题,内部实现可由用户自行决定:
% 可以使用 \pkg{longtable},也可以使用 \pkg{nomencl} 宏包。
% \end{function}
%
% \begin{function}[rEXP,updated=2024-12-20]{abbreviation}
% \begin{syntax}
% \BEV{abbreviation}\oarg{局部参数}
% \BEV{abbreviation}\oarg{标题参数}
% \ \meta{缩略语对照表}
% \EEV{abbreviation}
% \end{syntax}
Expand All @@ -1475,23 +1489,23 @@
%
% \begin{function}[rEXP,updated=2024-12-20]{acknowledgements}
% \begin{syntax}
% \BEV{acknowledgements}\oarg{局部参数}
% \BEV{acknowledgements}\oarg{标题参数}
% \ \meta{致谢内容}
% \EEV{acknowledgements}
% \end{syntax}
% 致谢环境。盲审模式下致谢将被隐去。可以使用局部参数手动设置标题
% 致谢环境。盲审模式下致谢将被隐去。可以使用 \meta{标题参数} 手动设置标题
% \end{function}
%
% \begin{function}[rEXP,updated=2024-12-20]{achievements}
% \begin{syntax}
% \BEV{achievements}\oarg{局部参数}
% \BEV{achievements}\oarg{标题参数}
% \ \meta{获得的科研成果}
% \EEV{achievements}
% \end{syntax}
% 科研成果环境,可以使用局部参数手动设置标题。内部请配合使用下面的附录用文献列表环境
% 科研成果环境,可以使用 \meta{标题参数} 手动设置标题。内部请配合使用下面的附录用文献列表环境
% \env{bibliolist} 和 \env{bibliolist*}。你可以在该环境中使用带星号的节次命令
% 以分隔不同的类型的成果(比如学术论文、专利等);你也可以使用多个 \env{achievements}
% 环境,配合不同的可选参数作为标题,展示不同类型的成果。
% 环境,配合不同的 \meta{标题参数},展示不同类型的成果。
% \end{function}
%
% \begin{function}[rEXP,updated=2024-12-08]{bibliolist,bibliolist*}
Expand All @@ -1513,16 +1527,16 @@
%
% \begin{function}[rEXP,updated=2024-12-20]{resume}
% \begin{syntax}
% \BEV{resume}\oarg{局部参数}
% \BEV{resume}\oarg{标题参数}
% \ \meta{简历内容}
% \EEV{resume}
% \end{syntax}
% 简历环境。盲审模式下简历将被隐去。可以使用局部参数手动设置标题
% 简历环境。盲审模式下简历将被隐去。可以使用 \meta{标题参数} 手动设置标题
% \end{function}
%
% \begin{function}[rEXP,updated=2024-12-20]{digest}
% \begin{syntax}
% \BEV{digest}\oarg{lang=en,局部参数}
% \BEV{digest}\oarg{lang=<zh|(en)|de|ja>,标题参数}
% \ \meta{大摘要}
% \EEV{digest}
% \end{syntax}
Expand Down

0 comments on commit 1287baf

Please sign in to comment.