1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
|
\documentclass[load-preamble+]{cnltx-doc}
\usepackage[fontset = fandol]{ctex}
\usepackage
{
enumitem,newtxmath,indentfirst,tabularray,
fancyvrb,geometry,hologo,pifont
}
\definecolorscheme{blue}
{
cs => purple,
option => black!10!teal,
cnltx => Blue,
link => OrangeRed,
module => violet,
meta => black
}
\setcnltx
{
name = easybook,
color-scheme = blue,
title = EASYBOOK 使用手册,
version = v1.41U,
date = 2021/12/15,
authors = 瞿毅,
info = 排版简体中文学位论文和书籍,
email = q1jx@foxmail.com,
url = https://gitee.com/texl3/easybook,
abstract =
{
\cls*{easybook} 是基于 \cls*{ctexbook} 书籍文档类创建以极简为风格的模板,同时兼具 \cls*{book} 与 \cls*{article} 文档类的功能。结合中国许多高校学位论文的通用框架设计,提供多个命令和接口可以使用户简便地定制论文模板。它的基础宏包 \pkg*{easybase} 还可以搭配 C\TeX 和标准文档类使用。
},
arg-format = \normalfont\small\itshape,
abstract-format = \small,
module-sep = \,$\Rightarrow$\,,
title-format = \huge\sffamily
}
\KOMAoptions{headsepline = 0.5pt,numbers = noenddot}
\setfootnoterule[0.5pt]{0.4\columnwidth}
\addtokomafont{headsepline}{\color{Blue}}
\addtokomafont{footnoterule}{\color{Blue}}
\addtokomafont{section}{\normalfont\sffamily}
\addtokomafont{subsection}{\normalfont\sffamily}
\addtokomafont{subsubsection}{\normalfont\sffamily}
\DeclareTOCStyleEntry[entryformat = \sffamily]{default}{section}
\geometry{margin = 1in,marginparwidth = 0.65in}
\setlist{nosep,labelindent = \parindent,leftmargin = *,labelsep = 0.5em}
\setlist[itemize,1]{label = \small\color{Blue}\textbullet}
\setcounter{tocdepth}{2}
\SetTblrInner{hline{1,Z} = {0.8pt,Blue}}
\ExplSyntaxOn\makeatletter
\newcommand{\splitmeta}[2][\code{,}]
{
\clist_clear:N \l_tmpa_clist
\clist_map_inline:nn {#2}
{ \clist_put_right:Nn \l_tmpa_clist { \meta{##1} } }
\clist_use:Nn \l_tmpa_clist {#1}
}
\newcommand{\newsplitarg}[4][\splitmeta]
{
\newcommand{#2}[1]
{\code{\textcolor{argument}{#3\textnormal{#1{##1}}#4}}}
}
\NewDocumentCommand{\kvsplit}{st-mm}
{
\item\code
{
\option{#3}\cnltx@isvalue
\IfBooleanTF{#2}{#4}{\IfBooleanTF{#1}{\Marg{#4}}{\splitmarg{#4}}}
}
}
\newarg[\color{violet}\code]\Carg{\{}{\}}
\newsplitarg{\splitoarg}{[}{]}
\newsplitarg{\splitdarg}{(}{)}
\newsplitarg{\splitmarg}{\{}{\}}
\newcommand{\spemmeta}{\splitmeta[\code{|}]}
\newsplitarg[\spemmeta]{\spemcoarg}{[}{]}
\newcommand{\harg}{\textcolor{argument}{\code{-}}}
\NewDocumentCommand{\passto}{smm}
{\IfBooleanF{#1}{\color{Blue}}#3\ifblank{#2}{}{\ttfamily[#2]}}
\newcommand{\insertblr}[2]
{
\begin{center}
\begin{tblr}{#1}
#2
\end{tblr}
\end{center}
}
\newcommand{\black}[1]{\textcolor{black}{#1}}
\newcommand{\noitemsep}{\setlength{\itemsep}{0ex}}
\renewcommand{\cnltx@package@abstract@width}{0.85\linewidth}
\renewcommand{\cmltx@list@setup}
{
\setlength{\leftmargin}{0em}
\setlength{\labelwidth}{2em}
\setlength{\itemindent}{-1em}
\setlength{\labelsep}{0em}
\setlength{\listparindent}{2em}
\setlength{\topsep}{0.75ex plus .1ex}
\setlength{\itemsep}{0.75ex plus .1ex}
\setlength{\partopsep}{0ex}
\setlength{\parsep}{0ex}
}
\newcounter{ctexexam}
\define@key{FV}{labelref}{\def\ctexexamlabelref{\label{#1}}}
\let\ctexexamlabelref\empty
\DefineVerbatimEnvironment{frameverb}{Verbatim}
{
baselinestretch = 1.2,gobble = 2,fontsize = \small,
rulecolor = \color{Blue},framerule = 0.5pt,
frame = single,framesep = 10pt,
listparameters =
{
\setlength{\topsep}{\bigskipamount}
\appto\FV@EndList{\nointerlineskip}
}
}
\DefineVerbatimEnvironment{ctexexam}{Verbatim}
{
baselinestretch = 1.2,gobble = 2,fontsize = \small,
rulecolor = \color{Blue},framerule = 0.5pt,
frame = single,framesep = 10pt,
label = \rule{0pt}{12pt}\textnormal{\bfseries 例 \arabic{ctexexam}},
listparameters =
{
\setlength{\topsep}{\bigskipamount}
\refstepcounter{ctexexam}\ctexexamlabelref
\appto\FV@EndList{\nointerlineskip}
}
}
\makeatother\ExplSyntaxOff
\labelformat{section}{节 #1}
\labelformat{subsection}{小节 #1}
\labelformat{subsubsection}{小节 #1}
\labelformat{ctexexam}{例 #1}
\begin{document}
\section{准备开始}
您在使用 \cls*{easybook} 文档类编写文档前可能需要具备以下的条件:
\begin{itemize}
\item 使用 \hologo{XeLaTeX}(推荐)或 \hologo{LuaLaTeX} 两种编译方式。
\item 由于用到了一些 \LaTeX 和宏包较新的功能,建议安装最新的 \TeX 发行版,例如 \TeX Live 2021 或 \hologo{MiKTeX} 21.2 之后的版本。
\item 虽然手册对基本用法做了介绍,但这并不是入门教程,所涉及到宏包的用法与命令也需要有了解。您应当具有一定的 \LaTeX 使用基础,可以在 \TeX 综合网站 \href{https://www.ctan.org/}{CTAN} 查看相关资源。
\end{itemize}
\subsection{基本用法}
\label{subsec:basic usage}
以下一份简单的 \TeX 文档演示了 \cls*{easybook} 的最基本用法,在导言区进行宏包载入与文档设置,一些详细的使用样例会不定期上传在 \href{https://www.latexstudio.net/}{\LaTeX 工作室} 的网站。
\begin{frameverb}
\documentclass[文档类选项]{easybook}
\ctexset{键值列表}
\usepackage{宏包列表}
\begin{document}
\chapter{欢迎}
\section{Welcome to easybook}
Hello, \LaTeX
\end{document}
\end{frameverb}
或者直接使用 \pkg*{easybase} 宏包,目前适用于 \cls*{ctexbook}、\cls*{ctexrep}、\cls*{ctexart} 以及标准文档类,包含了\ref{sec:interface options} 所示各个模块接口命令的功能。它的宏包选项共享文档类选项的一部分,支持的选项见\ref{sec:document class options}。当在\textbf{标准文档类}后载入时还可以使用 \pkg*{ctex} 宏包的选项,将会传递给 \pkg*{ctex} 宏包。
\begin{frameverb}
\documentclass[文档类选项]{ctexbook}
\usepackage[宏包选项]{easybase}
\ctexset{键值列表}
\usepackage{宏包列表}
\begin{document}
\chapter{欢迎}
\section{Welcome to easybook}
Hello, \LaTeX
\end{document}
\end{frameverb}
\subsection{编译方式}
假设您的 \TeX 源文件名为 \code{easybook.tex},需要使用参考文献和索引功能,并使用 \hologo{XeLaTeX} 和 \hologo{BibTeX} 引擎编译文档,那么需要在命令行中执行:
\begin{frameverb}
xelatex -shell-escape easybook
bibtex easybook
makeindex easybook
xelatex -shell-escape easybook
xelatex -shell-escape easybook
\end{frameverb}
当然也可以使用 \code{latexmk} 及一些软件自带的编译工具,这里就不做介绍。 \\
\ding{72} 需要注意正确\textbf{编译索引}要增加 \code{-shell-escape} 命令行选项。
\subsection{依赖宏包}
以下为 \pkg*{easybase} 直接调用的关键宏包清单,通常情况下它们是常用且稳定的。棕色背景的宏包表示修改了或依赖它们的内部命令。青色背景的宏包表示并未调用它们,但做了一些预配置,可在导言区手动载入以实现相关的功能。
\insertblr
{
colspec = @{}*{5}{c}@{},
cells = {cmd = \pkg*},
cell{1}{3,4} = brown8,
cell{2}{5} = brown8,
cell{3}{2,4} = brown8,
cell{5}{1} = brown8,
cell{1}{2} = cyan8,
cell{3}{1,4} = cyan8,
cell{5}{2} = cyan8
}{
amsthm & bicaption & ctex & caption & chemformula \\
enumitem & etoolbox & fancyhdr & geometry & hyperref \\
imakeidx & listings & marginnote & mathtools & multicol \\
pifont & pdfpages & siunitx & spbmark & setspace \\
thmtools & tcolorbox & titletoc & tabularray & ulem
}
\section{文档类选项}
\label{sec:document class options}
文档类选项应当在使用 \cls*{easybook} 文档类或 \pkg*{easybase} 宏包(部分支持)时载入,可见\ref{subsec:basic usage} 的例子。目前 \pkg*{easybase} 宏包可用的选项有 \option{class}、\option{draft}、\option{paper} 和 \option{floatpage}。除了下面列举的选项以外,还支持标准和 C\TeX 文档类的选项。
\begin{options}
\opt{draft}\Default!
开启草稿模式会加快编译速度,表现有显示页面边框、行溢出的地方显示黑色方块、图片变成占位方框、显示当前日期和关闭超链接渲染。不使用绘图宏包及依赖于 \pkg*{tcolorbox} 宏包的盒子环境也会增快编译速度,详情见\ref{subsec:box}。
\opt{newline}\Default!
部分和章标题的样式为另起一行,符合一般英文书籍的习惯。
\keychoice{scheme}{chinese,plain}\Default{chinese}
文档主题方案选项 \option{scheme} 扩展了 C\TeX 文档类中同名选项原有的作用范围,选项值 \code{plain} 可使各类标题变为英文形式。包括章节标题、图表标题和定理名等。
\opt{enmode}\Default!
同时开启 \option{newline} 和 \keyis-{scheme}{plain} 选项以符合英文原生风格。
\keychoice{paper}{a4paper,b5paper,c5paper,letterpaper,other paper}\Default{a4paper}
文档页面尺寸选项将参数交给 \pkg*{geometry} 宏包处理,可使用它支持的所有纸张规格。建议选项值 \code{b5paper} 和 \keyis*-{zihao}{5},选项值 \code{a4paper} 和 \keyis*-{zihao}{-4} 配合。
\keyval-{config}{配置文件列表}\Default
载入用户配置的文件名列表,文件列表以花括号包裹并以英文逗号分隔。文件名应包含如 \code{tex}、\code{def} 或 \code{cfg} 等扩展名。若配置文件不在当前文件夹则文件名需要包含路径。
\keybool{floatpage}\Default{false}
开启这个选项后浮动环境 \env*{table} 和 \env*{figure} 的比例参数会使用默认值,关闭它则尽可能避免出现浮动页,使图表环境与正文段落更加紧凑,减少多余的空白版面。
\end{options}
\subsection{中文字体}
\begin{options}
\keychoice{cjkfont}{adobe,fandol,founder,mac,macnew,macold,ubuntu,windows,none}\Default
中文字体采用 C\TeX 宏集包含的字库并与其一致,具体配置方案可以查看 C\TeX 使用手册。它与 \option*{fontset} 选项是等效的,如果没有指定 \option{cjkfont} 的值,将会自动检测操作系统并选择相应的字体。
如果需要使用其它中文字体,可以在启用选项 \keyis-{cjkfont}{none} 后,再使用 \pkg*{xeCJK} 宏包的相关命令设置字体以及声明字体族:
\begin{ctexexam}
\setCJKmainfont{SimSun}[BoldFont = SimHei,ItalicFont = KaiTi]
\setCJKsansfont{SimHei}
\setCJKmonofont{FangSong}
\newCJKfontfamily[song]\songti{SimSun}
\end{ctexexam}
\end{options}
\subsection{英文字体}
\begin{options}
\keychoice{font}{noto,times,times*,ebgaramond,libertine,palatino,auto}\Default{auto}
预置的英文字体相关配置方案如下表所示,这些字体已经包含在了 \TeX Live 发行版中,所以通常不需要再专门安装。如果您想使用其他英文字体,可以使用 \pkg*{fontspec} 宏包的相关命令进行设置。
\insertblr
{
colspec = @{}*{4}{c}@{},
hline{2} = {0.5pt,Blue},
row{1} = {font = \sffamily},
column{1} = {cmd = \code}
}{
& 正文字体 & 无衬线字体 & 等宽字体 \\
noto & Noto Serif & Noto Sans & Noto Sans Mono \\
times & XITS & TG Heros & TG Cursor \\
times* & Times New Roman & Arial & Courier New \\
ebgaramond & EB Garamond & Libertinus Sans & LM Mono \\
palatino & TG Pagella & Libertinus Sans & LM Mono \\
libertine & Libertinus Serif & Libertinus Sans & LM Mono
}
\end{options}
\subsection{数学字体}
\begin{options}
\keychoice{mathfont}{times,noto,notosans,nc,stix2,charter,ebgaramond,libertine,none}\Default{times}
选择合适的数学字体,将会加载 \pkg*{newtxmath} 和 \pkg*{bm} 宏包。使用选项 \code{none} 时可以使用 \pkg*{unicode-math} 等其它数学字体宏包定义字体。
\end{options}
\subsection{article 模式}
\begin{options}
\keychoice{class}{book,article}\Default{book}
使用 \cls*{easybook} 文档类可以有两种模式,默认为 \cls*{book} 模式。选用 \code{article} 会变为 \code{oneside} 单面排版,同时使文档编号、结构等与标准 \cls*{article} 文档类的特性相似,可用于短篇幅的文章,不需要再使用 \cs*{chapter} 命令。此时\ref{sec:document command} 中目录命令的 \option{chapter} 选项会失效,将以 \code{section} 标题级别输出目录。如果使用 \cls*{ctexart} 配合 \pkg*{easybase} 宏包,则选项值 \code{book} 会失效。
\opt{book}\Default!
开启 \cls*{book} 书籍模式,与 \keyis*-{class}{book} 等效。
\opt{article}\Default!
开启 \cls*{article} 文章模式,与 \keyis*-{class}{article} 等效。
\end{options}
\section{文档命令}
\label{sec:document command}
\subsection{文区命令}
\begin{commands}
\command{frontmatter}[\sarg\oarg{编号格式}]\Default{Roman}
前言区命令,使部分和章标题不编号,带有星号的变体命令不使用 \cs{cleardoublepage} 命令。页码 \meta{编号格式} 可设置为例如 \code{roman} 或 \code{Alph} 等形式。
\command{mainmatter}[\sarg]
主文区命令,章标题正常编号且页码为从 1 开始计数的阿拉伯数字,带有星号的变体命令不使用 \cs{cleardoublepage} 清双页命令。
\command{backmatter} 后记区命令,页码格式与编号保持不变,章标题不编号。
\command{cleardoublepage}[\oarg{页面风格}]\Default{empty}
清双页命令可以确保下一页文本总在奇数页开始,在奇数页使用它会产生空白偶数页。文区命令 \cs{frontmatter} 和 \cs{mainmatter} 会用到清双页命令,在启用文类选项 \option*{openright} 时标题命令 \cs*{part} 和 \cs*{chapter} 也会用到清双页命令。
\command{blankpagestyle}[\marg{页面风格}]
多出空白页的 \meta{页面风格} 用空白页面风格命令 \cs{blankpagestyle} 全局指定,或使用清双页命令的可选参数局部指定。空白页默认的风格为 \code{empty},即空的页眉页脚。
\end{commands}
\subsection{目录命令}
\begin{commands}
\command{tableofcontents}[\parg\oarg{键值列表}\darg{附加代码}]
文档主目录命令。带有 \parg{} 号参数的命令输出双语目录,需要与双语目录标题命令 \cs{bichapter} 等或设置图片、表格和代码等英文目录的标题配合使用,附加代码是中文与英文目录之间的代码,可以插入目录样式和换页等命令。
\command{listoffigures}[\sarg\parg\oarg{键值列表}]
输出图片目录命令。带有星号的目录命令不将目录标题添加进文档主目录,带有 \parg{} 号的目录命令可以使当前标题编号。
\command{listoftables}[\sarg\parg\oarg{键值列表}]
输出表格目录命令。带有星号的目录命令不将目录标题添加进文档主目录,带有 \parg{} 号的目录命令可以使当前标题编号。
\command{listoflstlistings}[\sarg\parg\oarg{键值列表}]
输出代码目录命令。带有星号的目录命令不将目录标题添加进文档主目录,带有 \parg{} 号的目录命令可以使当前标题编号。
\end{commands}
上面目录命令的可选参数改进了原本单一的功能,其中 \meta{键值列表} 的选项如下:
\begin{options}
\opt{chapter}\Default!
使当前目录标题按照 \code{chapter} 章级别输出。
\opt{section}\Default!
使当前目录标题按照 \code{section} 节级别输出。
\opt{none}\Default!
使当前目录没有 \code{chapter} 或 \code{section} 级别的标题,仅输出目录原始内容。
\keyval-{multoc}{整数}\Default{2}
与 \module*{style} 模块的 \option{multoc} 选项具有相同的效果,但是具有优先性且可单独设置不同类型目录的排版栏数。\meta{整数} 为目录栏数,不指定栏数值则默认为双栏。
\kvsplit{title}{中文目录标题,英文目录标题}\newline
用于更改目录的标题,标题之间用一个英文逗号分开,也可以只有一部分,表示中文目录的标题。当设置了英文目录标题时,英文目录标题将会自动加入文档主目录 \cs*{tableofcontents}\parg{} 命令。
\keyval-{format}{目录标题格式}
在 \cls*{book} 模式且 \option{chapter} 选项开启或者 \cls*{article} 模式的情况下,\option{format} 用于设置目录标题的格式。
\keyval-{aftertitle}{目录标题格式}\Default
目录标题文本之后插入的代码。
\keyval-{pagestyle}{标题页的页面格式}\Default{empty}
目录标题所在页的页面格式,仅当目录以 \code{chapter} 级别输出时有效。除了上述选项还支持 C\TeX 键值列表路径 \module*{chapter} 或 \module*{section} 所有的章节标题样式选项。
\end{options}
\subsection{双语标题}
双语目录标题命令目前设置了常用的三个级别,它们将中文标题正常输出,并使中英文标题加入双语目录。类似于标准文档类,这三个标题命令分别具有独立的计数器\footnote{默认情况下与普通标题命令共享使用计数器。},并对应 \cs*{the}\meta{计数器} 的值,可以用于 \option{binumber} 选项更改英文目录中的编号。这个功能是为国内一些高校的学位论文模板的要求设计,在一般情况和英文模式下\textbf{不需要使用}。
\begin{commands}
\command{bichapter}[\sarg\oarg{目录中文标题}\marg{中文标题}\marg{目录英文标题}]
\code{chapter} 章级别的双语目录标题命令,具有独立的 \code{bichapter} 计数器。
\command{bisection}[\sarg\oarg{目录中文标题}\marg{中文标题}\marg{目录英文标题}]
\code{section} 节级别的双语目录标题命令,具有独立的 \code{bisection} 计数器。
\command{bisubsection}[\sarg\oarg{目录中文标题}\marg{中文标题}\marg{目录英文标题}]
\code{subsection} 小节级别的双语目录标题命令,具有独立的 \code{bisubsection} 计数器。
\end{commands}
它们的星号变体命令使文中标题不编号,但是仍然加入双语目录,若英文标题参数空置那么仅加入中文目录而不加入英文目录,这一特点与 \cs*{chapter}\sarg{} 等命令的行为不太一样,在一些情况下会用到。可选参数是目录中的中文标题,默认与中文标题一致,正文标题过长时可用它设置在目录中显示的标题。默认情况下双语目录的格式是一致的,共享使用 \module*{tocset} 模块的设置,英文目录的章级别标题名及编号的修改方式如下:
\begin{options}
\kvsplit{biname}{英文目录前名字,英文目录后名字}\Module{chapter}\Default{Chapter\cs*{space}}
更改英文目录 \code{chapter} 级别的标题编号前后名字,类似于 C\TeX 的 \option*{name} 选项。
\keyval-{binmuber}{英文目录数字输出命令}\Default{\cs*{arabic}\Carg{chapter}}
更改英文目录 \code{chapter} 级别的标题编号输出格式,类似于 C\TeX 的 \option*{number} 选项。
\end{options}
\begin{commands}
\command{appendix}[\splitoarg{前名字,后名字}\darg{数字输出命令}]
附录起始命令,其后的章节标题变为附录形式。英文目录中附录标题的 \meta{前名字} 为英文附录目录前名字,\meta{后名字} 为英文附录目录后名字。前后名字之间用一个半角逗号分开,也可以只有一部分,表示英文附录目录前名字。\meta{数字输出命令} 为附录标题计数器在英文目录中的编号命令。
\command{BeforeAddBitoc}[\sarg\marg{英文标题加入目录前的代码}]
作用于局部范围的英文目录钩子,可以插入标题或目录设置的命令改变英文目录中标题的显示格式,也可以覆盖上述的目录前后名字和编号等设置,带有星号的命令会重置之前的代码,放置在导言区或 \cs{bichapter} 等命令前生效。
\end{commands}
\subsection{上标和下标}
上标和下标的功能来自 \pkg*{spbmark} 宏包,下面三个命令可以用于输出上标和下标。可以使用键值列表的形式对上下标格式进行局部或全局设置,这些命令两个可选参数的键值列表是等效的。全局设置的详情见\ref{subsubsec:super-sub-script}。
\begin{commands}
\command{super}[\oarg{键值列表1}\splitoarg{高度,深度}\marg{内容}\oarg{键值列表2}]
输出上标的命令,与简短命令 \cs{sp} 等效。
\command{sub}[\oarg{键值列表1}\splitoarg{高度,深度}\marg{内容}\oarg{键值列表2}]
输出下标的命令,与简短命令 \cs{sp} 等效。用法和参数与上标命令 \cs{super} 类似。
\command{supersub}[\oarg{键值列表1}\marg{上标内容}\marg{下标内容}\oarg{键值列表2}]
同时输出上标和下标的命令,与简短命令 \cs{spb} 等效。
\end{commands}
关于这三个命令键值列表中共同的选项如下所示。如果 \option{vshift}、\option{hshift} 和 \option{cmd} 选项用于 \module*{style} 模块的全局设置,它们将根据前面最近一个命令的类型设定相应值。
\begin{options}
\keyval-{vshift}{刚性长度}\Default{0pt}
上标或下标的垂直偏移。如果是上下标命令使用则代表上标和上标间的垂直距离 \option{vsep}。
\keyval-{hshift}{刚性长度}\Default{0pt}
上标或下标的水平偏移。如果是上下标命令使用则代表上标和上标的共同偏移。
\keyval-{cmd}{格式命令}\Default
上标或下标的格式命令选项。最后一个命令可以带有一个参数,这个参数用于接受上标或下标。
\keychoice{mode}{text,math,match}\Default{match}
上标或下标的输出格式。可以为文本 \code{text} 或数学 \code{math} 模式。当使用选项 \code{match} 时可以根据当前段落所处的模式自动匹配。
\end{options}
\section{接口选项}
\label{sec:interface options}
\begin{commands}
\command*{ctexset}[\marg{键值列表}]
\cls*{easybook} 扩展了 C\TeX 宏集 \hologo{LaTeX3} 风格键值的通用控制命令 \cs*{ctexset},接口选项同样可用它设置, 原有的 \meta{键值列表} 仍然可用。本文档类目前有 9 个模块用于实现常规的排版功能,如下表所示。模块名也是统一接口 \cs*{ctexset} 的路径,不同模块单独接口的命令名\textbf{加上前缀} \code{eb}:
\insertblr
{
colspec = @{}*{5}{c}@{},
hline{3} = {0.5pt,Blue},
row{1,3} = {font = \sffamily,belowsep = 0pt},
row{2,4} = {cmd = \module*}
}{
\hyperref[subsec:style]{风格} & \hyperref[subsec:other font]{其它字体} & \hyperref[subsec:spacing]{行距} & \hyperref[subsec:hyperlinks]{超链接} & \hyperref[subsec:reference]{参考文献} \\
style & subfont & spread & refset & bibset \\
\hyperref[subsec:theorem of style]{定理样式} & \hyperref[subsec:page margins]{页面尺寸} & \hyperref[subsec:header and footer]{页眉页脚} & \hyperref[subsec:catalog style]{目录样式} & \\
thmset & geoset & hdrset & tocset &
}
例如使用下面\ref{subsec:style} 介绍的风格 \module*{style} 模块,路径名与所属下级选项之间可以 \code{/} 或 \code{=} 号分开,斜线 \code{/} 后不能有空格或者换行:
\begin{ctexexam}
\ctexset
{
style/color = seaside,
style =
{
fntnumwith = page,
uppercase = false
}
}
\ebstyle{connect-figure = {-}}
\end{ctexexam}
文档类有三种选项:布尔型 \boolkey*{key},选项的值为 \code{true} 或 \code{false},如果不指定默认为真。键值型 \key*-{key}{value} 需要为选项指定值,后面 \code{=} 号不能省略。选择型 \choicekey*{key}{one,\default{two},three} 根据提供的可选值进行设定。
\end{commands}
\subsection{风格}
\label{subsec:style}
\begin{options}
\keychoice{color}{none,seaside,energy,cyberpunk}\Module{style}\Default{none}
预置了四种颜色主题,默认主题 \code{none} 为黑白页面,颜色主题不包括超链接。
\begin{commands}
\command{DeclareThemeColor}[\splitmarg{风格名称,ctex@frame,ctex@emph,ctex@verb}]
声明新的颜色主题命令。它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成颜色主题。类似地更改超链接颜色见\ref{subsec:hyperlinks}。
\end{commands}
\keyval-{color-every}{HTML颜色代码}\Default
统一设置主题的各部分颜色,参数是 6 个十六进制数字组成的 \code{HTML} 颜色代码,任意颜色的代码可以在常见的图片处理工具拾色器中查看。
\keyval-{multoc}{整数}\Default{2}
使目录多栏排版,与\ref{sec:document command} 中目录命令的同名选项有相同效果。
\keybool{withpart}\Default{false}
使章标题跟随部分计数器编号,当开启新的一部分时章编号从 1 开始。
\keychoice{fntnumwith}{part,chapter,page}\Default{chapter}
使脚注跟随编号的计数器名。默认跟随章计数器,当开启新的一章时脚注编号从 1 开始。
\keybool{uppercase}\Default{true}
使用 \cs*{rightmark} 及 \cs*{leftmark} 等标题标记命令获取标题内容时英文是否大写。
\kvsplit{brackets}{左括号,右括号}\Default{\Carg{(\black{,})}}
设置行间公式编号标签的括号及格式,以英文逗号分隔,分别代表左右括号。\meta{左括号} 可以是带有一个参数的命令,用于接受编号和 \meta{右括号}。将标签括号设置为方括号,并使用无衬线字体:
\begin{ctexexam}
\newcommand{\bracketsf}[1]{\textsf{[#1}}
\ebstyle{brackets = {\bracketsf,]}}
\end{ctexexam}
\kvsplit*{figurepath}{\meta{路径名1}\code{\}\{}\meta{路径名2}}\Default
设置插入图片的文件夹路径名,可以有多个路径名,每个路径包含在括号分隔,只有一个路径时需要包含在两层括号内。
\end{options}
\subsubsection{连接符}
\begin{options}
\keyval-{connect-figure}{图片连接符}\Default{\Carg{.}}
设置图片题注编号的连接符。
\keyval-{connect-table}{表格连接符}\Default{\Carg{.}}
设置表格题注编号的连接符。
\keyval-{connect-listing}{代码连接符}\Default{\Carg{.}}
设置代码题注编号的连接符。
\keyval-{connect-equation}{公式连接符}\Default{\Carg{.}}
设置公式题注编号的连接符。
\keyval-{connect-every}{连接符}\Default{\Carg{.}}
统一设置上述所有编号的连接符。
\end{options}
\subsubsection{上下标全局设置}
\label{subsubsec:super-sub-script}
\begin{options}
\keyval-{spvshift}{刚性长度}\Default{0pt}
上标命令 \cs{super} 对应的上标垂直偏移量。
\keyval-{sphshift}{刚性长度}\Default{0pt}
上标命令 \cs{super} 对应的上标水平偏移量。
\keyval-{sbvshift}{刚性长度}\Default{0pt}
下标命令 \cs{sub} 对应的下标垂直偏移量。
\keyval-{sbhshift}{刚性长度}\Default{0pt}
下标命令 \cs{sub} 对应的下标水平偏移量。
\opt{nohshift}\Default!
同时取消上标和下标的 \meta{水平偏移},与 \keyis-{sphshift}{0pt} 和 \keyis-{sbhshift}{0pt} 等效。
\opt{novshift}\Default!
同时取消上标和下标的 \meta{垂直偏移},与 \keyis-{spvshift}{0pt} 和 \keyis-{sbvshift}{0pt} 等效。
\keyval-{spcmd}{格式命令}\Default
上标命令 \cs{super} 对应的上标的格式命令。
\keyval-{sbcmd}{格式命令}\Default
下标命令 \cs{sub} 对应的下标的格式命令。
\keyval-{spbhshift}{刚性长度}\Default{0pt}
上下标命令 \cs{supersub} 对应的上下标共同水平偏移量。
\kvsplit{spbcmd}{上标格式,下标格式}\Default
上下标命令 \cs{supersub} 对应的上下标格式命令。以英文逗号分隔为前后两个部分分别设置上下标格式,也可以只有前部分,表示上标的格式。
\keyval-{vsep}{刚性长度}\Default{0.3ex}
上下标命令 \cs{supersub} 对应的上下标垂直距离。
\keychoice{halign}{l,c,r}\Default{l}
上下标命令 \cs{supersub} 对应的上下标水平对齐方式,有左 \code{l}、居中 \code{c} 和右 \code{r} 三种对齐方式。
\end{options}
\subsection{超链接}
\label{subsec:hyperlinks}
模块 \module*{refset} 将超链接选项交给 \pkg*{hyperref} 宏包处理,除了一些关于 \code{pdf} 书签或已预设的选项可能失效,其它由接口命令 \cs*{hypersetup} 支持的多数选项可用。
\begin{options}
\keychoice{linktype}{edge,colors,none}\Module{refset}\Default{edge}
超链接类型,\code{edge} 使超链接形式为边框,\code{colors} 使超链接字体为彩色,\code{none} 关闭超链接边框与颜色,此时 \option{linkcolor} 选项无效。
\keychoice{linkcolor}{fresh,cutepink,navyblue,crimson}\Default{navyblue}
超链接颜色样式,预置了四种超链接颜色风格。为使相关颜色能够正确显示,\option{linkcolor} 选项应当在 \option{linktype} 前使用。
\begin{commands}
\command{DeclareLinkColor}[\splitmarg{风格名称,ctex@link,ctex@url,ctex@cite}]
声明新的超链接颜色样式命令。它的参数以英文逗号分隔,第一部分为颜色风格名称,后面三部分为 \code{HTML} 颜色代码,构成超链接颜色。
\end{commands}
\keyval-{linkcolor-every}{HTML颜色代码}\Default
统一设置超链接的各部分颜色,参数是 6 个十六进制数字组成的 \code{HTML} 颜色代码,任意颜色的代码可以在常见的图片处理工具拾色器中查看。
\keychoice{linktoc}{none,section,page,all}\Default{all}
将目录中的超链接取消、置于标题上、置于页码上或置于标题和页码上。
\end{options}
\subsection{行距}
\label{subsec:spacing}
行距因子用于设置各种行距倍数,\meta{数值} 是不带有长度单位的浮点数。各类行距既可以在导言区全局设置,也可以在正文中设置对后面生效。
\begin{options}
\keyval-{line}{数值}\Module{spread}\Default{1.354}
正文行距因子,注意 C\TeX 宏集原有的行距选项 \option*{linespread} 失效。
\keyval-{table}{数值}\Default{1.354}
表格内容行距因子,对传统表格 \env*{tabular} 和 \env*{tabularx} 等环境以及 \pkg*{tabularray} 宏包的 \env{tblr} 环境生效,同时 \env{tblr} 也自带有 \option*{stretch} 选项设置行距系数。
\keyval-{math}{数值}\Default{1.2}
数学环境的行距因子,包含了 \pkg*{amsmath} 和 \pkg*{mathtools} 宏包提供的公式环境。
\keyval-{caption-figure}{数值}\Default{1.2}
图片题注的行距因子。
\keyval-{caption-table}{数值}\Default{1.2}
表格题注的行距因子。
\keyval-{caption-listing}{数值}\Default{1.2}
代码题注的行距因子。
\keyval-{caption-every}{数值}\Default{1.2}
同时设置图片、表格和代码题注的行距因子。
\keyval-{footnote}{数值}\Default{1.2}
脚注内容整体的行距因子,可以使用 \option{fnpara-form} 的代码覆盖每个脚注单独的行距,从而与不同脚注的段落间距不同\footnote{若在正文区中更改脚注行距,脚注横线下方的间距不会随当前行距改变。}。
\begin{ctexexam}
\ebspread{footnote = 1.3}
\ebhdrset{fnpara-form = \linespread{1.2}\selectfont}
\end{ctexexam}
\keyval-{every}{数值}\Default
统一设置上述所有的行距因子。
\end{options}
\subsection{其它字体}
\label{subsec:other font}
\begin{options}
\keyval-{caption-table}{字体命令}\Module{subfont}\Default{\cs*{sffamily}\cs*{small}}
表格题注的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。
\keyval-{caption-figure}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
图片题注的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。
\keyval-{caption-listing}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
代码题注的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。
\keyval-{caption-every}{字体命令}\Default{\cs*{sffamily}\cs*{small}}
同时设置图片、表格和代码题注的字体命令。
\keyval-{footnote}{字体命令}\Default{\cs*{rmfamily}\cs*{footnotesize}}
设置脚注标记与内容的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
\keyval-{marginpar}{字体命令}\Default{\cs*{rmfamily}\cs*{footnotesize}}
边注的字体设置,包括字体族、字体系列、字体尺寸和字体形状命令。
\end{options}
\begin{commands}
\command{addtosubfont}[\marg{字体类型}\marg{字体命令}]
用于在上述各种字体原有的格式上附加代码。其中 \meta{字体命令} 也可以包括行距命令且相对于 \module*{spread} 模块具有优先性,不同题注的 \meta{字体类型} 则为相应选项的后缀名。
\begin{ctexexam}
\addtosubfont{every}{\linespread{1.5}\selectfont}
\addtosubfont{footnote}{\sffamily}
\end{ctexexam}
\end{commands}
\subsection{参考文献}
\label{subsec:reference}
\begin{options}
\keychoice{backend}{bibtex,biblatex}\Module{bibset}\Default{bibtex}
参考文献处理后端。默认用传统的 \hologo{BibTeX} 处理参考文献\footnote{使用 \hologo{BibTeX} 引擎时加载 \pkg*{natbib} 宏包,使用 \hologo{biber} 时将加载 \pkg*{biblatex} 宏包。}。
\keychoice{bibstyle}{numerical,authoryear,other sty}\Default{numerical}
参考文献格式为中国的参考文献推荐标准 GB/T 7714-2015,有顺序编码制和著者-出版年制两种风格。理工科类一般使用顺序编码制,文科类一般使用著者-出版年制。若使用其它格式,使用 \hologo{BibTeX} 处理时需确保正确的 \code{bst} 文件,使用 \hologo{biber} 处理可使用 \pkg*{biblatex} 宏包支持的参考文献风格名称。
\keyval-{citestyle}{标注风格}\Default
标注参考文献的风格。选项 \keyis-{backend}{bibtex} 下可使用 \option{super}(数字上标标注,默认)或 \option{numbers}(数字标注)等 \pkg*{natbib} 宏包带有的标注风格,选项 \keyis-{backend}{biblatex} 下可使用 \pkg*{biblatex} 宏包支持的标注风格名称。
\keyval-{datafile}{参考文献数据库列表}\Default
参考文献数据库的文件名列表,文件列表以花括号包裹并以英文逗号分隔。使用 \hologo{biber} 处理时要带有 \code{bib} 后缀,若参考文献文件不在当前文件夹则文件名需要包含路径。不设置参考文献数据库名时 \module*{bibset} 模块中的选项会失效,即不自动载入 \pkg*{natbib} 或 \pkg*{biblatex} 宏包,此时需要手动载入相关宏包配置参考文献。
\end{options}
\subsubsection{配置参考文献}
\begin{commands}
\command{printbibliography}[\oarg{键值列表}]
两种方式\textbf{均使用}此命令打印参考文献,不同处理后端此命令的 \meta{键值列表} 不同。使用 \hologo{BibTeX} 处理时选项与\ref{sec:document command} 目录的选项相同,使用 \hologo{biber} 处理时常用的选项如下:
\begin{options}
\keychoice*{heading}{bibliography,subbibliography,bibintoc,subbibintoc}\Default{bibintoc}
参考文献通常有一个章标题或者节标题,该选项选择由 \cs*{defbibheading} 定义的标题名。
\keyval*-{title}{参考文献标题名}\Default
如果标题定义支持的话,该选项覆盖由 \option*{heading} 选项提供的缺省标题名。
\keyval*-{prenote}{参考文献前注}\Default
该选项选择由 \cs*{defbibnote} 所定义的前注,缺省状态下不打印任何前注。
\keyval*-{section}{整数}\Default{0}
只打印在指定文节中引用的条目。该参考文献节从 1 开始编号,所有在 \env*{refsection} 环境外给出的引用标记为第零节。
\keyval*-{type}{条目类型}\Default
指定条目的打印类型。
\keyval*-{filter}{过滤器名}\Default
使用由 \cs*{defbibfilter} 定义的 \option*{filter} 来过滤条目。
\end{options}
可能在一些情况下您希望更加灵活地设置参考文献或有更多需求,下面举一个在导言区手动配置 \pkg*{biblatex} 宏包的例子:
\begin{ctexexam}
\usepackage[style = numeric]{biblatex}
\addbibresource{myrefs.bib}
\defbibheading{bibliography}[参考文献] % 定义参考文献标题
{\chapter*{#1}\markboth{#1}{#1}}
\end{ctexexam}
\end{commands}
\subsection{定理样式}
\label{subsec:theorem of style}
文档类已预置 12 个定理环境,环境名及对应的定理名见\ref{subsec:theorem},它们均使用预置的定理样式 \code{eb-theorem}。下面 \module*{thmset} 模块选项的用法名称与 \pkg*{thmtools} 宏包基本一致,且仅对预置定理样式生效。如果下面的选项不满足需求,可使用支持完整选项的相关命令创建定理环境。
\begin{options}
\keybool{thmframe}\Module{thmset}\Default{false}
给定理环境使用彩色盒子。这个特殊选项在本模块中使用 \pkg*{tcolorbox} 宏包来支持,\meta{盒子风格} 默认为 \code{tc-theorem}。注意它应当在定理声明命令前使用。\pkg*{thmtools} 具有类似的选项 \option*{thmbox}。
\keyval-{headfont}{字体命令}\Default{\cs*{color}\Carg{ctex@emph}\cs*{sffamily}}
定理标题部分的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
\keyval-{notefont}{字体命令}\Default
定理题注部分的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
\keyval-{bodyfont}{字体命令}\Default
定理内容部分的字体,包括字体族、字体系列、字体尺寸和字体形状命令。
\keychoice{within}{chapter,section,empty,counter}
定理编号跟随的计数器。当计数器值递增时定理编号会从零开始,通常这是一个章节计数器。
\keyval-{headpunct}{代码}\Default
紧随定理标题末尾的标记代码,位于定理第一段内容的间距 \option{postheadspace} 之前,可以是字符或插入换行符 \cs*{newline} 等命令。
\keyval-{headindent}{刚性长度}\Default{0em}
定理标题的缩进,默认无缩进,可用 \cs*{parindent} 命令设置为段落缩进。
\keyval-{postheadspace}{刚性长度}\Default{1em}
定理标题后与定理第一段内容的间距。
\keyval-{spaceabove}{弹性长度}\Default{0ex plus .1ex}
定理环境前的间距,使用 \pkg*{tcolorbox} 的盒子环境包装后被覆盖。
\keyval-{spacebelow}{弹性长度}\Default{0ex plus .1ex}
定理环境后的间距,使用 \pkg*{tcolorbox} 的盒子环境包装后被覆盖。
\kvsplit*{notebraces}{\meta{左括号}\code{\}\{}\meta{右括号}}\Default{\Carg{(}\Carg{)}}
设置定理题注两边的括号,两个必选参数分别代表左括号和右括号。
\keyval-{headformat}{标题排列}\Default{\cs*{NAME}\cs*{NUMBER}\cs*{NOTE}}
定理标题各组成元素的位置排列和格式。定理标题由定理名、编号和题注组成,\meta{标题排列} 中命令 \cs*{NAME}、\cs*{NUMBER} 和 \cs*{NOTE} 分别代表定理名、编号和题注。
\end{options}
\subsubsection{新建定理环境}
\begin{commands}
\command{declaretheorem}[\oarg{键值列表1}\marg{定理环境}\oarg{键值列表2}]
定理环境声明命令,命令 \cs{newtheorem} 与它等效。可选参数的 \meta{键值列表1} 与 \meta{键值列表2} 等效,用法与原来的同名命令一致。键值列表中常用的选项如下:
\begin{options}
\keyval*-{name}{定理名}
定理名的默认值是首字母大写的环境名称(英文标题)。
\keychoice*{numbered}{no,yes,unless unique}
定理可以被编号、不被编号或者只有在文档中多次出现时才被编号。
\keyval*-{numberlike}{计数器}
定理将使用此 \meta{计数器} 进行编号,通常这是另一个定理环境的名称。
\keyval*-{style}{定理样式}
选项的值为使用 \cs{declaretheoremstyle} 命令新定义的定理样式。
\end{options}
使用 \cs{declaretheorem} 命令以\ref{exam:new theorem sty} 中的定理样式 \code{mythm} 新建一个定理环境猜想,这个命令新建的环境如果需要盒子边框可以手动添加:
\begin{ctexexam}[labelref = exam:new theorem env]
\declaretheorem[style = mythm,name = 猜想]{caixiang}
\tcolorboxenvironment{caixiang}{tc-theorem}
\end{ctexexam}
\command{deftheorem}[\marg{环境名}\oarg{英文标题}\marg{中文标题}\darg{盒子风格}\oarg{键值列表}]
定理环境定义命令 \cs{deftheorem} 更加便捷,\meta{键值列表} 中支持的选项与命令 \cs{declaretheorem} 完全相同。但它与后者命令有以下几个区别:
\begin{itemize}
\item 可以重复定义已存在的定理环境而不会报错。
\item 中英文模式下定理标题自动切换。针对中文定理标题的特点将 \meta{中文标题} 设计为必选参数,\meta{英文标题} 则默认为首字母大写的 \meta{环境名}。
\item 自动定义交叉引用的格式,引用标签前缀为相应定理名。
\item 定理盒子选项 \option{thmframe} 仍然生效,\meta{盒子风格} 可以使用 \cs{deftcbstyle} 命令创建。
\item 新建定理环境默认使用的 \meta{定理样式} 为 \code{eb-theorem},而不是 \pkg*{thmtools} 的默认样式。
\end{itemize}
下面新建一个与\ref{exam:new theorem env} 相同的定理环境猜想,并使用 \cs{addtotcbstyle} 命令调整 \option{thmframe} 开启时默认的盒子风格。它的第一个参数为 \code{tc-theorem},关于命令的介绍在\ref{subsec:box}。
\begin{ctexexam}
\deftheorem{caixiang}{猜想}[style = mythm]
\addtotcbstyle{tc-theorem}{colback = GreenYellow}
\end{ctexexam}
\command{declaretheoremstyle}[\oarg{键值列表1}\marg{定理样式}\oarg{键值列表2}]
定理样式声明命令,键值列表支持 \pkg*{thmtools} 宏包中原命令以及 \cs{declaretheorem} 的所有选项。可选参数的 \meta{键值列表1} 与 \meta{键值列表2} 等效,用法与原来的同名命令一致。下面定义一个名为 \code{mythm} 的定理样式用于 \cs{declaretheorem} 的 \option*{style} 选项:
\begin{ctexexam}[labelref = exam:new theorem sty]
\declaretheoremstyle[bodyfont = \rmfamily,spacepost = 0.5em]{mythm}
\end{ctexexam}
\end{commands}
\subsection{页面尺寸}
\label{subsec:page margins}
模块 \module*{geoset} 会将除了前两个附加的选项交给页面尺寸宏包 \pkg*{geometry} 处理,并且支持它的键值列表,预置的页面尺寸与 \cls*{Word} 的默认值接近。下面列举的仅是一小部分选项,其它选项可查阅宏包帮助文档。当在此设置页面大小时,会覆盖 \option{paper} 选项的设置。
\begin{options}\noitemsep
\keyval-{headruleskip}{页眉线间距}\Module{geoset}\Default*{1.5pt}
\keyval-{footruleskip}{页脚线间距}\Default*{0.3\cs*{normalbaselineskip}}
\keyval*-{left}{页面左边距}\Default*{3.17cm}
\keyval*-{top}{页面上边距}\Default*{2.54cm}
\kvsplit{hmargin}{左边距,右边距}
\keyval*-{textwidth}{页面文本区宽度}\default{}
\keybool*{includehead}\Default*{false}
\begin{ctexexam}
\ebgeoset
{
headruleskip = 3pt,
top = 2.5cm,
bottom = 2.5cm,
left = 3.2cm,
right = 3.2cm,
ignoreall
}
\end{ctexexam}
\end{options}
\subsection{页眉页脚}
\label{subsec:header and footer}
模块 \module*{hdrset} 设置的命令由 \pkg*{fancyhdr} 宏包提供支持。在 \cls*{book} 模式时使用章节标题标记选项 \option{chap-mark} 和 \option{sec-mark},在 \cls*{article} 模式时使用 \option{sec-mark} 和 \option{subsec-mark} 选项,这与标准文档类的行为一致。标题标记由标签和标题组成,选项中参数 \code{\#1} 代表当前章、节或小节的标题。也可以直接重新定义这些选项对应的标题标记命令,但此时标记大写选项 \option{uppercase} 失效。
\begin{options}
\keyval-{chap-mark}{标题标记}\Module{hdrset}
标题标记命令 \cs*{chaptermark} 的内容,包括了标签选项 \option{chap-label} 的内容。
\keyval-{sec-mark}{标题标记}
标题标记命令 \cs*{sectionmark} 的内容,包括了标签选项 \option{sec-label} 的内容。
\keyval-{subsec-mark}{标题标记}
标题标记命令 \cs*{subsectionmark} 的内容,包括了标签选项 \option{subsec-label} 的内容。
\kvsplit-{chap-label}{\oarg{数字输出命令}\marg{距离命令}}\Default{\cs*{hspace}\Carg{1em}}
标题标记命令 \cs*{chaptermark} 内容的标签(标题有编号时),比标题标记选项更常用,可选参数是对应于章节编号计数器的输出命令,必选参数是编号与标题之间的距离命令:
\begin{ctexexam}
\ebhdrset
{
chap-label = [\thechapter]{\hspace{1em}},
sec-mark = \CTEXifname{\CTEXthesection——}{}#1
}
\end{ctexexam}
\kvsplit-{sec-label}{\oarg{数字输出命令}\marg{距离命令}}\Default{\cs*{hspace}\Carg{0.5em}}
标题标记命令 \cs*{sectionmark} 内容的标签,用法与 \option{chap-label} 类似。
\kvsplit-{subsec-label}{\oarg{数字输出命令}\marg{距离命令}}\Default{\cs*{hspace}\Carg{0.5em}}
标题标记命令内容 \cs*{subsectionmark} 的标签,用法与 \option{chap-label} 类似。
\keyval-{headrule}{横线命令}
绘制页眉横线的选项,可以使用 \cs*{hrule} 或下述 \cs{markrule} 等画线命令来绘制横线。
\keyval-{footrule}{横线命令}\Default
绘制页脚横线的选项,可以使用 \cs*{hrule} 或下述 \cs{markrule} 等画线命令来绘制横线。
\keyval-{footnoterule}{横线命令}
绘制脚注横线的选项,可以使用 \cs*{hrule} 或下述 \cs{markrule} 等画线命令来绘制横线。
\keyval-{headrulewd}{刚性长度}\Default{0.5pt}
页眉横线默认的粗细。
\keyval-{footnoterulewd}{刚性长度}\Default{0.5pt}
脚注横线默认的粗细。
\end{options}
\begin{commands}\noitemsep
\command{fancyhead}[\oarg{位置}\marg{内容}]\default{}
\command{fancyfoot}[\oarg{位置}\marg{内容}]
使用 \cs{fancyhead} 和 \cs{fancyfoot} 等命令设置页眉页脚时为了显示正确的页面,在导言区时需要在页面边距的命令之后。默认设置的是一个名为 \code{fancy} 的页面风格。\pkg*{fancyhdr} 将页眉页脚分成了左中右和奇数页(odd)、偶数页(even)共 12 个部分,可选参数中 \code{E} 和 \code{O} 代表偶数和奇数,\code{L}、\code{C} 和 \code{R} 代表左、中和右部分。单面打印时,含有偶数位置的命令无效。
\end{commands}
\begin{commands}\noitemsep
\command*{markboth}[\marg{左页标题标记}\marg{右页标题标记}]\default{}
\command*{markright}[\marg{右页标题标记}]\default{}
\command{markdouble}[\marg{双页标题标记}]
这三个命令用于手动设置当前页标题标记,一般紧随标题命令,特殊情况下可以使用它们得到需要的页眉页脚内容。上述标记命令内容的选项便是基于这三个命令。其中 \cs{markdouble} 根据是否是双面打印设置相应标记。如果是单面打印,则 \meta{左页标题标记} 无效。
\end{commands}
\begin{commands}
\command{markrule}[\oarg{长度}\darg{颜色名}\marg{线宽}\spemcoarg{上间距,下间距}]
实线命令 \cs{markrule} 既可在 \meta{横线命令} 中用于绘制页眉页脚横线,也可以在正文中使用。\meta{长度} 默认为页面文本区的宽度,上下间距为横线与上下方部件的间距,带有长度单位,上下间距之间用符号 \code{|} 分开,若只有一部分则表示 \meta{上间距}。下面举一个设置页眉内容的例子:
\begin{ctexexam}
\ebhdrset{headrule = \markrule(DarkOrchid){0.5pt}[2pt|2pt]}
\fancyhead[ER]{\leftmark}
\fancyhead[OL]{\rightmark}
\fancyhead[EL,OR]{\textbf{\thepage}}
\end{ctexexam}
\end{commands}
\subsection{脚注格式}
模块 \module*{hdrset} 还可以灵活调整脚注编号和内容的格式。格式主要包括脚注标记的编号类型、字体、附加符号、对齐方式和缩进距离等,以及脚注内容的首行缩进、行距和字体等。基本思想是默认脚注和自定义编号脚注标记的格式分离,两种类型脚注各自正文和内容的标记又共享格式,默认脚注中正文和内容标记的编号类型分离。
\begin{options}
\keychoice{footnotetype}{hang,default,flush,bottom}\Module{hdrset}\Default{hang}
脚注的类型,悬挂缩进 \code{hang} 是默认值,\code{default} 是原始的类型,在一些浮动体排版的情况下,脚注可能位于页面中间,\code{bottom} 使脚注始终位于页面底端,\code{flush} 使脚注内容标记位于脚注首行边缘外侧并右对齐。其中 \code{bottom} 是复合选项,可以与前三种类型重复或复合使用:
\begin{ctexexam}
\ebhdrset{footnotetype = default,footnotetype = bottom}
\ebhdrset{footnotetype = {hang,bottom}}
\end{ctexexam}
\keyval-{fnindent}{刚性长度}\Default{0.75em}
每个脚注首段的首行缩进(选项 \option*{hang} 为整体缩进),等于长度 \cs{footindent} 的值。
\keyval-{fnparskip}{弹性长度}\Default{0ex}
不同脚注的段落间距,等于长度 \cs{footparskip} 的值。
\keyval-{fnparindent}{刚性长度}\Default{2em}
每个脚注第二段及之后段落的首行缩进,等于长度 \cs{footparindent} 的值。
\keychoice{fntext-pos}{normal,super}\Default{super}
设置脚注内容标记的位置,正常文本或是上标形式。
\keychoice{fnmark-num}{plain,pifont,pifont*,pisans,pisans*,short num}\Default{plain}
脚注正文标记编号的类型,默认为原生样式 \code{plain},还可以改为 \code{pifont} 的各个版本,从左往右依次为普通版、阴文衬线版、阳文无衬线版和阴文无衬线版,缺点是它们的编号仅包括 1-10。
短编号的形式与列表环境类似,不过增加了中文数字 \code{c} 和符号 \code{s} 格式参数。原生样式 \code{plain} 等同于单独使用数字 \code{1} 参数。这个选项可以用在正文中改变其后脚注编号类型。
\begin{ctexexam}
\ebhdrset{fnmark-num = 1} % 等于编号类型plain
\ebhdrset{fnmark-num = (a)}
\end{ctexexam}
\begin{commands}\noitemsep
\command{DefineFntSymbols}[\marg{符号表名}\marg{符号数量}\marg{符号列表}]\default{}
\command{setfntsymbol}[\marg{符号表名}]
这两个命令用于在脚注短编号标记为 \code{s} 自定义符号型时设置符号列表。\cs{DefineFntSymbols} 命令用于设置符号列表,\cs{setfntsymbol} 命令用于选择已定义的符号列表。默认的脚注符号列表是空的,定义新列表时应注意 \meta{符号列表} 的写法和命令顺序:
\begin{ctexexam}
\DefineFntSymbols{myfnsymb}{2}{{1}{*}{2}{@}}
\setfntsymbol{myfnsymb}
\ebhdrset{fnmark-num = s}
\end{ctexexam}
\end{commands}
\keychoice{fntext-num}{plain,pifont,pifont*,pisans,pisans*,short num}\Default{plain}
脚注内容标记编号的类型,用法与 \option{fnmark-num} 一样,所以脚注内容与正文标记编号类型\textbf{可以不同}。
\keychoice{fnmate-num}{plain,pifont,pifont*,pisans,pisans*,short num}\Default{plain}
同时设定脚注正文标记编号 \option{fnmark-num} 与脚注内容标记编号 \option{fntext-num} 的类型。目前脚注编号类型选项对于迷你页环境 \env*{minipage} 无效,其中的脚注保持默认英文字母的编号类型。
\keychoice{fnmark-vshift}{fixed length,match}\Default{0pt}
脚注正文标记的垂直偏移,可以设为刚性长度,或用 \code{match} 匹配 \option*{super-vshift} 全局的值。
\keychoice{fnmark-hshift}{fixed length,match}\Default{0pt}
脚注正文标记的水平偏移,可以设为刚性长度,或用 \code{match} 匹配 \option*{super-hshift} 全局的值。
\keychoice{fntext-vshift}{fixed length,match}\Default{0pt}
脚注内容标记的垂直偏移,可以设为刚性长度,或用 \code{match} 匹配 \option*{super-vshift} 全局的值。
\keychoice{fnmate-form}{format code,match}\Default
默认脚注标记的格式,\code{match} 可以匹配 \option*{super-format} 全局的值。一般配合选项 \keyis-{fnmate-num}{plain} 使用,例如配合 \pkg*{circledsteps} 宏包的带圈符号命令 \cs*{Circled} 给脚注标记添加圆圈:
\begin{ctexexam}
\usepackage{circledsteps}
\ebhdrset
{
fntext-pos = normal,
fnmate-form = \tiny\Circled
}
\end{ctexexam}
\keychoice{fncust-form}{format code,match}\Default
单独设定自定义脚注标记的格式,\code{match} 可以匹配 \option*{super-format} 全局的值。自定义脚注的命令与用法见\ref{subsubsec:custom footnotes}。
\keychoice{fnboth-form}{format code,match}\Default
同时设定默认脚注标记 \option{fnmate-form} 和自定义脚注标记 \option{fncust-form} 的格式。两种脚注标记匹配上标格式 \option*{super-format} 的值是独立的,使用 \code{match} 则可以同时匹配。标记格式选项含有字体命令会覆盖 \option{footnote} 的设置,最后一个格式命令可以带有一个参数接受脚注标记。
\keyval-{fnpara-form}{格式代码}\Default
脚注内容的格式,在此设置字体命令会覆盖 \option{footnote} 的设置,最后一个格式命令可以带有一个参数接受脚注内容。
\kvsplit{fntext-code}{前代码,后代码}\newline
可以用 \meta{前代码} 与 \meta{后代码} 额外增加脚注内容标记前后的代码,也可以只有前部分,\meta{前代码} 中最后一个格式命令可以带有一个参数接受脚注内容标记。由于脚注标记处于水平模式,一般用于在脚注内容标记与脚注首行间插入一点距离,或与脚注正文标记的格式稍有不同。
\begin{ctexexam}
\ebhdrset
{
footnotetype = flush,
fntext-code = {,\enskip}
}
\end{ctexexam}
\end{options}
\subsection{目录样式}
\label{subsec:catalog style}
模块 \module*{tocset} 将使用 \pkg*{titletoc} 宏包处理目录样式。模块或扩展包括了 \module*{part}、\module*{chapter}、\module*{section}、\module*{subsection}、\module*{figure}、\module*{table} 和 \module*{lstlisting} 二级路径,而使用 \module*{list} 路径可以统一设置图片、表格和代码目录的样式。模块中 \option{tocformat}、\option{tocformat+}、\option{tocindent}、\option{tocrule}、\option{tocafter} 和 \option{tocline} 这 6 个选项支持所有相应\textbf{标题级别}的路径,没有特别说明的其它选项则处于 \module*{tocset} 路径下。目前支持标准的论文目录样式,更复杂的样式可以查看 \pkg*{titletoc} 的相关用法。
\begin{options}
\keyval-{tocformat}{条目格式}\Module{tocset}
目录中各级别条目的格式,可以设置条目字体和加入垂直间距等,垂直间距最好使用防止垂直间距重合的 \cs*{addvspace} 命令。
\keyval-{tocformat+}{条目格式}
与 \option{tocformat} 用法一样,只是在已有的格式命令后附加代码。
\keyval-{tocindent}{刚性长度}
各级别目录中的标题左边缩进距离,通常标题级别越低缩进越大。
\keyval-{tocrule}{目录引导线样式}
引导线选项 \option{tocrule} 中一般应当使用 \cs{tocrule} 命令绘制引导线,将会在下面介绍。
\keyval-{tocafter}{距离命令}\Default{\cs*{hspace}\Carg{1em}}
在各级别目录中标签与标题间的代码,默认为插入 \code{1em} 横向距离。
\keyval-{tocline}{目录中的标题}
这个选项扩展了图片、表格或代码加入目录的题注。选项中参数 \code{\#1} 代表相应题注编号 \cs*{the}\meta{计数器} 的值,参数 \code{\#2} 代表相应题注内容。
\begin{ctexexam}[labelref = exam:list command usage]
\ctexset
{
figure/tocline = \listnumberline{figure}#2,
lstlisting/tocline = \protect\numberline{代码 #1\hspace{1em}}#2
}
\end{ctexexam}
\end{options}
\begin{commands}
\command{tocrule}[\sarg\harg\oarg{引导点间距}\darg{放大因子}\marg{引导点}\oarg{页码格式}]
目录命令 \cs{tocrule} 生成目录引导线,需要在引导线选项 \option{tocrule} 中使用。带有星号的命令会使当前级别的目录引导线右端与页码相连而不是对齐。带有 \harg{} 号的命令不添加引导线后的目录页码。\meta{引导点间距} 需带有长度单位,\meta{放大因子} 不带单位,为 \meta{引导点} 的放大倍数,\meta{引导点} 一般为英文句号或 \cs*{cdot} 中心点符号。\meta{页码格式} 的代码位于页码前面,可以设置页码字体和距离等,最后一个命令可以带有一个参数,这个参数为页码编号。
\command*{CTEXnumberline}[\marg{编号级别}]
目录命令 \cs*{CTEXnumberline} 用于在 C\TeX 文档类的 \option*{tocline} 选项中设置章节的目录标签,它已经被重新定义,使得目录标签后代码选项 \option{tocafter} 仍然有效。\meta{编号级别} 为 \code{chapter} 和 \code{section} 等,也可用参数 \code{\#1} 代替当前级别类型,标题名用参数 \code{\#2} 代替一般不变。
\command{listnumberline}[\marg{编号级别}]
这个命令用于设置图片、表格或代码的目录标签,默认包含与题注名相同的目录标签名。其中 \meta{编号级别} 需要显示指定,即为 \code{figure}、\code{table} 或 \code{lstlisting}。关于命令的用法可见\ref{exam:list command usage}。
\begin{ctexexam}
\ctexset
{
chapter =
{
tocformat = \addvspace{8pt}\large,
tocindent = 1.5em,
tocrule = \tocrule[0.6pc](1.1){.}[\zihao{5}],
tocline = \CTEXnumberline{#1}#2
}
}
\end{ctexexam}
\end{commands}
\begin{options}
\keybool{hang}\Default{false}
悬挂缩进选项 \option{hang} 使目录标题为悬挂缩进形式,缩进距离为标签及其与标题间距的长度,但此时标题编号会失去超链接。这个选项对所有标题级别有效。
\keyval-{lolskip}{弹性长度}\Default{10pt}
代码目录中每章代码标题的额外距离,与 C\TeX 的表格和图片目录中每章间的标题距离选项 \option*{lotskip} 和 \option*{lofskip} 类似,在 \cls*{article} 模式中此选项失效。
\keyval-{between}{目录代码钩子}
目录标题与内容间的钩子,一般插入负的垂直距离代码,用于抵消目录首行额外的垂直间距。一级路径此选项对应文档主目录的钩子,二级路径为 \module*{figure}、\module*{table} 和 \module*{lstlisting},或者用位于 \module*{list} 路径的此选项统一设置相应类型目录的钩子。
\keybool{dotalign}\Default{true}
引导线选项 \option{dotalign} 可以使目录引导线右端对齐并与页码保持一定间距,否则会与页码相连。
\keyval-{pagenumwd}{刚性长度}\Default{1.55em}
目录条目页码的宽度。开启 \option{dotalign} 选项时宽度越大引导线与页码的距离就越大。
\keyval-{tocafter-every}{距离命令}\Default{\cs*{hspace}\Carg{1em}}
统一设置所有级别在目录中标签与标题间的代码。
\keyval-{tocindent-every}{刚性长度}
统一设置所有级别的目录标题左边缩进。
\keyval-{tocrule-every}{目录引导线样式}
统一设置所有级别的目录引导线样式。
\end{options}
\section{常用环境}
\subsection{公式}
\begin{environments}\noitemsep
\environment*{equation}\default{}
\environment*{multline}\default{}
\environment*{gather}\default{}
\environment*{align}
\pkg*{amsmath} 宏包提供了一系列行间数学环境,它们可以排布各种对齐或不对齐的公式组。\env*{multline} 环境用于一行无法放下的长公式,\env*{gather} 环境用于每行居中的公式组,\env*{align} 环境用于多列对齐的公式组。还有例如 \pkg*{mathtools} 等对数学功能进行扩展的宏包,提供了更全面的数学命令与环境。
\end{environments}
\subsection{表格}
\begin{environments}\noitemsep
\environment*{tabularx}[\marg{长度}\marg{列格式}]\default{}
\environment*{tabular}[\marg{列格式}]\default{}
\environment{tblr}[\marg{键值列表}]
\pkg*{tabularray} 是一个强大且全面的表格宏包,不依赖其它表格宏包所以同时使用不会产生冲突。不仅提供了各种传统表格宏包的功能,还实现了用键值列表方式简便地设置表格样式。具体用法可见宏包的说明文档,下面演示一个 \env{tblr} 表格的用法:
\begin{ctexexam}
\begin{tblr}
{
colspec = {X[2,l]XX[LimeGreen]X},
rowspec = {Q[t]Q[m]Q[b,Magenta]Q[t]Q[m]Q[b]},
hline{1,6} = {1pt,solid},
hline{3-5} = {LightBlue,dashed},
vline{1,5} = {3-4}{dotted},
rows = {1cm,abovesep = 2pt}
}
Alpha & Beta & Gamma & Delta \\
Epsilon & Zeta & Eta & Theta \\
Iota & Kappa & \SetCell[r = 2]{h,c,Cyan}Lambda & Mu \\
Nu & Xi & Omicron & Pi \\
Rho & Sigma & Tau & Upsilon
\end{tblr}
\end{ctexexam}
\end{environments}
\subsection{列表}
\begin{commands}
\command*{setlist}[\sarg\splitoarg{列表类型,级别}\marg{键值列表}]
列表宏包 \pkg*{enumitem} 为系统预置的三个列表环境提供了灵活的标签以及间距控制,这是设置列表环境的通用接口命令。带有星号参数的命令在原有格式上补充。\meta{列表类型} 是排序列表 \code{enumerate}、常规列表 \code{itemize} 和主题列表 \code{description} 三个基本类型,也可以是 \cs*{newlist} 新建的定理环境,若不指定则设置所有列表类型的格式。若不指定 \meta{级别} 则设置所有列表级别的格式。
\command*{newlist}[\marg{列表名}\marg{列表类型}\marg{最大级别}]
克隆基本的 \meta{列表类型} 在其基础上新建一个名为 \meta{列表名} 的列表环境。不要将 \meta{最大级别} 设置过大以避免创建过多的计数器和相关宏。
\begin{ctexexam}
\setlist[1]{labelindent = \parindent}
\setlist[itemize,1]{label = $\triangleleft$}
\setlist[enumerate]{labelsep = *,leftmargin = 1.5pc}
\newlist{steps}{enumerate}{2}
\setlist[steps,1,2]{label = (\alph*)}
\end{ctexexam}
\end{commands}
\begin{environments}\noitemsep
\environment*{enumerate}[\oarg{键值列表}]\default{}
\environment*{itemize}[\oarg{键值列表}]\default{}
\environment*{description}[\oarg{键值列表}]
已为三种列表各自预置了三个级别,同种列表或不同种列表间的不同级别可相互嵌套,可以使用短编号的形式,带有星号的环境为行内列表。默认列表标签与标准文档类一致,下面举几个更改列表标签以及其它格式的例子:
\begin{ctexexam}
\setlist*{wide = 0em} % 取消所有列表的左边距
\begin{enumerate}[label = (\arabic*),leftmargin = 1cm,resume]
\begin{enumerate}[(1)] % 短编号形式
\begin{itemize}[label = \textbullet,labelsep = *]
\begin{description}[font = \sffamily\bfseries,style = nextline]
\end{ctexexam}
\end{environments}
\subsection{定理}
\label{subsec:theorem}
\begin{environments}\noitemsep
\environment{theorem}\default{}
\environment{definition}\default{}
\environment{lemma}\default{}
\environment{corollary}\default{}
\environment{proposition}\default{}
\environment{example}\default{}
\environment{proof}\default{}
\environment{assumption}\default{}
\environment{axiom}\default{}
\environment{remark}\default{}
\environment{conjecture}\default{}
\environment{problem}
这些是预置的定理环境,可使用选项 \option{thmframe} 为它们添加盒子边框,其中注与证明环境不编号,证明末尾会自动添加证明结束符,声明新的定理环境或更改定理盒子样式见\ref{subsec:theorem of style}。环境名与之对应的定理名如下:
\insertblr
{
colspec = @{}*{6}{c}@{},
hline{3} = {0.5pt,Blue},
row{1,3} = {font = \sffamily,,belowsep = 0pt},
row{2,4} = {cmd = \env}
}{
定理 & 定义 & 引理 & 推论 & 性质 & 例 \\
theorem & definition & lemma & corollary & proposition & example \\
证明 & 假设 & 公理 & 注 & 猜想 & 问题 \\
proof & assumption & axiom & remark & conjecture & problem
}
\end{environments}
\subsection{悬挂缩进}
\begin{commands}
\command{hangpara}[\marg{缩进长度}\marg{缩进开始行数}]
悬挂缩进命令 \cs{hangpara} 使其后的一个段落保持悬挂缩进,参数与 \env{hangparas} 环境相同,不过只有一个段落。
\end{commands}
\begin{environments}
\environment{hangparas}[\marg{缩进长度}\marg{缩进开始行数}]
悬挂缩进环境 \env{hangparas} 有两个必选参数,使其中的段落均保持悬挂缩进。每个段落的缩进将以 \meta{缩进长度} 从 \meta{缩进开始行数} 开始。
\end{environments}
\subsection{代码}
\begin{commands}
\command*{lstdefinestyle}[\marg{代码风格}\marg{键值列表}]
代码抄录宏包 \pkg*{listings} 的代码风格定义命令,提供大量选项对代码样式进行高度定制。可以根据需要的代码语言和样式定义多种风格,默认使用的 \meta{代码风格} 为 \code{lst-latex}。
\command{lstinline}[\oarg{键值列表}\marg{行内代码}]
行内代码抄录命令,较原生的 \cs*{verb} 命令有较大改进,具有代码语言和样式支持。
\end{commands}
\begin{environments}
\environment{lstlisting}[\oarg{键值列表}]
行间代码抄录环境,支持多种语言库,默认使用 \code{LaTeX} 代码语言,可使用 \meta{键值列表} 局部修改代码样式。另外还提供了 \cs*{lstnewenvironment} 命令包装自定义名称的代码环境。
\begin{ctexexam}
\lstdefinestyle{lst-pascal}
{
language = Pascal,
numbers = left,
firstnumber = last,
frame = shadowbox,
backgroundcolor = \color{MistyRose},
rulesepcolor = \color{DarkGray}
}
\lstnewenvironment{mypascal}[1][]{\lstset{style = lst-pascal,#1}}{}
\end{ctexexam}
\end{environments}
\begin{options}\noitemsep
\keyval-{lstlistlistingname}{代码目录标题名}\default{}
\keyval-{lstlistingname}{代码题注标题名}
代码目录名与代码环境题注名选项 \option*{lstlistlistingname} 和 \option*{lstlistingname} 用法与 C\TeX 使用手册标题汉化一节类似,可以看作对这节的扩展。
\end{options}
\subsection{习题}
\label{subsec:exercise}
\begin{environments}
\environment{exercise}[\sarg\harg\oarg{键值列表1}\darg{键值列表2}\oarg{键值列表3}]
习题环境的标题使用 \cs*{tcbox} 行内盒子包装样式,内容则使用 \env*{enumerate} 列表环境。它有 5 个可选参数,应当注意用法。当使用星号参数时标题不进行编号,使用 \harg{} 号参数时不显示标题,此时 \meta{键值列表1} 除了 \option{label} 选项失效。
\meta{键值列表2} 包括 \pkg*{tcolorbox} 的盒子样式选项,例如 \option*{boxsep} 和 \option*{fontupper} 等,也可以使用下述 \option{tcolorbox} 选项。在这里可以使用 \cs{addtotcbstyle} 命令设置标题选项 \meta{键值列表2} 的值,第一个参数为 \code{tc-exercise}。
\begin{ctexexam}
\tcphantomifname{\markright{\counteruse{tcbcounter}\quad 习题}}{}
\addtotcbstyle{tc-exercise}{boxsep = 5pt}
\exerprologue{习题前的一段文本}
\begin{exercise}*[color = LightSkyBlue](after skip = 2pc)[itemsep = 1ex]
\item 第一题
\item 第二题
\end{exercise}
\end{ctexexam}
\end{environments}
\begin{commands}
\command{setexercise}[\marg{键值列表1}]
配置命令 \cs{setexercise} 用于全局设置上述习题环境 \env{exercise} 标题样式可选参数中 \meta{键值列表1} 的默认值,包含的选项如下:
\begin{options}
\keyval-{color}{标题背景颜色名}\Default{DeepSkyBlue}
习题标题盒子背景颜色,可以使用 \pkg*{xcolor} 自定义颜色或使用色库。
\keyval-{title}{环境标题}
习题的标题,可以匹配中英文模式,习题环境使用 \harg{} 号参数时无效。也可以使用 \option{exercisename} 选项设置习题环境标题的默认值。
\keyval-{number}{习题编号类型}\Default{1.}
标题编号输出选项 \option{number} 为短编号形式,应当包含 \code{A}、\code{a}、\code{I}、\code{i}、或 \code{1} 其中一个符号。
\keyval-{numsep}{编号与标题的间距}\Default{0.5em}
习题标题编号与后方标题文本的间距,习题环境使用星号参数时无效。
\keyval-{tocnumsep}{目录编号与标题的间距}\Default{1em}
目录中习题标题编号与后方标题文本的间距,习题环境使用星号参数时无效。
\keyval-{tcolorbox}{键值列表2}
局部传递 \pkg*{tcolorbox} 宏包的格式选项给习题标题(如果存在)。
\keyval-{enumitem}{键值列表3}
局部传递 \pkg*{enumitem} 宏包的格式选项给习题条目列表。
\keyval-{label}{标签内容}
设置习题环境的引用标签,它与标签格式命令 \cs{labelformat} 对应的计数器是 \code{eb@exercise}。
\end{options}
\command{setexerlist}[\marg{键值列表3}]
命令 \cs{setexerlist} 用于全局设置习题条目选项 \meta{键值列表3} 的值。\meta{键值列表3} 的选项与 \pkg*{enumitem} 的排序列表相同,也可以使用下述 \option{enumitem} 选项,不过第一个选项无法是短编号形式,这被 \option{number} 选项代替。
\command{exerprologue}[\sarg\marg{序言内容}]
序言命令 \cs{exerprologue} 在习题环境开始前插入一段内容,可以是文本或者代码,需要在每一个习题环境前使用。带有星号参数的命令会使序言在习题环境一直有效。
\command{tcphantomifname}[\marg{编号代码}\marg{不编号代码}]
命令 \cs{tcphantomifname} 根据使用 \pkg*{tcolorbox} 生成的习题标题是否编号,在超链接锚点的位置加入代码,比如使用 \cs*{addcontentsline} 命令将习题标题加入目录。
\end{commands}
\subsection{盒子}
\label{subsec:box}
使用盒子以及\ref{subsec:exercise} 中的 \env{exercise} 环境需要在导言区\textbf{手动载入} \pkg*{tcolorbox} 宏包,它们 \meta{配置选项} 的键值列表同样由 \pkg*{tcolorbox} 提供支持,具体选项可见宏包文档的 Option Keys 一节,可以进行边距、字体及背景颜色等各种个性化设置,一些配置会覆盖预设。
\begin{commands}
\command{deftcbstyle}[\marg{盒子风格}\marg{键值列表}]
新建或重置一个名称为 \meta{盒子风格} 的 \pkg*{tcolorbox} 宏包盒子风格,可以与 \cs{addtotcbstyle} 命令联用。
\command{addtotcbstyle}[\marg{盒子风格}\marg{键值列表}]
修改已存在的 \pkg*{tcolorbox} 宏包盒子风格。这个命令可以调整以下即将介绍的预置盒子风格,对于预置盒子来说参数 \meta{盒子风格} 即为它们对应的环境或命令名。
\begin{ctexexam}
\deftcbstyle{mytcb} % 新建一个盒子风格mytcb
{
colback = Snow,colframe = LimeGreen,coltext = Coral,
fontupper = \bfseries,arc = 6pt,
boxrule = 5pt,boxsep = 5pt,
borderline = {2pt}{2pt}{white}
}
\newtcolorbox{mytcbox}[1][]{enhanced,mytcb,title = #1}
\begin{tcolorbox}[mytcb,enhanced]
盒子内容1
\end{tcolorbox}
\begin{mytcbox}[盒子标题]
盒子内容2
\end{mytcbox}
\end{ctexexam}
\end{commands}
\subsubsection{摘要盒子}
\begin{environments}
\environment{outline}[\oarg{键值列表1}\darg{标题名称}\oarg{键值列表2}]
摘要盒子 \env{outline} 可用于章前摘要,它的标题是可选参数,默认标题是摘要。\meta{键值列表2} 是摘要盒子样式选项,可以使用 \cs{addtotcbstyle} 命令对它进行全局设置,第一个参数为 \code{tc-outline}。
\end{environments}
\begin{commands}
\command{setoutlinelist}[\marg{键值列表1}]
\meta{键值列表1} 与 \pkg*{enumitem} 宏包中列表配置选项相同,可以设置摘要条目的各种距离,要对它进行全局设置可以使用 \cs{setoutlinelist} 命令。
\begin{ctexexam}
\addtotcbstyle{tc-outline}{arc = 6pt}
\begin{outline}[leftmargin = *](摘要标题)
\item 摘要内容1
\item 摘要内容2
\end{outline}
\end{ctexexam}
\end{commands}
\subsubsection{段落盒子}
\begin{environments}
\environment{easybox}[\sarg\oarg{颜色名}\darg{段落标题}\oarg{配置选项}]
环境 \env{easybox} 创建一个带有三个可选参数的扁平盒子。使用星号参数时给盒子添加边框,\meta{颜色名} 选项设置背景颜色,\meta{段落标题} 选项可以设置标题,默认无标题。如果 \meta{配置选项} 较长且希望在原有基础上改为全局固定的样式,可以使用 \cs{addtotcbstyle} 命令设置,第一个参数为 \code{tc-easybox}。
\begin{ctexexam}
\begin{easybox}*[DarkCyan](段落标题)
上半盒子内容
\tcblower % 盒子上下部分分界线
下半盒子内容
\end{easybox}
\end{ctexexam}
\environment{ebparbox}[\sarg\oarg{颜色名}\darg{段落标题}\oarg{配置选项}]
环境 \env{ebparbox} 用法与 \env{easybox} 类似,同样带有三个可选参数。当使用星号参数时盒子左边带有一条竖线,\meta{颜色名} 选项可以自定义竖线颜色,使用带有星号的环境则盒子带有竖线颜色的浅色背景。\meta{段落标题} 选项可以设置标题,默认无标题。
\end{environments}
\subsubsection{行内盒子}
\begin{commands}
\command{eblink}[\oarg{颜色名}\marg{内容}\oarg{配置选项}]
使用 \pkg*{tcolorbox} 预置了三个参数选项相同的行内盒子,它们均为抄录命令。盒子 \cs{eblink} 具有类似超链接边框的效果。
\command{ebemph}[\oarg{颜色名}\marg{内容}\oarg{配置选项}]
盒子 \cs{ebemph} 具有模糊边缘类似高亮的效果。
\command{ebfbox}[\oarg{颜色名}\marg{内容}\oarg{配置选项}]
盒子 \cs{ebfbox} 则有直角边缘并带有上下框线。
\end{commands}
\section{更多用法}
\subsection{物理量}
\begin{commands}
\command*{num}[\oarg{键值列表}\marg{数字}]
\pkg*{siunitx} 宏包的 \cs*{num} 命令可以输出以科学计数法表示的数值。
\command*{unit}[\oarg{键值列表}\marg{单位}]
单位格式化命令 \cs*{unit} 包含文字元素(例如字母或数字)时,使用 \Marg{.} 和 \code{\~{}} 放置在单元乘积中间,并使用 \code{\_} 和 \code{\^{}} 正确放置指定的下标和上标。格式化方法可在数学和文本模式下使用。
\command*{qty}[\oarg{键值列表}\marg{数字}\oarg{前缀}\marg{单位}]
命令 \cs*{qty} 可用来输出带有单位的量。
\command*{qtyrange}[\oarg{键值列表}\marg{数字1}\marg{数字2}\marg{单位}]
命令 \cs*{qtyrange} 可以输出带有范围和单位的量。
\begin{ctexexam}
\numproduct{-21x3e5}
\unit{mL~min^{-1}}
\qty{5}{\mole}
\qtyrange[unit-color = green]{1.5}{4}{kg}
\end{ctexexam}
\end{commands}
\subsection{计数器}
\begin{commands}\noitemsep
\command{newcounter}[\marg{计数器}\oarg{父计数器}]\default{}
\command{counteruse}[\sarg\oarg{父计数器}\darg{编号}\marg{计数器}\oarg{分隔符}\darg{整数}]
命令 \cs{newcounter} 是 \LaTeX 自带的创建计数器命令,计数器值输出命令 \cs{counteruse} 以一定的格式使用由它创建的计数器,将会以 \cs*{the}\meta{父计数器}\meta{分隔符}\cs*{the}\meta{计数器} 输出这种计数器的值。命令 \cs{counteruse} 仅具有\textbf{输出功能},并不会改变计数器原有的绑定关系。默认每使用一次命令 \meta{计数器} 的值增加 1,带有星号的命令使 \meta{计数器} 值保持不变,\meta{计数器} 的值也可以设为指定的 \meta{整数}。计数器的 \meta{编号} 为 \code{arabic} 或 \code{alph} 等计数形式。
在一定的场合下可能用到 \cs{counteruse} 命令,比如通过新建快捷命令在一些位置使用定理环境的计数器,使用 \cs{labelformat} 设置计数器的引用标签需添加 \code{eb@}:
\begin{ctexexam}
\labelformat{eb@theorem}{定理 #1}
\newcommand{\theoremhead}[1]{定理\counteruse[chapter]{theorem}\hspace{1em}#1}
\theoremhead{定理内容}\label{thm:theorem}
\end{ctexexam}
\end{commands}
\subsection{图表题注}
\begin{commands}
\command*{captionsetup}[\oarg{题注类型}\marg{键值列表}]
这是 \pkg*{caption} 宏包的接口命令,\meta{键值列表} 提供多个选项更改图表题注的格式。题注主要由三部分组成:标题标签即图表名与题注编号的组合,标题文本本身通常是内容的简短描述,以及将文本与标签分开的题注分隔符。可以在导言区设置整体格式,也可以在正文使用局部更改格式。
\end{commands}
\begin{commands}\noitemsep
\command{caption}[\sarg\oarg{目录标题}\marg{标题}]\default{}
\command{captionof}[\sarg\marg{题注类型}\oarg{目录标题}\marg{标题}]\default{}
\command{bicaption}[\sarg\oarg{目录标题1}\marg{标题2}\oarg{目录标题1}\marg{标题2}]
题注命令 \cs{caption} 用于在图表上下方插入题注,需要在浮动体环境 \env*{figure} 和 \env*{table} 中使用,在浮动环境外可以使用 \cs{captionof} 命令,第一个参数指定题注类型。\cs{bicaption} 命令可以实现中英文双语题注,需要在导言区载入 \pkg*{bicaption} 宏包,具体用法见说明文档。
\end{commands}
\subsection{化学式}
\begin{commands}\noitemsep
\command*{ch}[\oarg{键值列表}\marg{化学式}]\default{}
\command*{chemfig}[\oarg{键值列表}\marg{化学式}]
除了以普通公式的方式,化学式还可用 \pkg*{chemformula} 实现,无机化学式使用 \cs*{ch} 命令书写。有机化学式推荐在导言区载入 \pkg*{chemfig} 宏包,使用 \cs*{chemfig} 命令完成。
\end{commands}
\subsection{公式符号对照}
\begin{environments}
\environment{eqcomp}[\oarg{键值列表1}\darg{键值列表2}]
一些公式之后可以使用基于列表环境的 \env{eqcomp} 进行符号对照。对照列表的 \meta{键值列表2} 与 \pkg*{enumitem} 的选项相同,一般较少用到,可以用于设置垂直间距等。
\begin{ctexexam}
\seteqcomp{intro = 上式中}
\begin{eqcomp}[width = 1.5em]
\symb{Ab}[$\to$] 符号说明1
\symb{C}[---] 符号说明2
\end{eqcomp}
\end{ctexexam}
\end{environments}
\begin{commands}
\command{symb}[\sarg\marg{符号}\oarg{引导符}]
符号条目命令 \cs{symb} 类似 \cs*{item},需要在环境内使用,带有星号的命令可在文本段落单独使用。
\command{seteqcomplist}[\marg{键值列表2}]
对照列表条目格式的 \meta{键值列表2} 可以使用 \cs{seteqcomplist} 全局设置。
\command{seteqcomp}[\marg{键值列表1}]
对照环境的 \meta{键值列表1} 可以使用 \cs{seteqcomp} 全局设置,它的选项如下:
\begin{options}
\keyval-{width}{符号宽度}\Default{10pt}
设置适当的符号宽度可以防止文字重叠和边界溢出等问题。
\keyval-{delim}{引导符}\Default{\Carg{——}}
全局的符号对照引导符。\cs{symb} 局部的 \meta{引导符} 和对齐方式是基于这个符号的宽度。
\keyval-{space}{符号间隙}\Default{0.25em}
符号间隙为引导符两侧与符号和说明文字间的距离。
\keychoice{item-align}{l,c,r}\Default{r}
符号的对齐方式,分为左 \code{l}、中 \code{c} 和右 \code{r} 三种对齐方式。
\keychoice{delim-align}{l,c,r}\Default{c}
引导符的对齐方式,分为左 \code{l}、中 \code{c} 和右 \code{r} 三种对齐方式。
\keyval-{enumitem}{键值列表2}
可以使用选项 \option{enumitem} 或命令 \cs{seteqcomplist} 调整对照列表的水平和垂直间距。
\keyval-{intro}{首行文字}\Default
符号对照的说明文字。应当为简短的几个字,只显示在第一行,其后为悬挂缩进的对照列表。
\keyval-{font}{符号字体}\Default
符号的字体。数学和文本符号模式应采用不同的字体命令,最后一个命令可以接受一个参数,这个参数为符号。
\keychoice{mode}{math,text}\Default{math}
符号字体模式,可以为数学字体或者文本字体。
\end{options}
\end{commands}
\subsection{交叉引用}
\begin{commands}
\command*{ref}[\marg{标签名}]
使用 \cs*{ref} 命令引用 \cs*{label} 设置的 \meta{标签名},将会检测临近计数器并添加相应的前缀,比如图表题注、章节标题和定理等。
\command{footref}[\marg{脚注标签名}]
对自动编号的脚注进行引用可使用 \cs{footref} 命令,与引用的标记共享一个编号与格式。
\command{labelformat}[\marg{计数器}\marg{标签引用格式}]
标签格式命令 \cs{labelformat} 可以设置引用标签格式,\meta{标签引用格式} 中 \code{\#1} 代表 \cs*{the}\meta{计数器},可以设置引用序号的前缀和后缀。
\end{commands}
\subsubsection{索引}
\begin{commands}
\command*{indexsetup}[\marg{键值列表}]
\pkg*{imakeidx} 宏包增强了索引的功能,这是它的的接口命令,用于设置索引表的整体格式。
\command*{index}[\oarg{索引名}\marg{标签}]
索引标签命令 \cs*{index} 的 \meta{索引名} 与索引打印命令 \cs{printindex} 一致,可以存在多个索引表。
\command*{makeindex}[\oarg{键值列表}]
使用 \cs*{makeindex} 命令开启索引收集。这个命令可以重复使用打印多个索引表,以不同的 \meta{索引名} 作为区分,如果仅打印一个索引表就没必要再使用。
\command{printindex}[\sarg\parg\oarg{键值列表}\darg{索引名}]
现在索引表生成命令 \cs{printindex} 被重新定义,\meta{键值列表} 中的选项与\ref{sec:document command} 其它目录命令相同,但是原本接口命令 \cs*{indexsetup} 的部分选项失效。
\end{commands}
\subsubsection{自定义脚注}
\label{subsubsec:custom footnotes}
\begin{commands}\noitemsep
\command{Footnote}[\oarg{内容标记}\marg{正文标记}\marg{脚注文本}]\default{}
\command{Footnotetext}[\marg{内容标记}\marg{脚注文本}]\default{}
\command{Footnotemark}[\marg{正文标记}]
这些是自定义标记且不影响正常编号的脚注命令,用法与它们对应首字母小写的命令类似。\meta{内容标记} 默认与 \meta{正文标记} 一致,可以进行微调。如果当前标记为空,那么将会使用上一个脚注标记。
\begin{ctexexam}
\Footnote{*}{这是可以自定义标记的脚注。}
\end{ctexexam}
\end{commands}
\subsubsection{边注}
\begin{commands}
\command{marginnote}[\oarg{左文本}\marg{右文本}\oarg{垂直偏移}]
命令 \cs{marginnote} 可以生成简单的边注,如果只给定了 \meta{右文本},那么边注在奇偶数页文字相同。如果同时给定了 \meta{左文本},则偶数页使用 \meta{左文本} 的文字。
\end{commands}
\subsection{插入文档}
\begin{commands}
\command*{includepdf}[\oarg{键值列表}\marg{文档名}]
该命令由文档宏包 \pkg*{pdfpages} 提供,可以将其它 \code{pdf} 文档插入当前文档,比如插入其它软件制作的封面。\meta{键值列表} 可以指定插入页数、逻辑页和横向页面等,详情查看宏包文档。
\end{commands}
\subsection{指定行距的段落}
\begin{environments}
\environment*{spacing}[\marg{浮点数}]
该环境由行距宏包 \pkg*{setspace} 提供,可以指定环境内段落的行距,使用 \meta{浮点数} 控制行距倍数。
\end{environments}
\subsection{下划线}
\begin{commands}\noitemsep
\command*{uline}[\marg{下划直线}]\default{}
\command*{uuline}[\marg{下划双直线}]\default{}
\command*{uwave}[\marg{下划波浪线}]
\pkg*{ulem} 宏包提供了多种下划线命令,可以重新定义 \cs*{ULthickness} 命令控制下划线的粗细。下划线的深度由 \cs*{ULdepth} 控制,默认值 \cs*{maxdimen} 是一个允许深度根据当前字体变化的特殊标志,当然也可以使用 \cs*{setlength} 设定为指定深度。
\end{commands}
\appendix
\nocite{*}
\end{document}
|