Debian Codegraph @

texmf-dist/source/latex/nwafuthesis/nwafuthesis-doc.dtx

raw
1 % \iffalse meta-comment
2 %
3 % Copyright (C) 2017--2024 by Nan Geng <[email protected]>
4 %
5 % This work may be distributed and/or modified under the
6 % conditions of the LaTeX Project Public License, either
7 % version 1.3c of this license or (at your option) any later
8 % version. The latest version of this license is in:
9 %
10 % http://www.latex-project.org/lppl.txt
11 %
12 % and version 1.3 or later is part of all distributions of
13 % LaTeX version 2005/12/01 or later.
14 %
15 % This work has the LPPL maintenance status `maintained'.
16 %
17 % The Current Maintainer of this work is Nan Geng.
18 %
19 % \fi
20 %
21 % \EnableImplementation
22 %
23 % \begin{implementation}
24 %
25 %^^A 代码部分的页边距
26 % \newgeometry{
27 % left = 2.25 in,
28 % right = 1.00 in,
29 % top = 1.25 in,
30 % bottom = 1.00 in,
31 % marginpar = 2.25 in
32 % }
33 %
34 % \subsection{模板文档样式 \cls{nwafudoc}}
35 %
36 % \changes{v0.4}{2017/07/29}{在 \cls{ctxdoc} 的基础上完成 \cls{nwafudoc} 文档类,
37 % 用于模板手册的编写。}
38 %
39 % 编写 \LaTeX{} 宏包文档,传统上会采用 \pkg{doc} 宏包或
40 % \cls{ltxdoc} 文档类。而对于使用 \LaTeX3 开发的宏包,\cls{l3doc}
41 % 文档类将是一个更好的选择。\CTeX{} 宏集所附带的
42 % \href{https://github.com/CTeX-org/ctex-kit/blob/main/tool/ctxdoc.cls}^^A
43 % {\cls{ctxdoc}} 文档类,则在 \cls{l3doc} 的基础上进行了一些修正,
44 % 特别是重新实现了 \env{macrocode} 环境,使之能更好地应用于中文
45 % 文档。\cls{ctxdoc} 的主要功能如下:
46 %
47 % \begin{itemize}
48 % \item 注释使用灰色、倾斜字体,以便与一般代码区分;
49 % \item 模块、名字空间等使用彩色标注,并添加超链接;
50 % \item 自动更新行号宽度;
51 % \item 边注中的长命令使用盒子进行缩放,防止溢出;
52 % \item 修订记录中将显示修改日期;
53 % \item 添加中文支持。
54 % \end{itemize}
55 %
56 % 然而,\cls{ctxdoc} 主要供内部使用,代码较为混乱和随意。
57 % 本模板的文档样式(\cls{nwafudoc})为适应具体需求,对其代码
58 % 进行了整理,添加了相关注释,并做了一些改动:
59 %
60 % \begin{itemize}
61 % \item 允许模块标记 |<*|\meta{module}|>| 和 |</|\meta{module}|>|
62 % 出现在行号左侧;
63 % \item 不再以直立、倾斜字体区分不同嵌套层次的模块;
64 % \item 调整索引中版本号的排序方式;
65 % \item 新增一系列实用命令;
66 % \item 修改文档字体、配色等。
67 % \end{itemize}
68 %
69 % 本文档样式的核心代码主要来自 \cls{ctxdoc} 文档类 v2.4.10。在此,本人要向原
70 % 开发者 \href{https://github.com/CTeX-org/}{CTEX.ORG} 团队表示感谢。
71 %
72 % 以下为 \cls{nwafudoc} 的具体实现。
73 %
74 % \subsubsection{载入宏包、文档类}
75 %
76 % \begin{macrocode}
77 %<*doc>
78 \ExplSyntaxOff
79 % \end{macrocode}
80 %
81 % 无需载入 \pkg{thumbpdf}。
82 % \begin{macrocode}
83 \@namedef{[email protected]}{9999/99/99}
84 % \end{macrocode}
85 %
86 % \changes{v0.8}{2021/10/21}{[\pkg{nwafudoc}] 使用 \pkg{gbt7714} 宏包处理参考文献。}
87 %
88 % 载入宏包和文档类。
89 % \begin{macrocode}
90 \LoadClass[a4paper, full]{l3doc}
91 \RequirePackage[heading, sub3section]{ctex}
92 \RequirePackage[sort&compress]{gbt7714}
93 \RequirePackage{
94 caption,
95 geometry,
96 graphicx,
97 listings,
98 makecell,
99 siunitx,
100 tabularx,
101 threeparttable,
102 unicode-math,
103 xcolor,
104 xcolor-material,
105 xunicode,
106 zref-base
107 }
108 % \end{macrocode}
109 %
110 % \subsubsection{\env{macrocode} 环境}
111 %
112 % \paragraph{继承的代码}
113 %
114 % \begin{macro}[int]{\macro@code}
115 % 在 \pkg{doc} 宏包中,\env{macrocode} 环境的核心功能由命令 \tn{macro@code}
116 % 负责实现,而 \tn{xmacro@code} 只用来结束 \env{macrocode} 环境。但在
117 % \cls{l3doc} 以及 \cls{ctxdoc} 中, \tn{xmacro\-@\-code} 则基本接管了
118 % \tn{macro@code} 的功能。后者此时只起辅助作用。
119 % \begin{macrocode}
120 \def\macro@code{%
121 % \end{macrocode}
122 % 调整前后间距,禁止 \env{macrocode} 环境前的分页。
123 % \begin{macrocode}
124 \topsep \MacrocodeTopsep
125 \@beginparpenalty \predisplaypenalty
126 % \end{macrocode}
127 % 将列表前后的附加垂直空白设为 0。根据 \cls{ctxdoc} 修改。
128 % \begin{macrocode}
129 \partopsep \z@skip
130 % \if@inlabel\leavevmode\fi
131 % \end{macrocode}
132 % 构建 \env{trivlist} 环境,设置段间距为 0。之后修改字体,并调节左右间距。
133 % \tn{MacroIndent} 会根据代码行数更新,具体细节见后文。\tn{macro@font} 用来在
134 % 不同模块见切换字体。本文档类不使用 \tn{AltMacroFont},因此这里改用
135 % \tn{MacroFont} 代替。
136 % \begin{macrocode}
137 \trivlist \parskip \z@ \item[]%
138 % \macro@font
139 \MacroFont
140 \leftskip\@totalleftmargin \advance\leftskip\MacroIndent
141 \rightskip\z@ \parindent\z@ \parfillskip\@flushglue
142 % \end{macrocode}
143 % 按照 \LaTeXe{} 中 \tn{verbatim} 环境中定义 \tn{par},使得空行可以原样输出,
144 % 否则空行会被吃掉。
145 % \begin{macrocode}
146 \blank@linefalse \def\par{\ifblank@line
147 \leavevmode\fi
148 \blank@linetrue\@@par
149 \penalty\interlinepenalty}
150 % \end{macrocode}
151 % \tn{obeylines} 将把回车符 |^^M| 变成 \tn{par}。接下来将所有特殊符号的类别码
152 % 设为 12,即“其他”类。
153 % \begin{macrocode}
154 \obeylines
155 \let\do\do@noligs \verbatim@nolig@list
156 \let\do\@makeother \dospecials
157 % \end{macrocode}
158 % 相当于退出 |\begin{list}| 和 |\begin{minipage}|。
159 % \begin{macrocode}
160 \global\@newlistfalse
161 \global\@minipagefalse
162 % \end{macrocode}
163 % 初始化交叉引用功能。
164 % \begin{macrocode}
165 \init@crossref}
166 % \end{macrocode}
167 % \end{macro}
168 %
169 % \begin{macrocode}
170 %<@@=nwafudoc>
171 \ExplSyntaxOn
172 % \end{macrocode}
173 %
174 % \begin{variable}{\l_@@_tmpa_tl,\l_@@_tmpb_tl}
175 % 临时变量。
176 % \begin{macrocode}
177 \tl_new:N \l_@@_tmpa_tl
178 \tl_new:N \l_@@_tmpb_tl
179 % \end{macrocode}
180 % \end{variable}
181 %
182 % \begin{macro}{\@@_patch_cmd:Nnn,\@@_preto_cmd:Nn,\@@_appto_cmd:Nn}
183 % 补丁工具。
184 % \begin{macrocode}
185 \cs_new_protected:Npn \@@_patch_cmd:Nnn #1#2#3
186 {
187 \ctex_patch_cmd_once:NnnnTF #1 { } {#2} {#3}
188 { } { \ctex_patch_failure:N #1 }
189 }
190 \cs_new_protected:Npn \@@_preto_cmd:Nn #1#2
191 {
192 \ctex_preto_cmd:NnnTF #1 { } {#2}
193 { } { \ctex_patch_failure:N #1 }
194 }
195 \cs_new_protected:Npn \@@_appto_cmd:Nn #1#2
196 {
197 \ctex_appto_cmd:NnnTF #1 { } {#2}
198 { } { \ctex_patch_failure:N #1 }
199 }
200 % \end{macrocode}
201 % \end{macro}
202 %
203 % \paragraph{代码行处理}
204 %
205 % \begin{macro}[int]{\xmacro@code,\sxmacro@code}
206 % 重新实现 \env{macrocode} 与 \env{macrocode*} 环境的核心功能,将对代码逐行
207 % 处理。后者会将空格显示为“\verb*| |”。
208 % \begin{macrocode}
209 \cs_set_protected_nopar:Npn \xmacro@code
210 { \@@_marco_code:w }
211 \cs_set_protected_nopar:Npn \sxmacro@code
212 {
213 \fontspec_print_visible_spaces:
214 \xmacro@code
215 }
216 % \end{macrocode}
217 % \end{macro}
218 %
219 % \begin{macro}{\@@_marco_code:w}
220 % \begin{macrocode}
221 \cs_new_protected_nopar:Npn \@@_marco_code:w
222 {
223 % \end{macrocode}
224 % 根据 \tn{codeline@index} 是否为 |true| 选择是否显示行号。
225 % \begin{macrocode}
226 \ifcodeline@index
227 \@@_marco_code_every_par:n { \@@_code_line_no: }
228 \else:
229 \@@_marco_code_every_par:n { }
230 \fi:
231 % \end{macrocode}
232 % 设置代码段结束标记为“\verb*|% \end{macrocode}^^M|”。
233 % \begin{macrocode}
234 \@@_make_finish_tag:x { \@currenvir }
235 % \end{macrocode}
236 % 开始 \env{macrocode}。
237 % \begin{macrocode}
238 \@@_macro_code_start:w
239 }
240 % \end{macrocode}
241 % \end{macro}
242 %
243 % \begin{macro}{\@@_marco_code_every_par:n}
244 % 在每段之前插入内容。这里每段即相当于每行。
245 % \begin{macrocode}
246 \cs_new_protected:Npn \@@_marco_code_every_par:n #1
247 {
248 \everypar
249 {
250 \everypar {#1}
251 \if@inlabel
252 \global \@inlabelfalse \@noparlistfalse
253 \llap { \box \@labels \hskip \leftskip }
254 \fi
255 #1
256 }
257 }
258 % \end{macrocode}
259 % \end{macro}
260 %
261 % 设置 \tn{endlinechar} 为 $-1$,表示行末不插入任何字符(实际上相当于在行尾
262 % 插入注释符 |%|)。
263 % \begin{macrocode}
264 \group_begin:
265 \int_set:Nn \tex_endlinechar:D { -1 }
266 % \end{macrocode}
267 %
268 % \begin{variable}{\c_@@_active_space_tl}
269 % 活动字符类的空格(ASCII 码为 32)。
270 % \begin{macrocode}
271 \use:n
272 {
273 \char_set_catcode_active:n { 32 }
274 \tl_const:Nn \c_@@_active_space_tl
275 }
276 { }
277 \group_end:
278 % \end{macrocode}
279 % \end{variable}
280 %
281 % ASCII 码 13 是回车符 |^^M|。将其设置为活动字符。
282 % \begin{macrocode}
283 \group_begin:
284 \char_set_catcode_active:n { 13 }
285 % \end{macrocode}
286 %
287 % \begin{macro}{\@@_make_finish_tag:n,\@@_make_finish_tag:x}
288 % \env{macrocode} 结尾标记。展开后变成“\verb*|% \end{#1}^^M|”。
289 % \begin{macrocode}
290 \cs_new_protected:Npx \@@_make_finish_tag:n #1
291 {
292 \tl_set:Nn \exp_not:N \l_@@_macro_code_finish_tl
293 {
294 \c_percent_str
295 \prg_replicate:nn { 4 }
296 { \exp_not:o { \c_@@_active_space_tl } }
297 \exp_not:o { \active@escape@char } end
298 \c_left_brace_str #1 \c_right_brace_str
299 \exp_not:N ^^M
300 }
301 }
302 \cs_generate_variant:Nn \@@_make_finish_tag:n { x }
303 % \end{macrocode}
304 % \end{macro}
305 %
306 % \begin{macro}{\@@_macro_code_start:w}
307 % 开始代码环境。此命令主要是为了防止 |\begin{macrocode}| 后出现多余的空行。
308 % \begin{macrocode}
309 \cs_new_protected:Npn \@@_macro_code_start:w #1
310 {
311 \str_if_eq:nnTF {#1} { ^^M }
312 { \@@_macro_code_read_line:w }
313 { \@@_macro_code_read_line:w #1 }
314 }
315 % \end{macrocode}
316 % \end{macro}
317 %
318 % \begin{macro}{\@@_macro_code_read_line:w}
319 % 逐行读取代码,并连同行尾回车符一并存入 \cs{l_@@_macro_code_line_tl}。如果该行
320 % 与结束标记“\verb*|% \end{macrocode}^^M|”相同,则结束此 \env{macrocode};
321 % 否则继续处理该行代码。
322 % \begin{macrocode}
323 \cs_new_protected:Npn \@@_macro_code_read_line:w #1 ^^M
324 {
325 \tl_set:Nn \l_@@_macro_code_line_tl { #1 ^^M }
326 \tl_if_eq:NNTF
327 \l_@@_macro_code_line_tl \l_@@_macro_code_finish_tl
328 { \exp_args:Nx \end { \@currenvir } }
329 {
330 \@@_macro_code_process_line:
331 \@@_macro_code_read_line:w
332 }
333 }
334 % \end{macrocode}
335 % \end{macro}
336 %
337 % \changes{v0.4}{2017/08/09}{[\pkg{nwafudoc}] 修复 \cls{ctxdoc}
338 % 文档类 v2.4.10 之前版本中行距偏小的问题,见 ctex-kit
339 % \href{https://github.com/CTeX-org/ctex-kit/issues/303}{\#303}。}
340 %
341 % \begin{macro}{\@@_swap_cr:,\@@_swap_cr_aux:w}
342 % 把 \cs{l_@@_macro_code_line_tl} 中的回车符 |^^M| 挪到外面。
343 % \begin{macrocode}
344 \cs_new_protected:Npn \@@_swap_cr:
345 {
346 \exp_after:wN
347 \@@_swap_cr_aux:w \l_@@_macro_code_line_tl
348 }
349 \cs_new_protected:Npn \@@_swap_cr_aux:w #1 ^^M
350 {
351 \group_insert_after:N ^^M
352 \tl_set:Nn \l_@@_macro_code_line_tl {#1}
353 }
354 % \end{macrocode}
355 % \end{macro}
356 %
357 % \begin{variable}{\c_@@_active_cr_tl}
358 % 活动字符类的回车符。
359 % \begin{macrocode}
360 \tl_const:Nn \c_@@_active_cr_tl { ^^M }
361 \group_end:
362 % \end{macrocode}
363 % \end{variable}
364 %
365 % \begin{variable}{\l_@@_macro_code_line_tl,
366 % \l_@@_macro_code_finish_tl,
367 % \g_@@_macro_code_verbatim_stop_tl}
368 % 分别用来存储代码行、\env{macrocode} 结束标记以及抄录停止标记。
369 % \begin{macrocode}
370 \tl_new:N \l_@@_macro_code_line_tl
371 \tl_new:N \l_@@_macro_code_finish_tl
372 \tl_new:N \g_@@_macro_code_verbatim_stop_tl
373 % \end{macrocode}
374 % \end{variable}
375 %
376 % \begin{macro}{\@@_process_normal_line:}
377 % 普通代码行根据开头字符分别处理。
378 % \begin{macrocode}
379 \cs_new_protected_nopar:Npn \@@_process_normal_line:
380 {
381 \str_case_e:nnF
382 { \str_head:N \l_@@_macro_code_line_tl }
383 {
384 % \end{macrocode}
385 % 以 |%| 开头的行先由 \cs{tl_tail:N} 去掉 |%|,之后再检查 |<|。
386 % \begin{macrocode}
387 { \c_percent_str }
388 {
389 \@@_check_angle:x
390 { \tl_tail:N \l_@@_macro_code_line_tl }
391 }
392 % \end{macrocode}
393 % 以 |#| 开头的行按注释的格式输出。
394 % \begin{macrocode}
395 { \c_hash_str }
396 { \@@_output_comment_line: }
397 }
398 % \end{macrocode}
399 % 其余正常输出。
400 % \begin{macrocode}
401 { \@@_output_line: }
402 }
403 % \end{macrocode}
404 % \end{macro}
405 %
406 % \begin{macro}{\@@_process_verbatim_line:}
407 % 处理抄录代码行(不检查 |%| 与 |<|)。
408 % \begin{macrocode}
409 \cs_new_protected_nopar:Npn \@@_process_verbatim_line:
410 {
411 % \end{macrocode}
412 % 将该行与抄录停止标记进行比较。
413 % \begin{macrocode}
414 \tl_if_eq:NNTF \l_@@_macro_code_line_tl
415 \g_@@_macro_code_verbatim_stop_tl
416 % \end{macrocode}
417 % 若相同,则结束抄录环境,清空抄录停止标记,并输出该标记;
418 % \begin{macrocode}
419 {
420 \tl_gclear:N \g_@@_macro_code_verbatim_stop_tl
421 \cs_gset_eq:NN \@@_macro_code_process_line:
422 \@@_process_normal_line:
423 \@@_output_module:nn
424 { \color { verb@guard } }
425 {
426 \@@_swap_cr:
427 \@@_module_pop:n { \l_@@_macro_code_line_tl }
428 }
429 }
430 % \end{macrocode}
431 % 否则直接输出抄录代码。
432 % \begin{macrocode}
433 { \tl_use:N \l_@@_macro_code_line_tl }
434 }
435 % \end{macrocode}
436 % \end{macro}
437 %
438 % \begin{macro}{\@@_macro_code_process_line:}
439 % 处理代码行。该命令的作用如下:
440 % \begin{itemize}
441 % \item 正常情况下,等同于 \cs{@@_process_normal_line:};
442 % \item 在 \cs{DontCheckModules} 之后,等价于 \cs{@@_output_line:},
443 % 即不检查模块标记,直接输出;
444 % \item 在抄录环境中,等价于 \cs{@@_process_verbatim_line:},
445 % 此时将不再特殊处理以 |%| 开头的代码行。
446 % \end{itemize}
447 % \begin{macrocode}
448 \cs_new_eq:NN \@@_macro_code_process_line:
449 \@@_process_normal_line:
450 % \end{macrocode}
451 % \end{macro}
452 %
453 % \paragraph{模块标记处理}
454 %
455 % \begin{macro}{\CheckModules,\DontCheckModules}
456 % 选择是否检查模块标记。这两个命令在 \pkg{doc} 宏包中已有定义,此处重新声明。
457 % \begin{macrocode}
458 \DeclareDocumentCommand \CheckModules { }
459 {
460 \cs_set_eq:NN \@@_macro_code_process_line:
461 \@@_process_normal_line:
462 }
463 \DeclareDocumentCommand \DontCheckModules { }
464 {
465 \cs_set_eq:NN \@@_macro_code_process_line:
466 \@@_output_line:
467 }
468 % \end{macrocode}
469 % \end{macro}
470 %
471 % \begin{macro}{\@@_check_angle:n,\@@_check_angle:x}
472 % 检查第一个字符是否是 |<|。若是,则检查模块;否则立刻输出改行。
473 % 该函数的参数不带 |%|。
474 % \begin{macrocode}
475 \cs_new_protected:Npn \@@_check_angle:n #1
476 {
477 \str_if_eq:eeTF { \str_head:n {#1} } { < }
478 { \@@_check_module:x { \tl_tail:n {#1} } }
479 { \@@_output_comment_line: }
480 }
481 \cs_generate_variant:Nn \@@_check_angle:n { x }
482 % \end{macrocode}
483 % \end{macro}
484 %
485 % \begin{macro}{\@@_check_module:n,\@@_check_module:x}
486 % 检查紧跟 |<| 之后的字符。共有四种情况:
487 % \begin{itemize}
488 % \item |*|:模块开始(|%<*|\meta{module}|>|);
489 % \item |/|:模块结束(|%</|\meta{module}|>|);
490 % \item |@|:名字空间(|%<@@=|\meta{namespace}|>|);
491 % \item |<|:抄录环境开始(|%<<|\meta{end-tag})。
492 % \end{itemize}
493 % 若不是这几种情况,则为单独一行的独立模块(|%<|\meta{module}|>|)。
494 % \begin{macrocode}
495 \cs_new_protected:Npn \@@_check_module:n #1
496 {
497 \str_case_e:nnF { \str_head:n {#1} }
498 {
499 { * } { \@@_module_star:w }
500 { / } { \@@_module_slash:w }
501 { @ } { \@@_module_at:w }
502 { < } { \@@_module_verb:w }
503 }
504 { \@@_module_pm:w }
505 % \end{macrocode}
506 % 参数 |#1| 将被上面几个 |:w| 型函数吃掉。
507 % \begin{macrocode}
508 #1 \q_stop
509 }
510 \cs_generate_variant:Nn \@@_check_module:n { x }
511 % \end{macrocode}
512 % \end{macro}
513 %
514 % 设置 |>| 为活动字符。
515 % \begin{macrocode}
516 \group_begin:
517 \char_set_catcode_active:N \>
518 % \end{macrocode}
519 %
520 % \begin{macro}{\@@_module_star:w}
521 % 模块开始标记。
522 % \begin{arguments}
523 % \item |*|\meta{module}
524 % \item 之后的代码
525 % \end{arguments}
526 % \begin{macrocode}
527 \cs_new_protected:Npn \@@_module_star:w #1 > #2 \q_stop
528 {
529 % \end{macrocode}
530 % 临时变量 \cs{l_@@_tmpa_tl} 保存 |<*|\meta{module}|>| 之后的部分,即真实代码。
531 % \begin{macrocode}
532 \tl_set:Nn \l_@@_tmpa_tl {#2}
533 % \end{macrocode}
534 % 判断该行是否为空(只含一个回车符 |^^M|)。
535 % \begin{macrocode}
536 \tl_if_eq:NNTF \l_@@_tmpa_tl \c_@@_active_cr_tl
537 % \end{macrocode}
538 % 若是,则将 |<|\meta{module}|>| 放在行号的右侧;
539 % \begin{macrocode}
540 {
541 \@@_output_module:nn
542 { \@@_star_color: }
543 {
544 \@@_module_push:n
545 { \@@_module_angle:n {#1} }
546 }
547 }
548 % \end{macrocode}
549 % 否则放在左侧,并输出相应代码。
550 % \begin{macrocode}
551 {
552 \@@_output_module_left:nn
553 { \@@_star_color: }
554 {
555 \@@_module_push:n
556 { \@@_module_angle:n {#1} }
557 }
558 }
559 \@@_output_line:n {#2}
560 }
561 % \end{macrocode}
562 % \end{macro}
563 %
564 % \begin{macro}{\@@_module_slash:w}
565 % 模块结束标记。结构与 \cs{@@_module_star:w} 相同。
566 % \begin{arguments}
567 % \item |/|\meta{module}
568 % \item 之后的代码
569 % \end{arguments}
570 % \begin{macrocode}
571 \cs_new_protected:Npn \@@_module_slash:w #1 > #2 \q_stop
572 {
573 \tl_set:Nn \l_@@_tmpa_tl {#2}
574 \tl_if_eq:NNTF \l_@@_tmpa_tl \c_@@_active_cr_tl
575 {
576 \@@_output_module:nn
577 { \@@_slash_color: }
578 {
579 \@@_module_pop:n
580 { \@@_module_angle:n {#1} }
581 }
582 }
583 {
584 \@@_output_module_left:nn
585 { \@@_slash_color: }
586 {
587 \@@_module_pop:n
588 { \@@_module_angle:n {#1} }
589 }
590 }
591 \@@_output_line:n {#2}
592 }
593 % \end{macrocode}
594 % \end{macro}
595 %
596 % \begin{macro}{\@@_module_at:w}
597 % 名字空间。
598 % \begin{arguments}
599 % \item 名字空间的名称(不含 |@@=|)
600 % \item 之后的代码
601 % \end{arguments}
602 % \begin{macrocode}
603 \cs_new_protected:Npn \@@_module_at:w @ @ = #1 > #2 \q_stop
604 {
605 \@@_output_module:nn
606 { \color { at@guard } }
607 { \@@_module_angle:n { @ @ = #1 } }
608 % \end{macrocode}
609 % 设置名字空间为 |#1|。\cls{l3doc} 中将名字空间称为“模块”(module),
610 % 注意不要混淆。
611 % \begin{macrocode}
612 \tl_gset:Nn \g__codedoc_module_name_tl {#1}
613 \@@_output_line:n {#2}
614 }
615 % \end{macrocode}
616 % \end{macro}
617 %
618 % \begin{macro}{\@@_module_verb:w}
619 % 抄录开始。|#1|: |<|\meta{end-tag},只有一个 |<|。\meta{end-tag} 的最后会
620 % 带有一个回车符 |^^M|。
621 % \begin{macrocode}
622 \cs_new_protected:Npn \@@_module_verb:w #1 \q_stop
623 {
624 % \end{macrocode}
625 % 重定义 \cs{@@_macro_code_process_line:},用以输出抄录行。
626 % \begin{macrocode}
627 \cs_gset_eq:NN \@@_macro_code_process_line:
628 \@@_process_verbatim_line:
629 % \end{macrocode}
630 % 设置抄录停止标记。用 \cs{tl_tail:n} 去掉开头的 |<|。
631 % \begin{macrocode}
632 \tl_gset:Nx \g_@@_macro_code_verbatim_stop_tl
633 { \c_percent_str \tl_tail:n {#1} }
634 % \end{macrocode}
635 % 输出 |%<<|\meta{end-tag}。
636 % \begin{macrocode}
637 \@@_output_module:nn
638 { \color { verb@guard } }
639 {
640 \@@_swap_cr:
641 \@@_module_push:n { \l_@@_macro_code_line_tl }
642 }
643 }
644 % \end{macrocode}
645 % \end{macro}
646 %
647 % \begin{macro}{\@@_module_pm:w}
648 % 处理单独一行的模块。|<|\meta{module}|>| 放在行号的左侧。
649 % \begin{arguments}
650 % \item \meta{module}
651 % \item 之后的代码
652 % \end{arguments}
653 % \begin{macrocode}
654 \cs_new_protected:Npn \@@_module_pm:w #1 > #2 \q_stop
655 {
656 \@@_output_module_left:nn
657 { \@@_pm_color: }
658 { \@@_module_angle:n {#1} }
659 \@@_output_line:n {#2}
660 }
661 \group_end:
662 % \end{macrocode}
663 % \end{macro}
664 %
665 % \begin{macro}{\@@_output_line:n,\@@_output_line:}
666 % 输出代码行。参数将被存入 \cs{l_@@_macro_code_line_tl},
667 % 再由不带参数的版本调用。
668 % \begin{macrocode}
669 \cs_new_protected:Npn \@@_output_line:n #1
670 {
671 \tl_set:Nn \l_@@_macro_code_line_tl {#1}
672 % \end{macrocode}
673 % 若为空行(只含一个 |^^M|),则直接输出(换行)。
674 % \begin{macrocode}
675 \tl_if_eq:NNTF
676 \l_@@_macro_code_line_tl \c_@@_active_cr_tl
677 { \tl_use:N \l_@@_macro_code_line_tl }
678 {
679 % \end{macrocode}
680 % 检查开头是否为 |%|,据此分别处理。
681 % \begin{macrocode}
682 \str_if_eq:eeTF
683 { \str_head:N \l_@@_macro_code_line_tl } { \c_percent_str }
684 { \@@_output_comment_line: } { \@@_output_line: }
685 }
686 }
687 \cs_new_protected_nopar:Npn \@@_output_line:
688 {
689 \tex_noindent:D
690 % \end{macrocode}
691 % 此处将把 |@@| 替换为相应的名字空间。
692 % \begin{macrocode}
693 \@@_replace_at_at:N \l_@@_macro_code_line_tl
694 \tl_use:N \l_@@_macro_code_line_tl
695 }
696 % \end{macrocode}
697 % \end{macro}
698 %
699 % \begin{macro}{\@@_output_comment_line:}
700 % 输出注释代码行。用灰色、斜体显示。
701 % \begin{macrocode}
702 \cs_new_protected:Npn \@@_output_comment_line:
703 {
704 \tex_noindent:D
705 \group_begin:
706 \__nwafudoc_swap_cr:
707 \color { code@gray } \slshape \@@_output_line:
708 \group_end:
709 }
710 % \end{macrocode}
711 % \end{macro}
712 %
713 % \begin{macro}{\@@_replace_at_at:N,
714 % \@@_replace_at_at_aux:Nn,\@@_replace_at_at_aux:No}
715 % 把 |@@| 替换为相应的名字空间。其名称存放在全局变量
716 % \cs{g__codedoc_module_name_tl} 中。它为空时(|%<@@=>|),不做替换。
717 % \begin{macrocode}
718 \cs_new_protected:Npn \@@_replace_at_at:N #1
719 {
720 \tl_if_empty:NF \g__codedoc_module_name_tl
721 { \@@_replace_at_at_aux:No #1 \g__codedoc_module_name_tl }
722 }
723 \cs_new_protected:Npn \@@_replace_at_at_aux:Nn #1#2
724 {
725 % \end{macrocode}
726 % 以下代码分别对应两种名字空间的替换:
727 % \begin{itemize}
728 % \item 内部变量:|\|\meta{type}|_@@_|\meta{name} $\to$
729 % |\|\meta{type}|__|\meta{namespace}|_|\meta{name};
730 % \item 内部函数:|\@@_|\meta{name}” $\to$
731 % |\__|\meta{namespace}|_|\meta{name}”)。
732 % \end{itemize}
733 % \begin{macrocode}
734 \tl_replace_all:Nnn #1 { _ @ @ } { _ _ #2 }
735 \tl_replace_all:Nnn #1 { @ @ } { _ _ #2 }
736 }
737 \cs_generate_variant:Nn \@@_replace_at_at_aux:Nn { No }
738 % \end{macrocode}
739 % \end{macro}
740 %
741 % \begin{macro}{\@@_module_push:n,
742 % \@@_module_push_aux:nn,\@@_module_push_aux:on}
743 % 将模块名压入栈中。此处的栈主要用来处理模块名(包括抄录标记)之间的超链接。
744 % \begin{macrocode}
745 \cs_new_protected_nopar:Npn \@@_module_push:n
746 { \@@_module_push_aux:on { \int_use:N \c@HD@hypercount } }
747 \cs_new_protected:Npn \@@_module_push_aux:nn #1
748 {
749 \seq_gpush:Nn \g_@@_module_dest_seq {#1}
750 \hypersetup { hidelinks }
751 \exp_args:Nx \hdclindex
752 { \zref@extractdefault { HD.#1 } { guard@end } { 1 } } { }
753 }
754 \cs_generate_variant:Nn \@@_module_push_aux:nn { on }
755 % \end{macrocode}
756 % \end{macro}
757 %
758 % \begin{macro}{\@@_module_pop:n,
759 % \@@_module_pop_aux:nn,\@@_module_pop_aux:on}
760 % 将模块名释放出栈。
761 % \begin{macrocode}
762 \cs_new_protected_nopar:Npn \@@_module_pop:n
763 {
764 \seq_gpop:NNTF \g_@@_module_dest_seq \l_@@_tmpa_tl
765 { \@@_module_pop_aux:on { \l_@@_tmpa_tl } }
766 { \BOOM \use:n }
767 }
768 \cs_new_protected:Npn \@@_module_pop_aux:nn #1
769 {
770 \zref@labelbylist { HD.#1 } { nwafudoc }
771 \hypersetup { hidelinks }
772 \hdclindex {#1} { }
773 }
774 \cs_generate_variant:Nn \@@_module_pop_aux:nn { on }
775 % \end{macrocode}
776 % \end{macro}
777 %
778 % \begin{variable}{\g_@@_module_dest_seq}
779 % 存放模块名的序列(栈)。
780 % \begin{macrocode}
781 \seq_new:N \g_@@_module_dest_seq
782 % \end{macrocode}
783 % \end{variable}
784 %
785 % 处理行号超链接。使用 \pkg{zref} 宏包。
786 % \begin{macrocode}
787 \zref@newlist { nwafudoc }
788 \zref@newprop { guard@end } [ 1 ]
789 { \int_eval:n { \c@HD@hypercount - 1 } }
790 \zref@addprop { nwafudoc } { guard@end }
791 % \end{macrocode}
792 %
793 % \paragraph{格式处理}
794 %
795 % \begin{macro}{\MacroFont}
796 % 代码部分的字体。
797 % \begin{macrocode}
798 \cs_set_protected:Npn \MacroFont
799 {
800 \linespread { 1.05 }
801 \small \ttfamily \mdseries \upshape
802 \@@_verb_addon:
803 }
804 % \end{macrocode}
805 % \end{macro}
806 %
807 % \begin{macro}{\@@_output_module:nn,\@@_output_module_left:nn}
808 % 输出模块名(分行内和行号左侧两种)。
809 % \begin{arguments}
810 % \item 颜色等样式
811 % \item 模块名
812 % \end{arguments}
813 % \begin{macrocode}
814 \cs_new_protected:Npn \@@_output_module:nn #1#2
815 {
816 \tex_noindent:D
817 \group_begin:
818 #1
819 \footnotesize \normalfont \sffamily #2
820 \group_end:
821 }
822 \cs_new_protected:Npn \@@_output_module_left:nn #1#2
823 {
824 \tex_noindent:D
825 \hbox_overlap_left:n
826 {
827 \@@_output_module:nn {#1} {#2}
828 \skip_horizontal:n { \leftskip + \smallskipamount }
829 }
830 }
831 % \end{macrocode}
832 % \end{macro}
833 %
834 % \begin{macro}{\@@_star_color:,\@@_slash_color:,\@@_pm_color:}
835 % 选择模块标记的颜色。模块标记的颜色会根据嵌套层次而改变。
836 % \begin{macrocode}
837 \cs_new_protected_nopar:Npn \@@_star_color:
838 {
839 \seq_gpop:NNTF \g_@@_star_color_seq \current@color
840 { \set@color }
841 { \@@_select_color: }
842 \seq_gpush:No \g_@@_slash_color_seq { \current@color }
843 }
844 \cs_new_protected_nopar:Npn \@@_slash_color:
845 {
846 \seq_gpop:NNTF \g_@@_slash_color_seq \current@color
847 {
848 \set@color
849 \seq_gpush:No \g_@@_star_color_seq { \current@color }
850 }
851 % TODO: 需要报错:star 与 slash 没有匹配
852 { \BOOM }
853 }
854 \cs_new_protected_nopar:Npn \@@_pm_color:
855 {
856 \seq_get:NNTF \g_@@_star_color_seq \current@color
857 { \set@color }
858 {
859 \@@_select_color:
860 \seq_gpush:No \g_@@_star_color_seq { \current@color }
861 }
862 }
863 % \end{macrocode}
864 % \end{macro}
865 %
866 % \begin{variable}{\g_@@_star_color_seq,\g_@@_slash_color_seq}
867 % 存放模块标记颜色的序列。
868 % \begin{macrocode}
869 \seq_new:N \g_@@_star_color_seq
870 \seq_new:N \g_@@_slash_color_seq
871 % \end{macrocode}
872 % \end{variable}
873 %
874 % \begin{macro}{\@@_select_color:}
875 % \begin{macro}[int]{guard@series}
876 % 设置模块标记的色系。
877 % \begin{macrocode}
878 \cs_new_protected_nopar:Npn \@@_select_color:
879 { \color { guard@series!!+ } }
880 \definecolorseries { guard@series }
881 { cmyk } { last } { blue } { purple }
882 % \end{macrocode}
883 % \end{macro}
884 % \end{macro}
885 %
886 % 设置色系的增量大小。可选参数 |3| 意味着基色(blue)与末色(purple)之间将被
887 % 等分为三份。该数字比嵌套最大深度小 1。
888 % \begin{macrocode}
889 \resetcolorseries [ 3 ] { guard@series }
890 % \end{macrocode}
891 %
892 % \begin{macro}[int]{verb@guard,at@guard,code@gray}
893 % 设置颜色。
894 % \begin{macrocode}
895 \definecolor { verb@guard } { named } { MaterialLime600 }
896 \definecolor { at@guard } { named } { MaterialPink }
897 \definecolor { code@gray } { named } { MaterialGrey }
898 % \end{macrocode}
899 % \end{macro}
900 %
901 % \begin{macro}{\@@_module_angle:n}
902 % 输出“$\langle\cdots\rangle$”。
903 % \begin{macrocode}
904 \cs_new_protected:Npn \@@_module_angle:n #1
905 { < #1 > }
906 % { \textlangle #1 \textrangle }
907 % { \ensuremath \langle #1 \ensuremath \rangle }
908 % \end{macrocode}
909 % \end{macro}
910 %
911 % \begin{macro}{\@@_code_line_no:}
912 % 行号。设置为阿拉伯数字。
913 % \begin{macrocode}
914 \cs_new_protected_nopar:Npn \@@_code_line_no:
915 {
916 \int_gincr:N \c@CodelineNo
917 \hbox_overlap_left:n
918 {
919 \hbox_to_wd:nn
920 { \MacroIndent }
921 {
922 \HD@target
923 \tex_hss:D \@@_code_line_no_style:
924 \theCodelineNo \enspace
925 }
926 \tex_kern:D \@totalleftmargin
927 }
928 }
929 \tl_set:Nn \theCodelineNo { \arabic { CodelineNo } }
930 % \end{macrocode}
931 % \end{macro}
932 %
933 % \begin{macro}{\@@_code_line_no_style:}
934 % 行号格式。
935 % \begin{macrocode}
936 \cs_new_protected_nopar:Npn \@@_code_line_no_style:
937 { \color { code@gray } \normalfont \sffamily \tiny }
938 % \end{macrocode}
939 % \end{macro}
940 %
941 % \begin{macro}[int]{\HD@SetMacroIndent}
942 % 设置代码缩进(行号一栏的宽度)。该命令会写进 |.aux| 辅助文件,
943 % 以便在二次编译时确定最大行号宽度。
944 % \begin{macrocode}
945 \cs_set_protected:Npn \HD@SetMacroIndent #1
946 {
947 \group_begin:
948 \settowidth \MacroIndent
949 {
950 \@@_code_line_no_style:
951 \prg_replicate:nn { \tl_count:n {#1} } { 0 }
952 \enspace
953 }
954 \dim_gset_eq:NN \MacroIndent \MacroIndent
955 \group_end:
956 }
957 % \end{macrocode}
958 % \end{macro}
959 %
960 % \subsubsection{\env{function} 环境}
961 %
962 % \begin{macro}{\@@_verb_addon:,
963 % \@@_disable_ecglue:,
964 % \@@_plain_punct_style:}
965 % \begin{macro}[int]{\meta@font@select}
966 % 调整文字间距,以便于让 CJK 字符占的宽度等于西文等宽字体中两个空格的宽度。
967 % 需要按编译情况分别定义。
968 % \begin{macrocode}
969 \sys_if_engine_xetex:TF
970 {
971 \cs_set_eq:NN \@@_verb_addon: \xeCJKVerbAddon
972 \cs_set:Nn \@@_plain_punct_style:
973 { \xeCJKsetup { PunctStyle = plain } }
974 \cs_set:Nn \@@_disable_ecglue:
975 { \xeCJKsetup { CJKecglue } }
976 \@@_appto_cmd:Nn \meta@font@select
977 { \mode_if_inner:T { \@@_disable_ecglue: } }
978 }
979 {
980 \cs_set_eq:NN \@@_verb_addon: \prg_do_nothing:
981 \cs_set_eq:NN \@@_plain_punct_style: \prg_do_nothing:
982 \cs_set:Nn \@@_disable_ecglue:
983 { \ltjsetparameter { autoxspacing = false } }
984 \@@_appto_cmd:Nn \meta@font@select
985 { \@@_disable_ecglue: }
986 }
987 % \end{macrocode}
988 % \end{macro}
989 % \end{macro}
990 %
991 % \begin{environment}{function}
992 % \begin{macro}{\@@_fix_previous_depth:}
993 % 调整 \env{function} 环境前后间距。
994 % \begin{macrocode}
995 \BeforeBeginEnvironment { function }
996 { \par \nointerlineskip }
997 \AtEndEnvironment { function }
998 {
999 \par
1000 \cs_gset:Nx \@@_fix_previous_depth:
1001 { \prevdepth = \the \prevdepth \space }
1002 }
1003 \AfterEndEnvironment { function }
1004 { \@@_fix_previous_depth: }
1005 % \end{macrocode}
1006 % \end{macro}
1007 % \end{environment}
1008 %
1009 % \begin{environment}{syntax}
1010 % \begin{environment}{nwafusyntax}
1011 % 在 \env{syntax} 和 \env{nwafusyntax} 环境前设置若干活动字符。\texttt{\textbar}
1012 % 用于分隔多个选项,无需倾斜;|<xxx>| 表示选项,|(xxx)| 表示默认选项。原来的
1013 % 括号用宏保存,并且使用直立字体。\env{syntax} 环境另需要额外调整行距、标点
1014 % 样式及字符间距。
1015 % \begin{macrocode}
1016 \AtBeginEnvironment { syntax }
1017 {
1018 \linespread { 1.2 }
1019 \@@_plain_punct_style:
1020 \@@_disable_ecglue:
1021 % \char_set_catcode_active:N |
1022 % \char_set_catcode_active:N (
1023 % \char_set_active_eq:NN | \orbar
1024 % \char_set_active_eq:NN ( \defaultval@aux
1025 }
1026 \AtBeginEnvironment { nwafusyntax }
1027 {
1028 \cs_set:Npn \lparen { \textup { ( } }
1029 \cs_set:Npn \rparen { \textup { ) } }
1030 \char_set_catcode_active:N |
1031 \char_set_catcode_active:N <
1032 \char_set_catcode_active:N (
1033 \char_set_active_eq:NN | \orbar
1034 \char_set_active_eq:NN < \syntaxopt@aux
1035 \char_set_active_eq:NN ( \defaultval@aux
1036 }
1037 % \end{macrocode}
1038 % \end{environment}
1039 % \end{environment}
1040 %
1041 % \subsubsection{修订记录索引项}
1042 %
1043 % \begin{macro}{\@@_ltx_changes:nnn}
1044 % 保存 \pkg{doc} 中 \tn{changes@} 的定义。
1045 % \begin{macrocode}
1046 \cs_new_eq:NN \@@_ltx_changes:nnn \changes@
1047 % \end{macrocode}
1048 % \end{macro}
1049 %
1050 % \begin{macro}[int]{\changes@}
1051 % \changes{v0.4}{2017/07/30}{[\pkg{nwafudoc}] 调整索引排序方式。}
1052 % 重定义 \tn{changes@},在版本号一行显示修改日期。
1053 % \begin{macrocode}
1054 \cs_set_protected:Npn \changes@ #1#2
1055 {
1056 \@@_save_version_date:nn {#1} {#2}
1057 \@@_ltx_changes:nnn {#1} {#2}
1058 }
1059 % \end{macrocode}
1060 % \end{macro}
1061 %
1062 % \begin{variable}{\g_@@_version_date_prop}
1063 % 存放版本号与对应的修改日期。其中键为版本号,值为 |{开始日期,结束日期}|。
1064 % 开始日期与结束日期可以相同。
1065 % \begin{macrocode}
1066 \prop_new:N \g_@@_version_date_prop
1067 % \end{macrocode}
1068 % \end{variable}
1069 %
1070 % \begin{macro}{\@@_save_version_date:nn}
1071 % |nn| 版本最终将被 \tn{changes@} 调用。
1072 % \begin{arguments}
1073 % \item 版本号
1074 % \item 日期
1075 % \end{arguments}
1076 % 它们分别对应 \tn{change} 的前两个参数(第三个是说明文字)。
1077 % \begin{macrocode}
1078 \cs_new_protected:Npn \@@_save_version_date:nn #1#2
1079 {
1080 \prop_get:NnNTF \g_@@_version_date_prop
1081 {#1} \l_@@_tmpa_tl
1082 {
1083 % \end{macrocode}
1084 % \cs{l_@@_tmpa_tl} 相当于两个参数(开始日期、结束日期),因此需要提前展开。
1085 % \begin{macrocode}
1086 \exp_after:wN
1087 \@@_save_version_date_aux:nnnn \l_@@_tmpa_tl
1088 {#2} {#1}
1089 }
1090 { \@@_save_version_date_aux:nnn {#1} {#2} {#2} }
1091 }
1092 % \end{macrocode}
1093 % \end{macro}
1094 %
1095 % \begin{macro}{\@@_save_version_date_aux:nnnn}
1096 % \begin{arguments}
1097 % \item 原开始日期
1098 % \item 原结束日期(显然应有 |#1| < |#2|)
1099 % \item 新读入的日期
1100 % \item 版本号
1101 % \end{arguments}
1102 % 如果 |#3| < |#1|,则读入日期 |#3|、|#2|;
1103 % 如果 |#3| > |#2|,则读入日期 |#1|、|#3|。
1104 % \begin{macrocode}
1105 \cs_new_protected:Npn \@@_save_version_date_aux:nnnn #1#2#3#4
1106 {
1107 \@@_if_date_later:nnTF {#1} {#3}
1108 { \@@_save_version_date_aux:nnn {#4} {#3} {#2} }
1109 {
1110 \@@_if_date_later:nnT {#3} {#2}
1111 { \@@_save_version_date_aux:nnn {#4} {#1} {#3} }
1112 }
1113 }
1114 % \end{macrocode}
1115 % \end{macro}
1116 %
1117 % \begin{macro}{\@@_save_version_date_aux:nnn}
1118 % 将版本号和日期存入 \cs{g_@@_version_date_prop}。
1119 % \begin{arguments}
1120 % \item 版本号
1121 % \item 开始日期
1122 % \item 结束日期
1123 % \end{arguments}
1124 % \begin{macrocode}
1125 \cs_new_protected:Npn \@@_save_version_date_aux:nnn #1#2#3
1126 { \prop_gput:Nnn \g_@@_version_date_prop {#1} { {#2} {#3} } }
1127 % \end{macrocode}
1128 % \end{macro}
1129 %
1130 % \begin{macro}[TF]{\@@_if_date_later:nn}
1131 % \begin{macro}{\@@_parse_date:w}
1132 % 比较两个日期。如果 |#1| 在 |#2| 之后,则为 |true|;反之为 |false|。
1133 % 日期的格式为 YYYY/MM/DD。比较方法是直接将日期化成 8 位数字,
1134 % 所以月、日前的 0 不可以省略。
1135 % \begin{macrocode}
1136 \prg_new_conditional:Npnn \@@_if_date_later:nn #1#2 { TF, T }
1137 {
1138 \if_int_compare:w
1139 \@@_parse_date:w #1 / / / 0 \q_stop >
1140 \@@_parse_date:w #2 / / / 0 \q_stop \exp_stop_f:
1141 \prg_return_true:
1142 \else:
1143 \prg_return_false:
1144 \fi:
1145 }
1146 \cs_new:Npn \@@_parse_date:w #1/#2/#3/ #4 \q_stop
1147 { #1#2#3 }
1148 % \end{macrocode}
1149 % \end{macro}
1150 % \end{macro}
1151 %
1152 % \begin{macro}[int]{\CTEX@versionitem}
1153 % 版本条目标签。如果版本号不在 \cs{g_@@_version_date_prop} 里面,
1154 % 则利用未定义的 \cs{BOOM} 报错。
1155 % \begin{macrocode}
1156 \cs_new_protected:Npn \CTEX@versionitem #1 \efill
1157 {
1158 \@idxitem
1159 \prop_get:NnNTF \g_@@_version_date_prop
1160 {#1} \l_@@_tmpa_tl
1161 {
1162 \exp_after:wN
1163 \@@_print_version_date:nnn \l_@@_tmpa_tl
1164 {#1}
1165 }
1166 { \BOOM }
1167 }
1168 % \end{macrocode}
1169 % \end{macro}
1170 %
1171 % \begin{macro}{\@@_print_version_date:nnn}
1172 % 输出版本号和日期。如果开始日期和结束日期相同,则只输出一项。
1173 % \begin{arguments}
1174 % \item 开始日期
1175 % \item 结束日期
1176 % \item 版本号
1177 % \end{arguments}
1178 % \begin{macrocode}
1179 \cs_new_protected:Npn \@@_print_version_date:nnn #1#2#3
1180 {
1181 \noindent
1182 \Hy@raisedlink { \belowpdfbookmark {#3} { HD.#3 } }
1183 \textbf {#3} \hfill
1184 \hbox:n
1185 {
1186 \footnotesize
1187 \str_if_eq:nnTF {#1} {#2}
1188 { ( #1 ) } { ( #1 ~ -- ~ #2 ) }
1189 }
1190 \par \nopagebreak
1191 }
1192 % \end{macrocode}
1193 % \end{macro}
1194 %
1195 % \begin{macro}[int]{\HDorg@theglossary}
1196 % 该命令由 \pkg{hypdoc} 宏包定义,用于存放标准文档类 \cls{book} 中定义的
1197 % \tn{theindex} 命令。此处的补丁将在版本号一行最后加上修改日期。
1198 % \begin{macrocode}
1199 \ctex_patch_cmd:Nnn \HDorg@theglossary
1200 { \let \item \@idxitem }
1201 { \let \item \CTEX@versionitem }
1202 % \end{macrocode}
1203 % \end{macro}
1204 %
1205 % \begin{macro}[int]{\@wrglossary}
1206 % 该命令由 \LaTeXe{} 内核定义,又由 \pkg{hypdoc} 宏包作了修改。
1207 % 此处的补丁使得修订记录条目的页码能够指向对应行。
1208 % \begin{macrocode}
1209 \ctex_patch_cmd:Nnn \@wrglossary
1210 { hdpindex }
1211 {
1212 \ifnum \c@HD@hypercount = \z@
1213 hdpindex
1214 \else
1215 hdclindex { \the \c@HD@hypercount }
1216 \fi
1217 }
1218 % \end{macrocode}
1219 % \end{macro}
1220 %
1221 % \subsubsection{命令补丁}
1222 %
1223 % \paragraph{\LaTeXe{} 补丁}
1224 %
1225 % \begin{macro}[int]{\@addtocurcol}
1226 % 调整浮动体、代码等与文字的间距。
1227 % 见 \url{http://tex.stackexchange.com/a/40896}。
1228 % \begin{macrocode}
1229 \ctex_patch_cmd:Nnn \@addtocurcol
1230 { \vskip \intextsep }
1231 {
1232 \edef \save@first@penalty { \the \lastpenalty } \unpenalty
1233 \ifnum \lastpenalty = \@M
1234 \unpenalty
1235 \else
1236 \penalty \save@first@penalty \relax
1237 \fi
1238 \ifnum \outputpenalty < -\@Mii
1239 \addvspace\intextsep
1240 \vskip\parskip
1241 \else
1242 \addvspace\intextsep
1243 \fi
1244 }
1245 \ctex_patch_cmd:Nnn \@addtocurcol
1246 {
1247 \vskip \intextsep
1248 \ifnum \outputpenalty < -\@Mii
1249 \vskip -\parskip
1250 \fi
1251 }
1252 {
1253 \ifnum \outputpenalty < -\@Mii
1254 \aftergroup \vskip \aftergroup \intextsep
1255 \aftergroup \nointerlineskip
1256 \else
1257 \vskip \intextsep
1258 \fi
1259 }
1260 % \end{macrocode}
1261 % \end{macro}
1262 %
1263 % \begin{macro}[int]{\@getpen}
1264 % 将换行或换页的最大罚值由 \num{10000} 改为 \num{10001}。
1265 % \begin{macrocode}
1266 \ctex_patch_cmd:Nnn \@getpen { \@M } { \@Mi }
1267 % \end{macrocode}
1268 % \end{macro}
1269 %
1270 % \begin{macro}[int]{\l@section,\l@subsection}
1271 % 修改目录条目的缩进。
1272 % \begin{macrocode}
1273 \ctex_patch_cmd:Nnn \l@section { 2.5em } { 1.5em }
1274 \ctex_patch_cmd:Nnn \l@subsection { 2.5em } { 1.5em }
1275 % \end{macrocode}
1276 % \end{macro}
1277 %
1278 % \begin{macro}[int]{\@thehead}
1279 % 修改页眉,禁用 \tn{MakeUppercase}。
1280 % \begin{macrocode}
1281 \@@_preto_cmd:Nn \@thehead
1282 { \cs_set_eq:cN { MakeUppercase \space } \@iden }
1283 % \end{macrocode}
1284 % \end{macro}
1285 %
1286 % \begin{macro}{\thebibliography}
1287 % \begin{macro}[int]{\HDorg@thebibliography}
1288 % 参考文献一节需要编号。
1289 % \begin{macrocode}
1290 \ctex_patch_cmd:Nnn \HDorg@thebibliography
1291 { \section* } { \section }
1292 \cs_set_eq:NN \thebibliography \HDorg@thebibliography
1293 % \end{macrocode}
1294 % \end{macro}
1295 % \end{macro}
1296 %
1297 % \begin{macro}{\GlossaryParms}
1298 % 修改修订记录中的一些缩进。
1299 % \begin{macrocode}
1300 \@@_appto_cmd:Nn \GlossaryParms
1301 {
1302 \raggedcolumns
1303 \cs_set_eq:NN \Hy@writebookmark \HDorg@writebookmark
1304 \cs_set:Npn \@idxitem { \par \hangindent 2em }
1305 \cs_set:Npn \subitem { \@idxitem \hspace* { 1em } }
1306 \cs_set:Npn \subsubitem { \@idxitem \hspace* { 2em } }
1307 }
1308 % \end{macrocode}
1309 % \end{macro}
1310 %
1311 % \begin{macro}[int]{\HoLogo@LaTeXe}
1312 % 由于使用了 \pkg{unicode-math},需要额外修改 \pkg{hologo} 中的
1313 % \tn{LaTeXe} 命令,以使粗体正常显示。
1314 % \begin{macrocode}
1315 \ctex_patch_cmd:Nnn \HoLogo@LaTeXe
1316 { \hbox { \HOLOGO@MathSetup 2 $ _{ \textstyle \varepsilon } $ } }
1317 {
1318 \hbox
1319 {
1320 \mathsurround 0pt \relax
1321 2
1322 \if b \expandafter \@car \f@series \@nil
1323 $ _{ \textstyle \symbf { \varepsilon } } $
1324 \else
1325 $ _{ \textstyle \varepsilon } $
1326 \fi
1327 }
1328 }
1329 % \end{macrocode}
1330 % \end{macro}
1331 %
1332 % \changes{v0.9}{2023/02/17}{[\pkg{nwafudoc}] 使用 \pkg{makeindex} 处理索引和修订记录。}
1333 % \changes{v0.9}{2023/02/17}{[\pkg{nwafudoc}] 不再对索引进行汉化。}
1334 %
1335 % \begin{macro}[int]{\NAT@citexnum}
1336 % 将参考文献引用中的 hyphen 改为 en-dash。
1337 % \begin{macrocode}
1338 \ctex_patch_cmd:Nnn \NAT@citexnum
1339 { - \NAT@penalty }
1340 { \textendash \NAT@penalty }
1341 % \end{macrocode}
1342 % \end{macro}
1343 %
1344 % \paragraph{\cls{l3doc} 补丁}
1345 %
1346 % \begin{macrocode}
1347 %<@@=codedoc>
1348 % \end{macrocode}
1349 %
1350 % \begin{macro}{\list}
1351 % \cls{l3doc} 会在列表环境中设置 \kvopt{\tn{listparindent}}{\tn{z@}},
1352 % 这里将其恢复。
1353 % \begin{macrocode}
1354 \cs_set_eq:NN \list \@@_oldlist:nn
1355 % \end{macrocode}
1356 % \end{macro}
1357 %
1358 % \begin{macro}{\@@_function_descr_start:w}
1359 % 抑制首段的 \tn{parskip}。
1360 % \begin{macrocode}
1361 \__nwafudoc_patch_cmd:Nnn \@@_function_descr_start:w
1362 { \noindent }
1363 { \skip_vertical:n { -\parskip } \noindent }
1364 % \end{macrocode}
1365 % \end{macro}
1366 %
1367 % \begin{macro}{\@@_function_assemble:}
1368 % 在 \cls{l3doc} 中,\env{function} 环境里的 \env{syntax} 和 \env{descr} 盒子
1369 % 中间存在一段 \tn{med\-skip\-amount} 的距离。但是如果 \env{syntax} 盒子为空
1370 % (未使用 \env{syntax} 环境),就会显得不好看。此时通过把 \tn{medskipamount}
1371 % 设置为零来修正。若盒子非空,则把 \tn{parskip} 还回去。
1372 % \begin{macrocode}
1373 \__nwafudoc_preto_cmd:Nn \@@_function_assemble:
1374 {
1375 \box_if_empty:NTF \g_@@_syntax_box
1376 { \skip_zero:N \medskipamount }
1377 { \skip_add:Nn \medskipamount { \parskip } }
1378 }
1379 % \end{macrocode}
1380 % \end{macro}
1381 %
1382 % \begin{macro}{\@@_typeset_functions:}
1383 % 调整 \env{function} 环境的字体。
1384 % \begin{macrocode}
1385 \__nwafudoc_patch_cmd:Nnn \@@_typeset_functions:
1386 { \small \ttfamily } { \footnotesize \ttfamily }
1387 % \end{macrocode}
1388 % \end{macro}
1389 %
1390 % \begin{macro}{\@@_typeset_functions:}
1391 % 减少展开标记(用来表明中英文模板中的不同用法)前的空格。
1392 % \begin{macrocode}
1393 \__nwafudoc_patch_cmd:Nnn \@@_typeset_expandability:
1394 { & } { & \skip_horizontal:n { -0.5em } }
1395 % \end{macrocode}
1396 % \end{macro}
1397 %
1398 % \begin{macro}{\@@_typeset_functions:,\@@_macro_init:,
1399 % \@@_macro_dump:}
1400 % 左侧边注的函数列表采用单倍行距。
1401 % \begin{macrocode}
1402 \__nwafudoc_preto_cmd:Nn \@@_typeset_functions:
1403 { \MacroFont }
1404 \__nwafudoc_patch_cmd:Nnn \@@_macro_init:
1405 { \hbox:n } { \MacroFont \hbox:n }
1406 \__nwafudoc_patch_cmd:Nnn \@@_macro_dump:
1407 { \hbox_unpack_drop:N } { \MacroFont \hbox_unpack_drop:N }
1408 % \end{macrocode}
1409 % \end{macro}
1410 %
1411 % \begin{macro}{\@@_meta_original:n}
1412 % 改用文本模式显示尖括号。
1413 % \begin{macrocode}
1414 \__nwafudoc_patch_cmd:Nnn \@@_meta_original:n
1415 { \ensuremath \langle } { \textlangle }
1416 \__nwafudoc_patch_cmd:Nnn \@@_meta_original:n
1417 { \ensuremath \rangle } { \textrangle }
1418 % \end{macrocode}
1419 % \end{macro}
1420 %
1421 % \begin{macro}{\@@_macro_end_style:n}
1422 % 不显示 \env{macro} 环境最后的 “(\emph{End definition for ...})”。
1423 % \begin{macrocode}
1424 \cs_set_eq:NN \@@_macro_end_style:n \use_none:n
1425 % \end{macrocode}
1426 % \end{macro}
1427 %
1428 % \begin{macro}{\@@_typeset_TF:}
1429 % 关闭 |TF| 上的超链接,并且保证颜色与函数主体一致。
1430 % \begin{macrocode}
1431 \cs_set_protected:Npn \@@_typeset_TF:
1432 {
1433 \group_begin:
1434 \exp_args:No \@@_if_macro_internal:nT \l_@@_tmpa_tl
1435 { \color [ gray ] { 0.5 } }
1436 \itshape TF
1437 \makebox [ 0 pt ] [ r ]
1438 {
1439 \color { red }
1440 \underline { \phantom { \itshape TF } \kern -0.1 em }
1441 }
1442 \group_end:
1443 }
1444 % \end{macrocode}
1445 % \end{macro}
1446 %
1447 % \begin{macro}{\@@_macro_typeset_one:nN}
1448 % 在 \env{macro} 环境的侧边栏中,\cls{l3doc} 根据命令的长短,分别用
1449 % 普通字体和紧缩字体输出。然而很长的命令还是会超出页边。这里用缩放
1450 % 盒子的手段使得长命令也可正常显示。
1451 % \begin{macrocode}
1452 \cs_set_protected:Npn \@@_macro_typeset_one:nN #1#2
1453 {
1454 \vbox_set:Nn \l_@@_macro_box
1455 {
1456 \MacroFont
1457 \vbox_unpack_drop:N \l_@@_macro_box
1458 \hbox_set:Nn \l_tmpa_box
1459 { \@@_print_macroname:nN {#1} #2 }
1460 % \end{macrocode}
1461 % \tn{marginparwidth} 和 \tn{marginparsep} 分别是边注的宽度及其到版心的距离,
1462 % \tn{la\-bel\-sep} 则是编号盒子右端与条目首行文本之间的距离。
1463 % \begin{macrocode}
1464 \dim_set:Nn \l_tmpa_dim
1465 { \marginparwidth - \labelsep - \marginparsep }
1466 \dim_compare:nNnT { \box_wd:N \l_tmpa_box } > \l_tmpa_dim
1467 {
1468 \box_resize_to_wd_and_ht:Nnn \l_tmpa_box
1469 { \l_tmpa_dim } { \box_ht:N \l_tmpa_box }
1470 }
1471 \hbox_overlap_left:n
1472 {
1473 \box_use:N \l_tmpa_box
1474 \skip_horizontal:n { \marginparsep - \labelsep }
1475 }
1476 }
1477 \int_incr:N \l_@@_macro_int
1478 }
1479 % \end{macrocode}
1480 % \end{macro}
1481 %
1482 % \begin{macro}{\@@_print_macroname:nN}
1483 % 该函数不再需要根据命令的长短切换字体。
1484 % \begin{macrocode}
1485 \cs_set_protected:Npn \@@_print_macroname:nN #1#2
1486 {
1487 \strut
1488 \@@_get_hyper_target:eN
1489 {
1490 \exp_not:n {#1}
1491 \bool_if:NT #2 { \tl_to_str:n {TF} }
1492 }
1493 \l_@@_tmpa_tl
1494 \cs_if_exist:cTF { r@ \l_@@_tmpa_tl }
1495 { \exp_args:NNo \label@hyperref [ \l_@@_tmpa_tl ] }
1496 { \use:n }
1497 {
1498 \tl_set:Nn \l_@@_tmpa_tl {#1}
1499 % \end{macrocode}
1500 % 命令中的空格改用“\textvisiblespace”显示。
1501 % \begin{macrocode}
1502 \tl_replace_all:NVn \l_@@_tmpa_tl
1503 { \c_catcode_other_space_tl }
1504 { \fontspec_visible_space: }
1505
1506 \tl_set:Nn \l_@@_tmpa_tl {#1}
1507 \tl_replace_all:NVn \l_@@_tmpa_tl
1508 { \c_catcode_other_space_tl }
1509 { \fontspec_visible_space: }
1510 \@@_print_macroname_aux:on
1511 \l_@@_tmpa_tl
1512 { \bool_if:NT \l_@@_macro_TF_bool { \_@@_typeset_TF: } }
1513 }
1514 }
1515 % \end{macrocode}
1516 % \end{macro}
1517 %
1518 % \begin{macro}{\@@_special_index_aux:nnnnnnn}
1519 % 该函数在 \cls{l3doc} 中本来只有 6 个参数。这里增加了一个,用来辅助排序。
1520 % \begin{arguments}
1521 % \item 键(即宏名称字符串,用来排序)
1522 % \item 宏名称
1523 % \item 索引头排序字符串(排序)
1524 % \item 索引头文字
1525 % \item 索引头后缀字符串(排序,新增)
1526 % \item 索引头后缀文字
1527 % \item 索引类型(\opt{main}/\opt{usage} 等)
1528 % \end{arguments}
1529 % \begin{macrocode}
1530 \cs_new_protected:Npn \@@_special_index_aux:nnnnnnn #1#2#3#4#5#6#7
1531 {
1532 \tl_set:Nn \l_@@_index_escaped_key_tl {#1}
1533 \@@_quote_special_char:N \l_@@_index_escaped_key_tl
1534 \@@_special_index_set:Nn
1535 \l_@@_index_escaped_macro_tl {#2}
1536 \str_if_eq:onTF { \@currenvir } { macrocode }
1537 { \codeline@wrindex }
1538 {
1539 \str_case:nnF {#7}
1540 {
1541 { main } { \codeline@wrindex }
1542 { usage } { \index }
1543 }
1544 { \HD@target \index }
1545 }
1546 {
1547 \tl_if_empty:nF { #3 #4 #5 #6 }
1548 { #3 #5 \actualchar #4 #6 \levelchar }
1549 \l_@@_index_escaped_key_tl
1550 \actualchar
1551 {
1552 \token_to_str:N \verbatim@font \c_space_tl
1553 \l_@@_index_escaped_macro_tl
1554 }
1555 \encapchar
1556 hdclindex { \the \c@HD@hypercount } {#7}
1557 }
1558 }
1559 % \end{macrocode}
1560 % \end{macro}
1561 %
1562 % \subsubsection{杂项}
1563 %
1564 % \begin{macro}{\StopSpecialIndexModule,
1565 % \@@_special_index_module:nnnnN}
1566 % 不对 \cs{cs} 和 \cs{tn} 等编索引。用于目录、索引等。
1567 % \begin{macrocode}
1568 \DeclareDocumentCommand \StopSpecialIndexModule { }
1569 {
1570 \cs_set_eq:NN
1571 \@@_special_index_module:nnnnN \use_none:nnnnn
1572 }
1573 \tl_map_inline:nn { \actualchar \encapchar \levelchar }
1574 { \exp_args:Nx \DoNotIndex { \bslash \tl_to_str:N #1 } }
1575 % \end{macrocode}
1576 % \end{macro}
1577 %
1578 % \begin{macro}{\meta}
1579 % 重定义 \cs{meta} 命令,需要禁用中文、西文之间的空格。
1580 % \begin{macrocode}
1581 \RenewDocumentCommand \meta { m }
1582 {
1583 \group_begin:
1584 \sys_if_engine_xetex:T { \xeCJKsetup { CJKecglue = { } } }
1585 \@@_meta:n {#1}
1586 \group_end:
1587 }
1588 % \end{macrocode}
1589 % \end{macro}
1590 %
1591 % 重定向 \cls{l3doc} 中的一些提示信息。
1592 % \begin{macrocode}
1593 \msg_redirect_name:nnn { l3doc } { foreign-internal } { log }
1594 \msg_redirect_name:nnn { l3doc } { print-changes-howto } { log }
1595 \msg_redirect_name:nnn { l3doc } { print-index-howto } { log }
1596 % \end{macrocode}
1597 %
1598 % \begin{macrocode}
1599 %<@@=>
1600 \ExplSyntaxOff
1601 % \end{macrocode}
1602 %
1603 % \subsubsection{排版样式设置}
1604 %
1605 % 目录中禁止对 \cs{cs} 和 \cs{tn} 等的索引。
1606 % \begin{macrocode}
1607 \AtBeginDocument{%
1608 \addtocontents{toc}{\StopSpecialIndexModule}}
1609 % \end{macrocode}
1610 %
1611 % 设置 PDF 字符串中的命令替换。
1612 % \begin{macrocode}
1613 \pdfstringdefDisableCommands{%
1614 \let\path\meta
1615 \let\opt\@firstofone}
1616 % \end{macrocode}
1617 %
1618 % \begin{macro}[int]{\@multitoc@starttoc,\@starttoc}
1619 % 目录分栏,相当于调用 \pkg{multitoc} 宏包。
1620 % \begin{macrocode}
1621 \let\@multitoc@starttoc\@starttoc
1622 \renewcommand*\@starttoc[1]{%
1623 \begin{multicols}{2}%
1624 \@multitoc@starttoc{#1}%
1625 \end{multicols}}
1626 % \end{macrocode}
1627 % \end{macro}
1628 %
1629 % \begin{macro}[int]{\@makefntext}
1630 % 调整脚注文本缩进。
1631 % \begin{macrocode}
1632 \renewcommand\@makefntext[1]{\parindent 0em\noindent\@makefnmark~#1}
1633 % \end{macrocode}
1634 % \end{macro}
1635 %
1636 % \begin{macro}{\IndexLayout,\indexname}
1637 % 调整索引外观。
1638 % \begin{macrocode}
1639 \IndexPrologue{%
1640 \section{\indexname}%
1641 \textit{意大利体的数字表示对应索引项出现的页码;
1642 带下划线的数字表示定义对应索引项的代码行号;
1643 其他则表示使用对应索引项的代码行号。}}
1644 \def\IndexLayout{%
1645 \newgeometry{
1646 left = 0.85 in,
1647 right = 0.85 in,
1648 top = 1.25 in,
1649 bottom = 1.00 in}%
1650 \setlength\IndexMin{0.5\textheight}%
1651 \ctexset{section/numbering=false}%
1652 \StopSpecialIndexModule}
1653 \def\indexname{代码索引}
1654 % \end{macrocode}
1655 % \end{macro}
1656 %
1657 % \begin{macro}{\usage}
1658 % 控制“描述对应索引项的页码”样式。在 \pkg{doc} 宏包中的定义为\tn{textit}。
1659 % \begin{macrocode}
1660 % \def\usage#1{\textsf{#1}}
1661 % \end{macrocode}
1662 % \end{macro}
1663 %
1664 % \begin{macro}{\glossaryname}
1665 % 调整修订记录外观。
1666 % \begin{macrocode}
1667 \GlossaryPrologue{\section{\glossaryname}}
1668 \def\glossaryname{修订记录}
1669 % \end{macrocode}
1670 % \end{macro}
1671 %
1672 % 参考文献使用国标的顺序编码制。
1673 % \begin{macrocode}
1674 \bibliographystyle{gbt7714-numerical}
1675 % \end{macrocode}
1676 %
1677 % \changes{v0.7c}{2019/02/08}{[\pkg{nwafudoc}] 修改宏包手册主要字体。}
1678 % \changes{v0.9}{2023/02/18}{[\pkg{nwafudoc}] 更新宏包手册字体。}
1679 %
1680 % 西文字体。
1681 % \begin{macrocode}
1682 \setmainfont{LibertinusSerif}[
1683 Extension = .otf,
1684 UprightFont = *-Regular,
1685 BoldFont = *-Bold,
1686 ItalicFont = *-Italic,
1687 BoldItalicFont = *-BoldItalic,
1688 Scale = 1.1]
1689 \setsansfont{IBMPlexSansCondensed}[
1690 Extension = .otf,
1691 UprightFont = *-Regular,
1692 BoldFont = *-Bold,
1693 ItalicFont = *-Italic,
1694 BoldItalicFont = *-BoldItalic]
1695 \setmonofont{lmmonolt10}[
1696 Extension = .otf,
1697 UprightFont = *-regular,
1698 BoldFont = *-bold,
1699 ItalicFont = *-oblique,
1700 BoldItalicFont = *-boldoblique]
1701 \setmathfont{LibertinusMath-Regular.otf}
1702 % \end{macrocode}
1703 %
1704 % 中文字体。
1705 % \begin{macrocode}
1706
1707 \setCJKmainfont{Source Han Serif SC}[ % 中文衬线字体,思源宋体
1708 UprightFont = * SemiBold,
1709 BoldFont = * Heavy,
1710 ItalicFont = * Light,
1711 BoldItalicFont = * Medium,
1712 RawFeature = +fwid]
1713 \setCJKsansfont{Source Han Sans SC}[ % 中文无衬线字体,思源宋体
1714 UprightFont = * Medium,
1715 BoldFont = * Heavy,
1716 ItalicFont = * Light,
1717 BoldItalicFont = * Normal,
1718 RawFeature = +fwid]
1719 \setCJKmonofont{Sarasa Mono SC}% 中文等宽字体,Sarasa Mono SC
1720 % \end{macrocode}
1721 %
1722 % 版式排版格式。
1723 % \begin{macrocode}
1724 \ctexset{
1725 section/name = {第,节},
1726 section/format+ = \raggedright,
1727 paragraph/runin = false,
1728 paragraph/numbering = false,
1729 punct = kaiming}
1730 \xeCJKsetwidth{·}{0.5em}
1731 \setcounter{secnumdepth}{4}
1732 \setcounter{tocdepth}{3}
1733 \pagestyle{plain}
1734 % \end{macrocode}
1735 %
1736 % 单位设置(\pkg{siunitx} 宏包)。
1737 % \begin{macrocode}
1738 \sisetup{
1739 inter-unit-product = \ensuremath{{}\cdot{}},
1740 range-phrase = {--},
1741 uncertainty-mode = separate}
1742 % \end{macrocode}
1743 %
1744 % 超链接设置(\pkg{hyperref} 宏包)。
1745 % \begin{macrocode}
1746 \hypersetup{
1747 bookmarksdepth = 4,
1748 bookmarksnumbered = true,
1749 colorlinks = true,
1750 citecolor = MaterialGreen,
1751 linkcolor = MaterialPink,
1752 urlcolor = MaterialIndigo}
1753 % \end{macrocode}
1754 %
1755 % 浮动体标题设置(\pkg{caption} 宏包)。
1756 % \begin{macrocode}
1757 \captionsetup{labelsep=quad, font+=bf}
1758 % \end{macrocode}
1759 %
1760 % 居中且自动延伸的列格式(利用 \pkg{tabularx} 宏包的 |X| 格式扩展)。
1761 % \begin{macrocode}
1762 \newcolumntype{C}{>{\centering\arraybackslash}X}
1763 % \end{macrocode}
1764 %
1765 % 设置标准列表环境样式(\pkg{enumitem} 宏包)。
1766 % \begin{macrocode}
1767 \setlist{noitemsep, topsep=\smallskipamount}
1768 \setlist[1]{labelindent=\parindent}
1769 \setlist[enumerate]{leftmargin=*}
1770 \setlist[itemize]{leftmargin=*}
1771 % \end{macrocode}
1772 %
1773 % \begin{environment}{optdesc}
1774 % 用于描述各选项。设置条目间距为 \tn{marginparsep},与 \cls{l3doc} 一致。
1775 % \begin{macrocode}
1776 \newlist{optdesc}{description}{3}
1777 \setlist[optdesc]{
1778 font = \mdseries\small\ttfamily,
1779 align = right,
1780 listparindent = \parindent,
1781 labelsep = \marginparsep,
1782 labelindent = -\marginparsep,
1783 leftmargin = *}
1784 % \end{macrocode}
1785 % \end{environment}
1786 %
1787 %^^A TODO: \begin{environment}{tablenotes}
1788 % \begin{macro}{tablenotes}
1789 % \begin{macro}[int]{tpt@id}
1790 % 重新定义 \pkg{threeparttable} 包的 \env{tablenotes} 环境,用于表格注释。
1791 % 此处设定为悬挂缩进。
1792 % \begin{macrocode}
1793 \renewlist{tablenotes}{description}{1}
1794 \setlist[tablenotes]{
1795 format = \normalfont\itshape\tnote@item,
1796 labelwidth = 0.5em,
1797 itemindent = 0pt,
1798 rightmargin = \tabcolsep,
1799 leftmargin = \the\dimexpr\tabcolsep+1em\relax,
1800 after = \@noparlisttrue}
1801 \AtBeginEnvironment{tablenotes}{%
1802 \setlength\parindent{2\ccwd}%
1803 \normalfont\footnotesize}
1804 \AtBeginEnvironment{threeparttable}{%
1805 \stepcounter{tpt@id}%
1806 \edef\curr@tpt@id{tpt@\arabic{tpt@id}}}
1807 \newcounter{tpt@id}
1808 % \end{macrocode}
1809 % \end{macro}
1810 % \end{macro}
1811 %
1812 % \begin{macro}[int]{\tnote@item,\TPTtagStyle}
1813 % 为 \tn{tnote} 增加超链接。
1814 % \begin{macrocode}
1815 \def\tnote@item#1{%
1816 \Hy@raisedlink{\hyper@anchor{\curr@tpt@id-#1}}#1}
1817 \def\TPTtagStyle#1{\textit{\hyperlink{\curr@tpt@id-#1}{#1}}}
1818 % \end{macrocode}
1819 % \end{macro}
1820 %
1821 % \begin{macro}{\UrlAlphabet,\UrlDigits}
1822 % 网址断行。\tn{UrlOrds}、\tn{UrlAlphabet} 和 \tn{UrlDigits}
1823 % 分别记录了特殊符号、字母和数字,把它们依次附加在 \pkg{url} 宏包
1824 % 提供的命令 \tn{UrlBreaks} 之后,即可允许在这些位置处断行。与
1825 % \cs{nwafu_allow_url_break:} 的原理是相同的。
1826 % \begin{macrocode}
1827 \def\UrlAlphabet{%
1828 \do\a\do\b\do\c\do\d\do\e\do\f\do\g\do\h\do\i\do\j%
1829 \do\k\do\l\do\m\do\n\do\o\do\p\do\q\do\r\do\s\do\t%
1830 \do\u\do\v\do\w\do\x\do\y\do\z\do\A\do\B\do\C\do\D%
1831 \do\E\do\F\do\G\do\H\do\I\do\J\do\K\do\L\do\M\do\N%
1832 \do\O\do\P\do\Q\do\R\do\S\do\T\do\U\do\V\do\W\do\X%
1833 \do\Y\do\Z}
1834 \def\UrlDigits{%
1835 \do\1\do\2\do\3\do\4\do\5\do\6\do\7\do\8\do\9\do\0}
1836 \g@addto@macro\UrlBreaks{\UrlOrds}
1837 \g@addto@macro\UrlBreaks{\UrlAlphabet}
1838 \g@addto@macro\UrlBreaks{\UrlDigits}
1839 % \end{macrocode}
1840 % \end{macro}
1841 %
1842 % 不对下列各项添加索引。
1843 % \begin{macrocode}
1844 \DoNotIndex{\begin,\end,
1845 \a,\b,\c,\d,\e,\f,\g,\h,\i,\j,\k,\l,\m,
1846 \n,\o,\p,\q,\r,\s,\t,\u,\v,\w,\x,\y,\z,
1847 \A,\B,\C,\D,\E,\F,\G,\H,\I,\J,\K,\L,\M,
1848 \N,\O,\P,\Q,\R,\S,\T,\U,\V,\W,\X,\Y,\Z,
1849 \0,\1,\2,\3,\4,\5,\6,\7,\8,\9}
1850 % \end{macrocode}
1851 %
1852 % 启用索引、交叉引用、历史记录。
1853 % \begin{macrocode}
1854 \EnableCrossrefs
1855 \CodelineIndex
1856 \RecordChanges
1857 % \end{macrocode}
1858 %
1859 % \subsubsection{文档层命令}
1860 %
1861 % \changes{v0.9}{2023/02/18}{[\pkg{nwafudoc}] 调整中英文标记。}
1862 %
1863 % \begin{macro}{\exptarget,\rexptarget,\expstar,\rexpstar,
1864 % \__codedoc_typeset_exp:,\__codedoc_typeset_rexp:}
1865 % 部分命令之后的标记,表明中英文模板中的不同用法。这里的“exp”和“rexp”
1866 % 分别源自 \LaTeX3 中的“expandable”和“restricted-expandable”。
1867 % \begin{macrocode}
1868 \newcommand*\exptarget{\Hy@raisedlink{\hypertarget{expstar}{}}}
1869 \newcommand*\rexptarget{\Hy@raisedlink{\hypertarget{rexpstar}{}}}
1870 \newcommand*\expstar{%
1871 \hyperlink{expstar}{\textsuperscript{\rmfamily\scshape en}}}
1872 \newcommand*\rexpstar{%
1873 \hyperlink{rexpstar}{\textsuperscript{\rmfamily\scshape zh}}}
1874 \ExplSyntaxOn
1875 \cs_set_eq:NN \__codedoc_typeset_exp: \expstar
1876 \cs_set_eq:NN \__codedoc_typeset_rexp: \rexpstar
1877 \ExplSyntaxOff
1878 % \end{macrocode}
1879 % \end{macro}
1880 %
1881 % \begin{macro}{\marg,\oarg,\parg}
1882 % 几种命令参数:
1883 % \begin{itemize}
1884 % \item 必选参数:|{|\meta{arg}|}|;
1885 % \item 可选参数:|[|\meta{arg}|]|;
1886 % \item 图形参数:|(|\meta{arg}|)|。
1887 % \end{itemize}
1888 % \begin{macrocode}
1889 \renewcommand*\marg[1]{\{\meta{#1}\}}
1890 \renewcommand*\oarg[1]{[\meta{#1}]}
1891 \renewcommand*\parg[1]{(\meta{#1})}
1892 % \end{macrocode}
1893 % \end{macro}
1894 %
1895 % \begin{macro}{\opt}
1896 % 选项名。
1897 % \begin{macrocode}
1898 \DeclareDocumentCommand\opt{m}{\texttt{#1}}
1899 % \end{macrocode}
1900 % \end{macro}
1901 %
1902 % \begin{macro}{\kvopt}
1903 % \meta{key} |=| \meta{value} 型选项。
1904 % \begin{macrocode}
1905 \DeclareDocumentCommand\kvopt{mm}
1906 {\texttt{#1\breakablethinspace=\breakablethinspace#2}}
1907 % \end{macrocode}
1908 % \end{macro}
1909 %
1910 % \begin{macro}{\breakablethinspace}
1911 % 允许换行的细间距。
1912 % \begin{macrocode}
1913 \def\breakablethinspace{\hskip 0.16667em\relax}
1914 % \end{macrocode}
1915 % \end{macro}
1916 %
1917 % \begin{macro}{\syntaxopt,\defaultval}
1918 % \begin{macro}[int]{\syntaxopt@aux,\defaultval@aux}
1919 % \env{syntax} 中的选项及命令选项。
1920 % |@aux| 结尾的两个命令用于定义利用 |<>| 和 |()| 的简写形式。
1921 % \begin{macrocode}
1922 \def\syntaxopt#1{\textit{#1}}
1923 \def\defaultval#1{\textbf{\textup{#1}}}
1924 \def\syntaxopt@aux#1>{\syntaxopt{#1}}
1925 \def\defaultval@aux#1){\defaultval{#1}}
1926 % \end{macrocode}
1927 % \end{macro}
1928 % \end{macro}
1929 %
1930 % \begin{macro}{\orbar,\TF,\TTF,\TFF}
1931 % \env{syntax} 中的选项分隔符,以及 \opt{true} 或 \opt{false}
1932 % 选项的几种快捷方式。
1933 % \begin{macrocode}
1934 \def\orbar{\textup{\textbar}}
1935 \def\TF{true\orbar false}
1936 \def\TTF{\defaultval{true}\orbar false}
1937 \def\TFF{true\orbar\defaultval{false}}
1938 % \end{macrocode}
1939 % \end{macro}
1940 %
1941 % \begin{environment}{arguments}
1942 % 放在 \env{macro} 环境中,用于描述对应命令的参数。\cls{l3doc} 中的定义
1943 % \opt{labelsep} 设置不太合理,会使标签被覆盖,这里重新定义。
1944 % \begin{macrocode}
1945 \DeclareDocumentEnvironment{arguments}{}
1946 {\enumerate[label={\texttt{\#\arabic*:~}}, labelsep=0pt, nolistsep]}
1947 {\endenumerate}
1948 % \end{macrocode}
1949 % \end{environment}
1950 %
1951 % \begin{macro}{\TeX,\LaTeX,\LaTeXe,
1952 % \pdfTeX,\pdfLaTeX,\XeTeX,\XeLaTeX,\LuaTeX,\LuaLaTeX,
1953 % \AmSLaTeX,\TeXLive,\MiKTeX,\BibTeX,\biber,\TikZ}
1954 % \TeX{} 相关标志。
1955 % \begin{macrocode}
1956 \def\TeX{\hologo{TeX}}
1957 \def\LaTeX{\hologo{LaTeX}}
1958 \def\LaTeXe{\hologo{LaTeXe}}
1959 \def\pdfTeX{\hologo{pdfTeX}}
1960 \def\pdfLaTeX{\hologo{pdfLaTeX}}
1961 \def\XeTeX{\hologo{XeTeX}}
1962 \def\XeLaTeX{\hologo{XeLaTeX}}
1963 \def\LuaTeX{\hologo{LuaTeX}}
1964 \def\LuaLaTeX{\hologo{LuaLaTeX}}
1965 \def\AmSLaTeX{\hologo{AmSLaTeX}}
1966 \def\TeXLive{\TeX\ Live}
1967 \def\MiKTeX{\hologo{MiKTeX}}
1968 \def\BibTeX{\hologo{BibTeX}}
1969 \def\biber{\hologo{biber}}
1970 % \end{macrocode}
1971 % 该定义来自 \file{pgfmanual-en-macros.tex}。
1972 % \begin{macrocode}
1973 \def\TikZ{Ti\emph{k}Z}
1974 % \end{macrocode}
1975 % \end{macro}
1976 %
1977 % \changes{v0.9}{2023/02/17}{[\pkg{nwafudoc}] 移除多余的文档层定义。}
1978 %
1979 % \paragraph{示例代码环境}
1980 %
1981 % \pkg{listings} 宏包中连字符 |-| 原本以数学模式输出,此处改为普通文本。
1982 % 见 \url{https://tex.stackexchange.com/a/33188}。
1983 % \begin{macrocode}
1984 \lst@CCPutMacro\lst@ProcessOther{"2D}{\lst@ttfamily{-{}}{-{}}}
1985 \@empty\z@\@empty
1986 % \end{macrocode}
1987 %
1988 % \changes{v0.5}{2017/09/05}{[\pkg{nwafudoc}] 移除 \pkg{listings} 关键词定义文件。}
1989 %
1990 % 定义几种代码样式。
1991 % \begin{macro}[int]{style@base}
1992 % \begin{macrocode}
1993 \lstdefinestyle{style@base}{
1994 basewidth = 0.525 em,
1995 gobble = 3,
1996 lineskip = 2 pt,
1997 frame = l,
1998 framerule = 1 pt,
1999 framesep = 0 pt,
2000 escapeinside = {(*}{*)},
2001 basicstyle = \small\ttfamily\color{MaterialGrey900},
2002 keywordstyle = \bfseries\color{MaterialIndigo},
2003 commentstyle = \itshape\color{MaterialGrey600},
2004 stringstyle = \color{MaterialRed},
2005 backgroundcolor = \color{MaterialGrey50}
2006 }
2007 % \end{macrocode}
2008 % \end{macro}
2009 %
2010 % \begin{macro}[int]{style@shell}
2011 % \begin{macrocode}
2012 \lstdefinestyle{style@shell}{
2013 style = style@base,
2014 rulecolor = \color{MaterialPink},
2015 language = bash,
2016 alsoletter = {-},
2017 emphstyle = \color{MaterialGreen800}
2018 }
2019 % \end{macrocode}
2020 % \end{macro}
2021 %
2022 % \begin{macro}[int]{style@latex}
2023 % \begin{macrocode}
2024 \lstdefinestyle{style@latex}{
2025 style = style@base,
2026 rulecolor = \color{MaterialIndigo},
2027 language = [LaTeX]TeX,
2028 alsoletter = {*, -},
2029 texcsstyle = *\color{MaterialDeepOrange},
2030 emphstyle = [1]\color{MaterialGreen800},
2031 emphstyle = [2]\color{MaterialTeal}
2032 }
2033 % \end{macrocode}
2034 % \end{macro}
2035 %
2036 % \begin{macro}[int]{style@syntax}
2037 % \begin{macrocode}
2038 \lstdefinestyle{style@syntax}{
2039 basewidth = 0.525 em,
2040 gobble = 6,
2041 escapeinside = {(*}{*)},
2042 language = [LaTeX]TeX,
2043 alsoletter = {*, -},
2044 basicstyle = \footnotesize\ttfamily\color{MaterialGrey900},
2045 keywordstyle = \bfseries\color{MaterialIndigo},
2046 commentstyle = \itshape\color{MaterialGrey600},
2047 texcsstyle = *\color{MaterialDeepOrange},
2048 emphstyle = [1]\color{MaterialGreen800},
2049 emphstyle = [2]\color{MaterialTeal}
2050 }
2051 % \end{macrocode}
2052 % \end{macro}
2053 %
2054 % \begin{environment}{shellexample}
2055 % \begin{environment}{latexexample}
2056 % Shell 和 \LaTeX{} 示例代码。
2057 % \begin{macrocode}
2058 \lstnewenvironment{shellexample}[1][]{%
2059 \lstset{style=style@shell, #1}}{}
2060 \lstnewenvironment{latexexample}[1][]{%
2061 \lstset{style=style@latex, #1}}{}
2062 % \end{macrocode}
2063 % \end{environment}
2064 % \end{environment}
2065 %
2066 % \begin{environment}{nwafusyntax}
2067 % 语法说明。用于代替 \cls{l3doc} 中的 \env{syntax} 环境。
2068 % \begin{macrocode}
2069 \lstnewenvironment{nwafusyntax}[1][]{%
2070 \lstset{style=style@syntax, #1}\vspace{-1.8ex}}{}
2071 %</doc>
2072 % \end{macrocode}
2073 % \end{environment}
2074 %
2075 % \changes{v0.7c}{2019/03/15}{不再附带 \pkg{latexmk} 配置文件。}
2076 %
2077 % \clearpage
2078 %
2079 % \end{implementation}
2080 %