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 в любом описании, и оно будет расширено. Например:

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

id — это любая последовательность букв, цифр и _.