Vordefinierter Dokumentationsindex

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.

Dokumentationsindex für ein Plug-in erstellen.

So erstellen Sie einen Index:

Index für ein Produkt erstellen

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:

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.

Vordefinierten Index des Pakets packen und installieren

Vordefinierte Indizes (Dateien doc_index.zip) müssen als Plug-in gepackt werden.   Sie können entweder ein Plug-in verwenden, das einem Hauptfeature zugeordnet ist, oder den Index für jede Sprache in separate Fragmente packen.

Falls die Dokumentation eines Produktes beispielsweise in drei Sprachen verfügbar ist, z. B. Englisch, Deutsch und vereinfachtes Chinesisch, kann ein com.my.plugin-Plug-in die folgende Struktur haben:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
andere Dateien dieses Plug-ins

Die ID des Plug-ins muss als eine productIndex-Benutzervorgabe für das Plug-in org.eclipse.help.base angegeben werden. Für das Plug-in im vorstehenden Beispiel muss die Datei 'plugin_customization.ini' den folgenden Eintrag enthalten:
org.eclipse.help.base/productIndex=com.my.plugin