37.4.2 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是从字母、数字和_.