37.4.2 INDEX ファイル
オプションの索引ファイルはパッケージ内の関数のカテゴリ別ビューを提供します。このファイルは非常にシンプルな形式です
'で始まる行#' はコメントです。
最初の非コメント行は次のようになります
ツールボックス >> ツールボックス名
アルファベット文字で始まる行は、関数の新しいカテゴリを示します。
空白文字で始まる行は、その行の関数名が最後に記載されたカテゴリに属していることを示します。
形式は次の例で要約できます。
A comment toolbox >> Toolbox name Category Name 1
function1 function2 function3 function4
ユーザーがパッケージ内に存在すると期待しているが存在しない関数を参照し、回避策を提供したり、その関数が他の場所で使用可能であることを指摘したりする場合は、次のように使用できます。
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 は文字、数字、および_. の任意の文字列です。