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