Предварительно созданный индекс документации

Поиск по содержимому справки выполняется с помощью индекса документации.  По умолчанию индекс  создается в ходе обработки первого запроса на поиск в справке. Кроме того, допустимо предварительное создание индекса, поставляемого вместе с каждым модулем начиная с версии 3.1 или в качестве полного индекса продукта.  Такой подход позволяет избежать выполнения процедуры индексации в локальной системе, а также ускорить обработку первого запроса на поиск.

Построение индекса документации для модуля.

Для того чтобы создать индекс, выполните следующие действия:

Создание индекса для продукта

Индекс по продуктам - это совокупный индекс всей документации в продукте. Он применяется в сценариях, в которых набор документации модулей не меняется. Например, такой индекс полезен для установки info-center.

Для того чтобы создать индекс, выполните следующие действия:

Например, команда

eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en

сохранит файл doc_index.zip в подкаталоге nl/en, созданном в каталоге d:/build/com.my.plugin. В этот файл добавляется индекс содержимого документов, доступных пользователям, работающим с локалью en.

Упаковка и установка предварительно созданного индекса продукта

Предварительно созданный индекс (файл doc_index.zip) следует упаковать в качестве модуля. Вы можете использовать модуль, связанный с основным комплектом, либо распределить индексы для различных языков по отдельным фрагментам.

Например, если документация по продукту поставляется на трех языках (например, английском, немецком и китайском (КНР)), модуль com.my.plugin может иметь следующую структуру:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
причине файлы модуля

ИД модуля задается с помощью параметра productIndex модуля org.eclipse.help.base . В случае примера, рассмотренного выше, в файле plugin_customization.ini должна содержаться запись
org.eclipse.help.base/productIndex=com.my.plugin