Поиск по содержимому справки выполняется с помощью индекса документации. По умолчанию индекс создается в ходе обработки первого запроса на поиск в справке. Кроме того, допустимо предварительное создание индекса, поставляемого вместе с каждым модулем начиная с версии 3.1 или в качестве полного индекса продукта. Такой подход позволяет избежать выполнения процедуры индексации в локальной системе, а также ускорить обработку первого запроса на поиск.
Для того чтобы создать индекс, выполните следующие действия:
index
в расширение org.eclipse.help.toc
в модуле документации для того чтобы указать каталог, в котором будет находиться индекс, help.buildHelpIndex
для каждого модуля и фрагмента с документацией. Индекс по продуктам - это совокупный индекс всей документации в продукте. Он применяется в сценариях, в которых набор документации модулей не меняется. Например, такой индекс полезен для установки info-center.
Для того чтобы создать индекс, выполните следующие действия:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=каталог-вывода -DindexLocale=локальиз каталога продукта. Укажите следующие аргументы:
Например, команда
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.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
причине файлы модуля
org.eclipse.help.base/productIndex=com.my.plugin