Wenn ein Benutzer das Inhaltsverzeichnis der Hilfetexte eines Produkts durchsucht, wird die Suche in einem Dokumentationsindex ausgeführt. Dieser Index wird standardmäßig beim ersten Aufruf der Suchfunktion für die Hilfetexte erstellt, kann jedoch auch vorab definiert und dem Benutzer ab Version 3.1 zusammen mit jedem Plug-in oder als vollständiger Index für ein Produkt zur Verfügung gestellt werden. Auf diese Weise wird die Indexierung nicht auf der Benutzermaschine vorgenommen, und der Benutzer erhält die ersten Suchergebnisse schneller.
So erstellen Sie einen Index:
index
zur Erweiterung org.eclipse.help.toc
in einem Dokumentations-Plug-in hinzu, um das Verzeichnis anzugeben, in dem sich der Index befinden wird.help.buildHelpIndex
für jedes Plug-in und jedes Fragment mit Dokumentation ausführen.Ein Pro-Produkt-Index ist ein zusammengefasster Index sämtlicher Dokumentation im Produkt. Er sollte in Szenarien verwendet werden, in denen die Gruppe von Dokumentations-Plug-ins nicht geändert wird. Eine Infocenter-Aufstellung profitiert beispielsweise von einem Pro-Produkt-Index.
So erstellen Sie einen Index:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=LändereinstellungDiesen Befehl müssen Sie in dem Verzeichnis ausführen, in dem sich das Produkt befindet. Die folgenden Argumente müssen unbedingt angegeben werden:
Beispielsweise führt die Ausführung des Befehls
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en
dazu, dass die Datei doc_index.zip im Verzeichnis nl/en gespeichert wird, das unter d:/build/com.my.plugin erstellt wird. Die komprimierte Datei enthält einen Index der Inhalte der Dokumente, die den Benutzern beim Ausführen des Produktes in der en-Ländereinstellung zur Verfügung stehen.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
andere Dateien dieses Plug-ins
org.eclipse.help.base/productIndex=com.my.plugin