Skip to content

Commit 29bf235

Browse files
committed
docs(.dtx): add more docs.
1 parent 9a9b676 commit 29bf235

File tree

1 file changed

+117
-0
lines changed

1 file changed

+117
-0
lines changed

Diff for: bithesis.dtx

+117
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,8 @@
255255
% 环境同理。
256256
%
257257
% \subsection{模板选项} \label{sec:template-options}
258+
%
259+
% TODO: add option / ctex
258260
%
259261
% 所谓“模板选项”,指需要在引入文档类的时候指定的选项:
260262
%
@@ -968,6 +970,121 @@
968970
% 个人简介。
969971
% \end{function}
970972
%
973+
% \section{\cls{bitreport} 使用与配置}
974+
%
975+
% 推荐使用\BIThesisRelease (开箱即用)。
976+
%
977+
% \BIThesisRelease 提供了多种最常用的模板,你可以在
978+
% \href{https://github.com/BITNP/BIThesis/releases}{主项目的 Releases}中找到它们。
979+
%
980+
% 使用此文档类的模板有:
981+
% \begin{itemize}
982+
% \item \BIThesisTemplates{UP}
983+
% \item \BIThesisTemplates{LR}
984+
% \end{itemize}
985+
%
986+
% \subsection{最小用例}
987+
%
988+
% \begin{latex}
989+
% \documentclass[]{bitreport}
990+
% \BITSetup{
991+
% info = {
992+
% author = FKY,
993+
% ......
994+
% }
995+
% }
996+
% \begin{document}
997+
% \end{document}
998+
% \end{latex}
999+
%
1000+
% \subsection{模板选项}
1001+
%
1002+
% 所谓“模板选项”,指需要在引入文档类的时候指定的选项:
1003+
%
1004+
% \begin{latex}[deletetexcs={\documentclass},morekeywords={\documentclass}]
1005+
% \documentclass(*\oarg{模板选项}*){bithesis}
1006+
% \end{latex}
1007+
%
1008+
% \begin{function}{type}
1009+
% \begin{bitsyntax}[emph={[1]type}]
1010+
% type = (*<(common)|\mbox{undergraduate_proposal}>*)
1011+
% \end{bitsyntax}
1012+
% 选择论文类型,它们分别对应:
1013+
% \begin{itemize}
1014+
% \item \BIThesisTemplates{LR}
1015+
% \item \BIThesisTemplates{UP}
1016+
% \end{itemize}
1017+
% \end{function}
1018+
%
1019+
% TODO: option / ctex
1020+
%
1021+
% \subsection{参数设置}
1022+
%
1023+
% \begin{function}{\BITSetup}
1024+
% \begin{bitsyntax}[emph={[1]BITSetup}]
1025+
% \BITSetup = {(*\oarg{键值对}*)}
1026+
% \end{bitsyntax}
1027+
% \end{function}
1028+
%
1029+
% 本模板提供了一系列选项,可由您自行配置。载入文档类之后,以下所有选项均可通过统一的
1030+
% 命令 \cs{BITSetup} 来设置。
1031+
%
1032+
% \cs{BITSetup} 的参数是一组由(英文)逗号隔开的选项列表,列表中的选项通常是 \meta{key} =
1033+
% \meta{value} 的形式。部分选项的 \meta{value} 可以省略。对于同一项,后面的设置将会覆盖前面的设
1034+
% 置。在下文的说明中,将用粗体表示默认值。
1035+
%
1036+
% \cs{BITSetup} 采用 LATEX3 风格的键值设置,支持不同类型以及多种层次的选项设定。键值列
1037+
% 表中,“=”左右的空格不影响设置;但需注意,参数列表中不可以出现空行。
1038+
% 与模板选项相同,布尔型的参数可以省略 \meta{选项} = true 中的“= true”。
1039+
% 另有一些选项包含子选项,如 cover 和 info 等。它们可以按如下两种等价方式来设定:
1040+
%
1041+
% \begin{latex}[morekeywords={\BITSetup},emph={[1]BITSetup,cover,date,info,title,author}]
1042+
% \BITSetup{
1043+
% cover = {
1044+
% date = 2022年6月,
1045+
% },
1046+
% info = {
1047+
% author = Feng Kaiyu,
1048+
% title = A Report Title for Your Experiment,
1049+
% }
1050+
% }
1051+
% \end{latex}
1052+
%
1053+
% 或者
1054+
%
1055+
% \begin{latex}[morekeywords={\BITSetup},emph={[1]BITSetup,cover,date,info,title,author}]
1056+
% \BITSetup{
1057+
% cover / date = 2022年6月,
1058+
% info / author = Feng Kaiyu,
1059+
% info / title = A Thesis Title for Your Paper,
1060+
% }
1061+
% \end{latex}
1062+
%
1063+
% \subsubsection{封面选项}
1064+
%
1065+
% \begin{function}{cover}
1066+
% \begin{bitsyntax}[emph={[1]cover}]
1067+
% cover = (*\marg{键值列表}*)
1068+
% cover/(*\meta{key}*) = (*\meta{value}*)
1069+
% \end{bitsyntax}
1070+
%
1071+
% 该选项包含许多子项目,用于设置论文格式。具体内容见下。
1072+
% \end{function}
1073+
%
1074+
% \begin{function}{cover/date}
1075+
% \begin{bitsyntax}[emph={[1]date}]
1076+
% date = (*\marg{任意字符串}*)
1077+
% \end{bitsyntax}
1078+
%
1079+
% 覆盖封面的日期。
1080+
% \end{function}
1081+
%
1082+
% \subsubsection{个人信息}
1083+
%
1084+
% TODO
1085+
% \subsubsection{其他选项}
1086+
%
1087+
% TODO
9711088
% \section{致谢}
9721089
% \begin{itemize}
9731090
% \item 感谢贡献者对 BIThesis 的无私奉献。

0 commit comments

Comments
 (0)