这既是一个问题,也是一个针对 LaTeX3 文档的(潜在)建议:
在指定已记录宏的语法时,<description>
用于表示要填写的参数,由 生成\meta{description}
,它是类中的默认宏l3doc
。但是,这些元变量本身并没有像函数本身那样被记录(至少不是全部,也不在中心位置)。
在大多数情况下,这也是不必要的,因为名称非常具有描述性,并且可以通过上下文/宏文档等推断出确切的含义。
然而,至少在某些情况下,这会给我带来困惑,尤其是当代码不起作用并且不确定我是否错误地理解了文档或者我的代码是否不正确时。
具体来说,我想知道到底是什么意思<balanced text>
。
对我来说,乍一看这听起来像文本,即不涉及宏、没有数学模式等。但我认为这在技术上只是意味着任何与{}
参数分组相平衡的标记序列,到目前为止,这种看法已经奏效。这总体上是正确的,还是其中还涉及一些诡计?
再补充一点:是否考虑引入一些元变量的索引,并(简短地)记录它们 - 至少是那些不平凡的变量(无论这意味着什么)。我知道这也需要一些不可忽略的努力,但我相信对于这种情况,这确实会有所帮助。在最好的情况下,这将真正产生一些关于如何形成 LaTeX3 命令(至少是非奇怪的命令等)的抽象语法,但这当然不一定是目标。
反过来想,这也可能是一个很好的查找表,供其他包作者参考如何命名他们的元变量(并参考 LaTeX3 文档)以获得一些独特的风格。