Debian Codegraph @

texmf-dist/source/latex/bithesis/bithesis-report.dtx

raw
1 % \subsection{bitreport.cls 模板类}
2 %
3 % \subsubsection{全局变量与临时变量}
4 %
5 % \begin{variable}{\g_@@_thesis_type_int}
6 % 论文类型,取值从 1 开始,分别对应:
7 % \begin{enumerate}
8 % \item 课程实验报告
9 % \item (计算机学院)本科生毕业(设计)开题报告(已废弃)
10 % \end{enumerate}
11 % \begin{macrocode}
12 \int_new:N \g_@@_report_type_int
13 % \end{macrocode}
14 % \end{variable}
15 %
16 % \begin{variable}{\c_@@_report_type_clist}
17 % 定义报告类型的列表。
18 % \begin{macrocode}
19 \clist_const:Nn \c_@@_report_type_clist
20 { common, undergraduate_proposal}
21 % \end{macrocode}
22 % \end{variable}
23 %
24 % \begin{variable}{\l_@@_right_seq,\l_@@_left_seq}
25 % 临时变量。
26 % \begin{macrocode}
27 \seq_new:N \l_@@_right_seq
28 \seq_new:N \l_@@_left_seq
29 % \end{macrocode}
30 % \end{variable}
31 %
32 % 手动开启伪粗体、伪斜体。
33 % \begin{macrocode}
34 \PassOptionsToPackage{AutoFakeBold,AutoFakeSlant}{xeCJK}
35 % \end{macrocode}
36 %
37 % \subsubsection{l3keys 接口键值对定义}
38 %
39 % 定义 |bitreport| 模板类的键值对。
40 % \begin{macrocode}
41 \keys_define:nn { bitreport }
42 {
43 option .meta:nn = {bitreport / option } {#1},
44 cover .meta:nn = { bitreport / cover } {#1},
45 info .meta:nn = { bitreport / info } {#1},
46 misc .meta:nn = { bitreport / misc } {#1}
47 }
48 % \end{macrocode}
49 %
50 % 定义 |bitreport/option| 模板类的键值对。
51 % \begin{macrocode}
52 \keys_define:nn { bitreport / option }
53 {
54 type .choice:,
55 type .value_required:n = true,
56 type .choices:Vn =
57 \c_@@_report_type_clist
58 {
59 \int_set_eq:NN \g_@@_report_type_int \l_keys_choice_int
60 },
61 type .initial:n = common,
62 ctex .tl_set:N = \l_@@_options_to_ctex_tl,
63 }
64 % \end{macrocode}
65 %
66 % 定义 |bitreport/cover| 模板类的键值对。
67 % \begin{macrocode}
68 \keys_define:nn { bitreport / cover }
69 {
70 imagePath .tl_set:N = \l_bit_coverimagepath_tl,
71 date .tl_set:N = \l_@@_cover_date_tl,
72 %% cover entry
73 delimiter .tl_set:N = \l_@@_cover_delimiter_tl,
74 labelAlign .tl_set:N = \l_@@_cover_label_align_tl,
75 labelAlign .initial:n = {r},
76 valueAlign .tl_set:N = \l_@@_cover_value_align_tl,
77 valueAlign .initial:n = {c},
78 labelMaxWidth .dim_set:N = \l_@@_cover_label_max_width_dim,
79 valueMaxWidth .dim_set:N = \l_@@_cover_value_max_width_dim,
80 autoWidthPadding .dim_set:N = \l_@@_cover_auto_width_padding_dim,
81 autoWidthPadding .initial:n = {0.25em},
82 autoWidth .bool_set:N = \l_@@_cover_auto_width_bool,
83 autoWidth .initial:n = {true},
84 underlineThickness .dim_set:N = \l_@@_cover_underline_thickness_dim,
85 underlineThickness .initial:n = {1pt},
86 underlineOffset .dim_set:N = \l_@@_cover_underline_offset_dim,
87 underlineOffset .initial:n = { -10pt },
88 }
89 % \end{macrocode}
90 %
91 % 定义 |bitreport/info| 模板类的键值对。
92 % \begin{macrocode}
93 \keys_define:nn { bitreport / info }
94 {
95 title .tl_set:N = \l_@@_value_title_tl,
96 school .tl_set:N = \l_@@_value_school_tl,
97 major .tl_set:N = \l_@@_value_major_tl,
98 class .tl_set:N = \l_@@_value_class_tl,
99 author .tl_set:N = \l_@@_value_author_tl,
100 supervisor .tl_set:N = \l_@@_value_supervisor_tl,
101 externalSupervisor .tl_set:N = \l_@@_value_external_supervisor_tl,
102 studentId .tl_set:N = \l_@@_value_student_id_tl,
103 }
104 % \end{macrocode}
105 %
106 % 定义 |bitreport/misc| 模板类的键值对。
107 % \begin{macrocode}
108 \keys_define:nn { bitreport / misc }
109 {
110 reviewTable .tl_set:N = \l_bit_reviewtable_tl,
111 }
112 % \end{macrocode}
113 %
114 % 将 |bithesis/option/ctex| 中的值传递给 ctexbook 模板类。
115 % \begin{macrocode}
116 \DeclareOption*{
117 \PassOptionsToClass{\l_@@_options_to_ctex_tl}{ctexart}
118 }
119 % \end{macrocode}
120 %
121 % 加载 ctexbook 模板类。
122 % \begin{macrocode}
123 \ProcessOptions\relax
124 \LoadClass[zihao=-4]{ctexart}
125 % \end{macrocode}
126 %
127 % \subsubsection{定义模板类样式}
128 % 加载所需的宏包。
129 % \begin{macrocode}
130 \RequirePackage[a4paper,left=3cm,right=2.4cm,top=2.6cm,bottom=2.38cm,includeheadfoot]{geometry}
131 \RequirePackage{fancyhdr}
132 \RequirePackage{setspace}
133 \RequirePackage{caption}
134 \RequirePackage{booktabs}
135 \RequirePackage{pdfpages}
136 % \end{macrocode}
137 %
138 % 在宏加载时,处理 |bitreport/option| 中的值。使得 |bitreport|
139 % 宏包的模板选项可以在宏加载时生效。
140 % \begin{macrocode}
141 \ProcessKeysOptions { bitreport / option }
142 % \end{macrocode}
143 %
144 % \subsubsection{辅助函数与常量}
145 %
146 % \begin{macro}{\tl_if_empty:xTF,\seq_set_split:Nnx}
147 % 生成变体。
148 % \begin{macrocode}
149 \cs_generate_variant:Nn \tl_if_empty:nTF {x}
150 \cs_generate_variant:Nn \seq_set_split:Nnn {Nnx}
151 % \end{macrocode}
152 % \end{macro}
153 %
154 % \begin{macro}{\@@_dunderline:nnn}
155 % 用于渲染下划线。
156 %
157 % 参数如下:
158 % \begin{itemize}
159 % \item \#1 位置,可选值为 \texttt{c}enter、\texttt{l}eft、\texttt{r}ight。
160 % \item \#2 |dim| 长度。
161 % \item \#3 |tl| 文字内容。
162 % \end{itemize}
163 % \begin{macrocode}
164 \cs_new:Npn \@@_dunderline:nnn #1#2#3 {
165 {\setbox0=\hbox{#3}\ooalign{\copy0\cr\rule[\dimexpr#1-#2\relax]{\wd0}{#2}}}
166 }
167 % \end{macrocode}
168 % \end{macro}
169 %
170 % \begin{macro}{|@@_render_cover_entry:nn}
171 % 用于渲染封面的辅助函数。
172 %
173 % 参数如下:
174 % \begin{itemize}
175 % \item \#1 |{token_list}| 为封面信息条目的名称,含分隔符。
176 % \item \#2 |{token_list}| 为封面信息条目的内容。
177 % \end{itemize}
178 %
179 % 需要在 |\l_@@_cover_label_max_width_dim| 和 |\l_@@_cover_value_max_width_dim|
180 % 存储已经计算出来的最大宽度。
181 % \begin{macrocode}
182 \cs_new:Npn \@@_render_cover_entry:nn #1#2 {
183 \makebox[\l_@@_cover_label_max_width_dim][\l_@@_cover_label_align_tl]{
184 \tl_if_blank:VTF #1 {} {#1}
185 }
186 \hspace{1ex}
187 \@@_dunderline:nnn{\l_@@_cover_underline_offset_dim}{\l_@@_cover_underline_thickness_dim}{
188 \makebox[\l_@@_cover_value_max_width_dim][\l_@@_cover_value_align_tl]{#2}
189 }\par
190 }
191 % \end{macrocode}
192 % \end{macro}
193 %
194 % \begin{macro}{|@@_get_text_width:Nn,\@@_get_text_width:NV}
195 % 计算 \#2 所占用的宽度,将结果存储在 \#1 中。
196 %
197 % 参数如下:
198 % \begin{itemize}
199 % \item \#1 |dim| 存储宽度的变量。
200 % \item \#2 |tl| 要计算宽度的文本。
201 % \end{itemize}
202 % \begin{macrocode}
203 % Get text with from #2, then set to #1.
204 \cs_new:Npn \@@_get_text_width:Nn #1#2
205 {
206 \hbox_set:Nn \l_tmpa_box {#2}
207 \dim_set:Nn #1 { \box_wd:N \l_tmpa_box }
208 }
209 \cs_generate_variant:Nn \@@_get_text_width:Nn { NV }
210 % \end{macrocode}
211 % \end{macro}
212 %
213 % \begin{macro}{\@@_get_max_text_width:NN}
214 % 从 \#2 中获取最大的文本宽度,然后设置到 \#1 中。
215 %
216 % 参数如下:
217 % \begin{itemize}
218 % \item \#1: |dim| 用于输出最大宽度。
219 % \item \#2: |seq| 用于输入存储文本。
220 % \end{itemize}
221 % \begin{macrocode}
222 \cs_new:Npn \@@_get_max_text_width:NN #1#2
223 {
224 % 这里用 |group| 确保局部变量不会被污染。
225 \group_begin:
226 \seq_set_eq:NN \l_@@_tmpa_seq #2
227 \dim_zero_new:N \l_@@_tmpa_dim
228 \bool_until_do:nn { \seq_if_empty_p:N \l_@@_tmpa_seq }
229 {
230 \seq_pop_left:NN \l_@@_tmpa_seq \l_@@_tmpa_tl
231 \@@_get_text_width:NV \l_@@_tmpa_dim \l_@@_tmpa_tl
232 \dim_gset:Nn #1 { \dim_max:nn {#1} { \l_@@_tmpa_dim } }
233 }
234 \group_end:
235 }
236 % \end{macrocode}
237 % \end{macro}
238 %
239 % \begin{macro}{\@@_parse_entry:nn}
240 % 解析封面信息条目,丢弃空项,并添加分隔符。
241 %
242 % 参数如下:
243 % \begin{itemize}
244 % \item \#1: |tl| 为封面信息条目的名称。
245 % \item \#2: |tl| 为封面信息条目的内容。
246 % \end{itemize}
247 % |\\| 会被视为换行符,从而实现信息条目换行的效果。
248 %
249 % 结果会存储到 |\l_@@_tmp_left_seq| 和 |\l_@@_tmp_right_seq|。
250 %
251 % \begin{macrocode}
252 \cs_new:Npn \@@_parse_entry:nn #1 #2 {
253 \seq_clear:N \l_@@_tmp_left_seq
254 \seq_clear:N \l_@@_tmp_right_seq
255
256 % 只处理 value 非空的项
257 \tl_set:Nn \l_tmpa_tl {#2}
258 \tl_if_empty:xTF {\l_tmpa_tl} {} {
259 \seq_set_split:Nnx \l_@@_tmp_right_seq {\\} {#2}
260 \seq_map_inline:Nn \l_@@_tmp_right_seq {
261 \seq_put_right:Nn \l_@@_tmp_left_seq {}
262 }
263 \seq_put_left:Nn \l_@@_tmp_left_seq {#1\l_@@_cover_delimiter_tl}
264 \seq_pop_right:NN \l_@@_tmp_left_seq \g_@@_trashcan_tl
265 }
266 }
267 % \end{macrocode}
268 % \end{macro}
269 %
270 % \begin{macro}{\@@_render_cover_entry}
271 % 渲染封面信息项。此函数为主函数。
272 % \begin{macrocode}
273 \cs_new:Npn \@@_render_cover_entry:n #1 {
274 % 左边是标签,右边是值。
275 % 形如:
276 % { {label_1} {value_1}, {label_2} {value 2} }
277 % 首先转换成 seq 类型。
278 \seq_set_from_clist:NN \l_@@_input_seq #1
279 \seq_map_inline:Nn \l_@@_input_seq {
280 % 然后对于每一对 label 和 value,首先查找
281 % value 中是否含有 \\ 字符,如果有,则将其分割成多个
282 % label - value 对。
283 % 比如 {label_1} {value \\ 1} 会被转换成
284 % { {label_1} {value}, {} {1} }
285 \@@_parse_entry:nn ##1
286 % 然后将这些 label - value 对添加到 \l_@@_right_seq
287 % 或者 \l_@@_left_sql 中。
288 % left 就是 label,right 就是 value。
289 \seq_concat:NNN \l_@@_right_seq \l_@@_right_seq \l_@@_tmp_right_seq
290 \seq_concat:NNN \l_@@_left_seq \l_@@_left_seq \l_@@_tmp_left_seq
291 }
292
293 % 如果用户选择自动计算最大宽度,则计算最大宽度。
294 \bool_if:NT \l_@@_cover_auto_width_bool {
295 \@@_get_max_text_width:NN \l_@@_cover_label_max_width_dim \l_@@_left_seq
296 \@@_get_max_text_width:NN \l_@@_cover_value_max_width_dim \l_@@_right_seq
297 % 在 value 两边加上空白,避免文本太靠边。
298 \dim_add:Nn \l_@@_cover_value_max_width_dim { \l_@@_cover_auto_width_padding_dim * 2 }
299 }
300
301
302 % 最后,根据宽度渲染 label 和 value 对。
303 \group_begin:
304 \bool_until_do:nn { \seq_if_empty_p:N \l_@@_left_seq }
305 {
306 \seq_pop_left:NN \l_@@_left_seq \l_@@_tmpa_tl
307 \seq_pop_left:NN \l_@@_right_seq \l_@@_tmpb_tl
308 \@@_render_cover_entry:nn {\l_@@_tmpa_tl} {\l_@@_tmpb_tl}
309 }
310 \group_end:
311 }
312 % \end{macrocode}
313 % \end{macro}
314 %
315 % \subsubsection{定义用户接口}
316 %
317 % \begin{macro}{\BITSetup}
318 % 提供用户配置的接口。
319 % \begin{macrocode}
320 \DeclareDocumentCommand \BITSetup { m }
321 { \keys_set:nn { bitreport } { #1 }}
322 % \end{macrocode}
323 % \end{macro}
324 %
325 % \begin{macro}{\MakeCover}
326 % 渲染封面。
327 % \begin{macrocode}
328 \DeclareDocumentCommand \MakeCover {}
329 {
330 \group_begin:
331 \int_case:nn {\g_@@_report_type_int} {
332 {1} {
333 \begin{titlepage}
334 \centering
335
336 \vspace{23mm}
337
338 \tl_if_empty:NF \l_bit_coverimagepath_tl {
339 \includegraphics[width=.5\textwidth]{\l_bit_coverimagepath_tl}\\
340 }
341
342 \vspace{10mm}
343
344 \heiti\fontsize{24pt}{24pt}\selectfont{\l_@@_value_title_tl}\\
345
346 \vspace{67mm}
347
348 \begin{spacing}{2.2}
349 \songti\zihao{3}
350
351 \clist_set:Nn \l_@@_input_clist {
352 {\textbf{学\qquad 院:}} {\l_@@_value_school_tl},
353 {\textbf{专\qquad 业:}} {\l_@@_value_major_tl},
354 {\textbf{班\qquad 级:}} {\l_@@_value_class_tl},
355 {\textbf{学\qquad 号:}} {\l_@@_value_student_id_tl},
356 {\textbf{姓\qquad 名:}} {\l_@@_value_author_tl},
357 {\textbf{任课教师:}} {\l_@@_value_supervisor_tl},
358 }
359
360 \@@_render_cover_entry:n \l_@@_input_clist
361
362 \end{spacing}
363
364 \vspace*{\fill}
365
366 \centering
367
368 \songti\fontsize{12pt}{12pt}\selectfont{
369 \tl_if_empty:NTF \l_@@_cover_date_tl {
370 \today
371 } {
372 \l_@@_cover_date_tl
373 }
374 }
375 \end{titlepage}
376 }
377 {2} {
378 % Main code for \MakeCover
379 \begin{titlepage}
380 \topskip=0pt
381 \vspace*{-16mm}
382 \centering
383 \hspace{-6mm}
384 \songti\fontsize{22pt}{22pt}
385 \selectfont{北京理工大学}\par
386
387 \vspace{13mm}
388
389 \hspace{-6mm}
390 \heiti\fontsize{24pt}{24pt}
391 \selectfont{本科生毕业设计(论文)开题报告}\par
392
393 \vspace{53mm}
394
395 \begin{spacing}{2.2}
396 \songti\zihao{3}
397 \clist_set:Nn \l_@@_input_clist {
398 {\textbf{学\qquad 院:}} {\l_@@_value_school_tl},
399 {\textbf{专\qquad 业:}} {\l_@@_value_major_tl},
400 {\textbf{班\qquad 级:}} {\l_@@_value_class_tl},
401 {\textbf{姓\qquad 名:}} {\l_@@_value_author_tl},
402 {\textbf{指导教师:}} {\l_@@_value_supervisor_tl},
403 {\textbf{校外指导教师:}} {\l_@@_value_external_supervisor_tl},
404 }
405
406 \@@_render_cover_entry:n \l_@@_input_clist
407
408 \end{spacing}
409
410 \vspace*{\fill}
411
412 \centering
413 \hspace{-6mm}\songti\fontsize{12pt}{12pt}\selectfont{\today}
414
415 \end{titlepage}
416 }
417 }
418 \group_end:
419 }
420 % \end{macrocode}
421 % \end{macro}
422 %
423 % \begin{macro}{\MakeReviewTable}
424 % 渲染评阅表。
425 % \begin{macrocode}
426 \DeclareDocumentCommand \MakeReviewTable {}
427 {
428 \group_begin:
429 \begin{titlepage}
430 \includepdf[pages=-]{\l_bit_reviewtable_tl}
431 \end{titlepage}
432 \group_end:
433 }
434 % \end{macrocode}
435 % \end{macro}
436 %
437 % 定义 caption 字体为楷体
438 % \begin{macrocode}
439 \DeclareCaptionFont{kaiticaption}{\kaishu \normalsize}
440 % \end{macrocode}
441 %
442 % 设置图片的 caption 格式
443 % \begin{macrocode}
444 \renewcommand{\thefigure}{\thesection-\arabic{figure}}
445 \captionsetup[figure]{font=small,labelsep=space,skip=10bp,labelfont=bf,font=kaiticaption}
446 % \end{macrocode}
447 %
448 % 设置表格的 caption 格式
449 % \begin{macrocode}
450 \renewcommand{\thetable}{\thesection-\arabic{table}}
451 \captionsetup[table]{font=small,labelsep=space,skip=10bp,labelfont=bf,font=kaiticaption}
452 % \end{macrocode}
453 %
454 % 输出大写数字日期
455 % \begin{macrocode}
456 \ctexset{today=big}
457 % \end{macrocode}
458 %
459 % 将西文字体设置为 Times New Roman
460 % \begin{macrocode}
461 \setromanfont{Times~New~Roman}
462 % \end{macrocode}
463 %
464 % 设置文档标题深度
465 % \begin{macrocode}
466 \setcounter{tocdepth}{3}
467 \setcounter{secnumdepth}{3}
468 % \end{macrocode}
469 %
470 % 设置一级标题、二级标题格式。
471 % \begin{macrocode}
472 % 一级标题:小三,宋体,加粗,段前段后各半行。
473 \ctexset{section={
474 format={
475 \raggedright \bfseries \songti \zihao{-3}
476 },
477 beforeskip = 24bp plus 1ex minus .2ex,
478 afterskip = 24bp plus .2ex,
479 fixskip = true,
480 name = {,.\quad}
481 }
482 }
483 % 二级标题:小四,宋体,加粗,段前段后各半行。
484 \ctexset{subsection={
485 format = {
486 \bfseries \songti \raggedright \zihao{4}
487 },
488 beforeskip = 24bp plus 1ex minus .2ex,
489 afterskip = 24bp plus .2ex,
490 fixskip = true,
491 }
492 }
493 % \end{macrocode}
494 %
495 % 页眉和页脚(页码)的格式设定。
496 % \begin{macrocode}
497 \fancyhf{}
498 \int_case:nn {\g_@@_report_type_int} {
499 {1} {
500 \fancyhead[R]{
501 \fontsize{10.5pt}{10.5pt}
502 \selectfont{\l_@@_value_title_tl}
503 }
504 }
505 {2} {
506 \fancyhead[R]{
507 \fontsize{10.5pt}{10.5pt}
508 \selectfont{北京理工大学本科生毕业设计(论文)开题报告}
509 }
510 }
511 }
512 \fancyfoot[R]{\fontsize{9pt}{9pt}\selectfont{\thepage}}
513 \renewcommand{\headrulewidth}{1pt}
514 \renewcommand{\footrulewidth}{0pt}
515 % \end{macrocode}
516 %
517 % 正文开始
518 % \begin{macrocode}
519 \pagestyle{fancy}
520 \setcounter{page}{1}
521 % \end{macrocode}
522 %
523 % \begin{macrocode}
524 % 正文行距 22 磅
525 \cs_set:Npn \baselinestretch {1.53}
526 % 正文首行悬挂 1.02cm
527 % \setlength{\parindent}{1.02cm}
528 % \end{macrocode}