37.4.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 — это любая строка, состоящая из букв, цифр и _.