Skip to content

Commit 6c66799

Browse files
docs: 更新开发文档
- 删除了`bithesis.dtx`中不匹配的`\begin{macro}`(1be9eb7 引入) - 介绍 DocStrip。
1 parent 5497443 commit 6c66799

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

DEVELOPMENT.md

+23
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,29 @@
4242
>
4343
> 如果要添加新命令,可以先在 `templates/` 中具体实现,再拷贝到 `bithesis.dtx`
4444
45+
> [!NOTE]
46+
>
47+
> 文档有两部分。
48+
>
49+
> - `bithesis-doc.tex`面向最终使用者,对应手册`bithesis.pdf`大部分内容。
50+
> - `bithesis.dtx`中的注释面向开发者。
51+
>
52+
> <details>
53+
> <summary>注释中为何有 LaTeX 代码?</summary>
54+
>
55+
> `bithesis.dtx`最顶层的注释包含 LaTeX 代码,可输出为手册结尾「实现细节」一节;不过默认不输出,一般也无需单独检查输出结果。
56+
>
57+
> 如需输出,请如下编辑`bithesis.dtx``\jobname`的值是`bithesis``\filename`的值是`bithesis.dtx`),然后照常编译手册。
58+
>
59+
> ```diff
60+
> \begin{document}
61+
> - \DocInput{\jobname-doc.tex}
62+
> + \DocInput{\jobname-doc.tex,\filename}
63+
> ```
64+
>
65+
> 相关功能的文档位于 [DocStrip](https://texdoc.org/serve/docstrip/0) 和 [l3doc](https://texdoc.org/serve/l3doc/0)。
66+
> </details>
67+
4568
## 参考资料
4669
4770
- 本项目采用 LaTeX3,可以参考 [LaTeX3: Programming in LaTeX with Ease](https://www.alanshawn.com/tech/2020/10/04/latex3-tutorial.html)、[expl3 的文档](https://www.latex-project.org/help/documentation/)等。

bithesis.dtx

-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@
4040
%</driver>
4141
% \fi
4242
%
43-
% \begin{macro}
4443
% \section{实现细节}
4544
%
4645
% \begin{macrocode}

0 commit comments

Comments
 (0)