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 zusammen mit einem 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.

Index für ein Produkt erstellen

So erstellen Sie einen Index:

Wenn Sie beispielsweise den Befehl

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

ausführen, wird die Datei doc_index.zip im Verzeichnis nl/en gespeichert, das als Unterverzeichnis von d:/build/com.my.plugin erstellt wird.  Die ZIP-Datei enthält den Index für den Inhalt der Dokumente, die für die Benutzer beim Ausführen des Produkts in der Ländereinstellung en verfügbar sind.

Vordefinierten Index 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 der Primärkomponente zugeordnet ist, oder den Index für jede Sprache in ein separates Fragment packen.

Angenommen, die Dokumentation eines Produkts ist in zwei Sprachen verfügbar (z. B. Englisch und Deutsch). In diesem Fall könnte ein Plug-in namens "com.my.plugin" die folgende Struktur aufweisen:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
andere Dateien in diesem Plug-in

Die ID des Plug-ins muss als Benutzervorgabe productIndex für das Plug-in "org.eclipse.help" angegeben werden.  Beim Plug-in des oben stehenden Beispiels müsste die Datei "plugin_customization.ini" den folgenden Eintrag enthalten:
org.eclipse.help/productIndex=com.my.plugin


Copyright IBM Corporation und Andere 2000, 2003.