AutoIndex работает, читая файл сценария, который сообщает ему, какие термины индексировать.

Если ваш документ содержит в основном текст, и только небольшое количество простого C++, и / или если вы используете Doxygen для предоставления C++ Справочный раздел (в котором перечислены элементы C++) и/или если вы полагаетесь на индексацию, предоставляемую из стандартного индекса кислорода, вы можете решить, что индекс не нужен и что вам может потребоваться индексировать только текстовую часть.

Но если вы хотите, чтобы классы C++ выполняли функции, вводили файлы и/или макросы AutoIndexed, необязательно, файл сценария также сообщает, какие другие файлы C++ сканировать.

Проще говоря, он будет сканировать один или несколько заголовков для терминов, которые должны быть проиндексированы в документации. Например, для сканирования «myheader.hpp» файл сценария будет содержать:

!scan myheader.hpp
!scan mydetailsheader.hpp

Или, что более вероятно, на практике, так что мы можем рекурсивно сканировать через каталоги в поисках всех файлов для сканирования, чье имясоответствует определенному регулярному выражению:

!scan-path "boost/mylibrary" ".*.hpp" true 

Каждый аргумент разделен белым пространством и может быть необязательно заключен в «двойные цитаты» (рекомендуется).

Окончательный аргументистинноуказывает на то, что подкаталоги в</boost/math/mylibrary>следует искать рекурсивно в дополнение к этому каталогу.

	Caution
	Второй аргументfile-name-regexявляется регулярным выражением, а не именем файла GLOB!

	Caution
	Скан-путь модифицируется любыми настройками. Примеры здесь предполагают, что это<<auto-index-prefix>../../..>так, что<boost/mylibrary>будет ваши файлы заголовка,<libs/mylibrary/doc>будет содержать ваши файлы документации и<libs/mylibrary/example>будет содержать ваши примеры.

Вы также можете сканировать любые примеры (.cpp) файлов, как правило, в папке</mylibrary/lib/example>.

# All example source files, assuming no sub-folders.
!scan-path "libs/mylibrary/example" ".*.cpp"

Часто правиласканированияилипути сканированияприводят к слишком большому количеству терминов для поиска, поэтому мы должны иметь возможность также исключить термины:

!exclude type

Что исключает индексацию термина «тип».

Также можно добавить слова вручную:

foobar

будет индексировать случаи «фообар» и:

foobar \<\w*(foo|bar)\w*\>

индексирует любое целое слово, содержащее либо «foo», либо «bar», это полезно, когда вы хотите индексировать много похожих или связанных слов под одной записью, например:

reflex

Проиндексируют только случаи «рефлекса» в целом, но:

reflex \<reflex\w*\>

будут индексировать случаи «рефлексирования», «рефлексирования» и «рефлексирования» под одной и той же записьюрефлекс. Очень часто вам придется использовать это для работы с множественными числами и другими вариантами.

Это правило включения может также ограничить термин определенными разделами и добавить категорию индекса, к которой должен принадлежать термин (поэтому он появляется только в определенных индексах).

Наконец, скрипт может добавлять правила перезаписи, которые переименовывают названия разделов, которые автоматически используются в качестве индексных записей. Например, мы можем удалить ведущие префиксы «A» или «The» из заголовков разделов, когда AutoIndex использует их в качестве записи индекса:

!rewrite-name "(?i)(?:A|The)\s+(.*)" "\1"