`l3doc` 函数的文档

`l3doc` 函数的文档

通过查阅这里的一些问答,我偶然发现了 MWE这个问题。 那个部分

% \begin{function}{\mymacro}
%   \begin{syntax}
%     \cs{mymacro}\marg{Arg1}
%   \end{syntax}
%  Descriptive text ...
%  ...
% \end{function}

对我来说是新的。我仔细搜索了网络,找到了一些关于这个很酷的新东西的文档。我阅读了expl3.pdfsource3.pdf以及l3styleguide.pdf和2021 TeXLive 系统docstrip.pdfdoc.pdf的 ...... 但没有找到关于这个新功能的详细文档。

我甚至深入研究了source3body.tex。在那里我得到了一些关于如何使用\begin{function}[<options>] ... \end{function}环境的提示。我很惊讶地发现了一个\begin{variable} ... \end{variable}环境。

但是我还没有找到关于如何使用这些新功能的基本 LaTeX 文档。Filel3styleguide.pdf是所需文档后面的文档,但它仍然没有详细记录上面列出的环境。

有没有资料来源?我还没找到?还是说这份详细文档仍然缺失?

答案1

文档位于 中l3doc.dtx,目前尚未排版l3doc.pdf以供一般分发。这主要是因为l3doc这是团队用于记录代码的一套想法expl3,但在很大程度上是一项正在进行的工作,而不是最终的“产品”。

我们最近同意将添加l3doc.pdf到分发版本中,因为尽管会有更改,但这些更改可能要过一段时间才能完成。由于代码会被使用,因此提供一些文档并附上适当的免责声明是有意义的。

相关内容