☰

软件包文档中的宏的词汇表列表

tag-icon • tag-icon glossaries documentation definition
软件包文档中的宏的词汇表列表

我花了几个小时寻找应该是常见的 TeX 知识，但一无所获。我可能只是不知道进行有效搜索的正确搜索词，所以我觉得值得一问。

我想记录我用 LaTeX 编写的一些宏（例如\foo{}和bar{}{}）。我以前读过几份 CTAN 文档 PDF，似乎有一种流行的格式化包提供的宏的方法：将宏名称（\texttt 样式）移到左边距，将说明性段落放在右边。我在下面放了一个来自包文档的示例xcolor。

xcolor 文档

此外，类似的软件包对mdframed这种类似词汇表的列表的格式化方式进行了稍微的改变（例如彩色）（还请注意宏名称行右对齐的默认值）：

mdframed 文档

我想要使​​用的样式是 使用的样式macros2e，如下所示：我喜欢颜色、风格化的参数和框架。现在，macros2e找到了的来源这里；但是，据我推断，我想要使用的样式是通过\Macro或调用的\DescribeMacro，但作为初学者，我无法弄清楚它们是如何定义的。

macros2e 文档

上面的三个例子都是类似词汇表的（我怀疑它们是否是使用词汇表生成的），所以我假设它们都是单一标准环境或其他结构的风格变体。那标准是什么？

据我所知这社区 wiki 帖子的最佳答案，我可能正在查看一种称为“样式”文件的东西，但那是另一回事——对初学者来说不是特别友好。我想说的是，目前缺乏集中、最小、直接的示例（以简单的正确 LaTeX 编写）来说明如何编写此类文档。

答案1

macros2e使用手册ydoc-desc：

\documentclass{article}
\usepackage{lipsum}
\usepackage{ydoc-desc}

\begin{document}
\DescribeMacro\foo{<macro arguments>}
\lipsum[1]

\DescribeMacro\bar{<macro arguments>}
\lipsum[2]
\end{document}

在此处输入图片描述

您可以在这里找到文档：https://ctan.org/pkg/ydoc

相关内容