Skip to content

Commit 7421bc3

Browse files
committed
docs: add more docs for optional arguments.
1 parent b2753df commit 7421bc3

File tree

1 file changed

+129
-5
lines changed

1 file changed

+129
-5
lines changed

Diff for: bithesis.dtx

+129-5
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,37 @@
223223
% \end{document}
224224
% \end{latex}
225225
%
226+
% 如您所见,在 \LaTeX 中,用户使用的命令通常以「\\」作为开头,后面依次跟随
227+
% 命令名称、若干可选参数和若干必需参数。如:
228+
%
229+
% \begin{latex}
230+
% \MakeCover
231+
% \BITSetup{}
232+
% \FooBar[]{}
233+
% \end{latex}
234+
%
235+
% 同理,用户使用的环境通常以 begin 和 end 进行包裹,同样可以传入可选参数和必需参数:
236+
%
237+
% \begin{latex}
238+
% \begin{abstract}
239+
% \end{abstract}
240+
%
241+
% \begin{abstract}[addTOC=false]
242+
% \end{abstract}
243+
%
244+
% \begin{foo}{param1}
245+
% \end{foo}
246+
% \end{latex}
247+
%
248+
% 需要强调的是:以方框号表示的可选参数,在没有参数传入的时候,是可以忽略的。
249+
% 比如以下两个命令等价:
250+
% \begin{latex}
251+
% \FooBar
252+
% \FooBar[]
253+
% \end{latex}
254+
%
255+
% 环境同理。
256+
%
226257
% \subsection{模板选项}
227258
%
228259
% 所谓“模板选项”,指需要在引入文档类的时候指定的选项:
@@ -270,13 +301,13 @@
270301
% 本模板提供了一系列选项,可由您自行配置。载入文档类之后,以下所有选项均可通过统一的
271302
% 命令 \cs{BITSetup} 来设置。
272303
%
273-
% \cs{BITSetup} 的参数是一组由(英文)逗号隔开的选项列表,列表中的选项通常是 key =
274-
% value 的形式。部分选项的 value 可以省略。对于同一项,后面的设置将会覆盖前面的设
304+
% \cs{BITSetup} 的参数是一组由(英文)逗号隔开的选项列表,列表中的选项通常是 \meta{key} =
305+
% \meta{value} 的形式。部分选项的 \meta{value} 可以省略。对于同一项,后面的设置将会覆盖前面的设
275306
% 置。在下文的说明中,将用粗体表示默认值。
276307
%
277308
% \cs{BITSetup} 采用 LATEX3 风格的键值设置,支持不同类型以及多种层次的选项设定。键值列
278309
% 表中,“=”左右的空格不影响设置;但需注意,参数列表中不可以出现空行。
279-
% 与模板选项相同,布尔型的参数可以省略 〈选项〉 = true 中的“= true”。
310+
% 与模板选项相同,布尔型的参数可以省略 \meta{选项} = true 中的“= true”。
280311
% 另有一些选项包含子选项,如 cover 和 info 等。它们可以按如下两种等价方式来设定:
281312
%
282313
% \begin{latex}
@@ -664,6 +695,10 @@
664695
% \begin{abstract}
665696
% \meta{中文摘要}
666697
% \end{abstract}
698+
%
699+
% \begin{abstract}(*\oarg{可选参数}*)
700+
% \meta{中文摘要}
701+
% \end{abstract}
667702
% \end{bitsyntax}
668703
% \end{function}
669704
%
@@ -672,18 +707,57 @@
672707
% \begin{abstractEn}
673708
% \meta{英文摘要}
674709
% \end{abstractEn}
710+
%
711+
% \begin{abstractEn}(*\oarg{可选参数}*)
712+
% \meta{英文摘要}
713+
% \end{abstractEn}
675714
% \end{bitsyntax}
676715
%
677716
% 摘要。
678717
%
679718
% 摘要的最后会显示关键词,关键词通过 \cs{BITSetup} 录入。
719+
%
720+
% \end{function}
721+
%
722+
% \begin{function}{addTOC}
723+
% \begin{bitsyntax}[emph={[1]addTOC}]
724+
% addTOC = (*<(true)|false>*)
725+
% \end{bitsyntax}
726+
%
727+
% 摘要的可选参数。
728+
%
729+
% 添加摘要到目录,默认开启。
680730
% \end{function}
681731
%
682732
% \begin{function}{\MakeTOC,\listoffigures,\listoftables}
683733
%
684734
% 绘制目录、插图目录与表格目录。
685735
% \end{function}
686736
%
737+
% \begin{function}{symbols}
738+
% \begin{bitsyntax}[emph={[1]symbols}]
739+
% \begin{symbols}(*\oarg{可选参数}*)
740+
% \item[BIT] 北京理工大学的英文缩写
741+
% \item[\LaTeX] 一个很棒的排版系统
742+
% \end{symbols}
743+
% \end{bitsyntax}
744+
%
745+
% 主要符号对照表。
746+
%
747+
% 主要符号对照表类似于一个列表环境,用以添加文章中使用的关键符号与缩略词。
748+
%
749+
% \end{function}
750+
%
751+
% \begin{function}{addTOC}
752+
% \begin{bitsyntax}[emph={[1]addTOC}]
753+
% addTOC = (*<(true)|false>*)
754+
% \end{bitsyntax}
755+
%
756+
% 主要符号对照表的可选参数。
757+
%
758+
% 添加主要符号对照表到目录,默认开启。
759+
% \end{function}
760+
%
687761
% \subsection{正文部分}
688762
%
689763
% \begin{function}{\mainmatter}
@@ -734,15 +808,26 @@
734808
% \textbf{样式} & \multicolumn{1}{c}{\textit{注1.} 内容……} \\ \bottomrule
735809
% \end{tabular}
736810
% }
811+
%
812+
% \subfloat[][proof样式]{
813+
% \begin{tabular}{@{}cc@{}}
814+
% \toprule
815+
% \textbf{名称} & proof \\ \midrule
816+
% \textbf{含义} & 证明 \\
817+
% \textbf{样式} & \multicolumn{1}{c}{\textit{证明. } 内容…… 「证毕符号」} \\ \bottomrule
818+
% \end{tabular}
819+
% }
737820
% \label{tab:theorem}
738821
% \end{table}
739822
%
740823
% \subsection{后置部分}
741824
%
742-
% \begin{function}{\mainmatter}
825+
% \begin{function}{\backmatter}
743826
%
744827
% 声明后置部分开始。
745828
%
829+
% 会取消章节标题的的编号。
830+
%
746831
% \end{function}
747832
%
748833
% \begin{function}{conclusion}
@@ -774,7 +859,7 @@
774859
%
775860
% \begin{function}{appendices}
776861
% \begin{bitsyntax}[emph={[1]appendices}]
777-
% \begin{appendices}
862+
% \begin{appendices}(*\oarg{可选参数}*)
778863
% \section{附录A 题目}
779864
% \meta{附录A 内容}
780865
% \section{附录B 题目}
@@ -785,6 +870,45 @@
785870
% 附录。
786871
% \end{function}
787872
%
873+
% \begin{function}{chapterLevel}
874+
% \begin{bitsyntax}[emph={[1]chapterLevel}]
875+
% chapterLevel = (*<(false)|true>*)
876+
% \end{bitsyntax}
877+
%
878+
% 附录的可选参数。
879+
%
880+
% 开启后,可以使用以「chapter」为顶层的附录格式。
881+
%
882+
% \begin{latex}
883+
% \begin{appendices}[chapterLevel=true]
884+
% \chapter{附录A 题目}
885+
% \meta{附录A 内容}
886+
% \chapter{附录B 题目}
887+
% \meta{附录B 内容}
888+
% \end{appendices}
889+
% \end{latex}
890+
% \end{function}
891+
%
892+
% \begin{function}{title}
893+
% \begin{bitsyntax}[emph={[1]title}]
894+
% title = (*\meta{字符串}*)
895+
% \end{bitsyntax}
896+
%
897+
% 附录的可选参数。
898+
%
899+
% 可以覆盖附录的标题名称,默认为「附录」。
900+
% \end{function}
901+
%
902+
% \begin{function}{TOCTitle}
903+
% \begin{bitsyntax}[emph={[1]TOCTitle}]
904+
% TOCTitle = (*\meta{字符串}*)
905+
% \end{bitsyntax}
906+
%
907+
% 附录的可选参数。
908+
%
909+
% 可以覆盖附录在目录中的名称,默认为「附录」。
910+
% \end{function}
911+
%
788912
% \begin{function}{publications}
789913
% \begin{bitsyntax}[emph={[1]publications}]
790914
% \begin{publications}

0 commit comments

Comments
 (0)