37.5.2 INDEX文件¶

可选的 INDEX 文件提供包中函数的分类视图。该文件的格式非常简单：

• 以 # 开头的行是注释。
• 第一个非注释行应该如下所示：

  toolbox >> Toolbox name
  

• 以字母字符开头的行表示一个新的函数类别。
• 以空白字符开头的行表示该行中的函数名属于上一个提到的类别。

格式可以用以下示例进行总结：

# A comment
toolbox >> Toolbox name
Category Name 1
 function1 function2 function3
 function4
Category Name 2
 function2 function5

如果您希望引用用户可能在您的包中寻找但不存在的函数，提供替代方案或指出该函数在其他地方可用，您可以使用：

fn = workaround description

当使用 pkg describe 列出包中的函数时，此替代方案描述不会显示，但它会在在线 HTML 文档中发布。替代方案描述可以使用任何 HTML 标记，但请注意，它会被包裹在粗斜体环境中。对于以下特殊情况：

fn = use <code>alternate expression</code>

粗斜体会被自动取消。您需要在引用中也使用 <code>：

fn = use <a href="someothersite.html"><code>fn</code></a>

有时函数只是部分兼容的，在这种情况下，可以单独列出不兼容的情况。若要引用包中的另一个函数，请使用 <f>fn</f>。例如：

eig (a, b) = use <f>qz</f>

由于站点可能有许多缺失的函数，您可以定义一个宏，而不是反复输入相同的链接。

$id = expansion

定义宏 id。您可以在描述的任何位置使用 $id，它会被展开。例如：

$TSA = see <a href="link_to_spctools">SPC Tools</a>
arcov = $TSA <code>armcv</code>

id 是由字母、数字和下划线（_）组成的任意字符串。