Indice di documentazione pregenerato

Quando un utente effettua una ricerca sul contenuto della guida di un prodotto, la ricerca viene eseguita nell'indice di documentazione.  Per impostazione predefinita, questo indice  viene creato la prima volta che viene eseguita una ricerca nella guida, ma può anche essere pregenerato e distribuito insieme al prodotto.  Questo evita che la creazione dell'indice sul computer dell'utente e consente di ottenere i risultati della prima ricerca più rapidamente.

Generazione dell'indice per il prodotto

Per generare un indice eseguire le seguenti operazioni:

Ad esempio, con il comando

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

il file doc_index.zip sarà salvato nella directory nl/en creata sotto d:/build/com.my.plugin.  Il file zip conterrà l'indice dei documenti disponibili per gli utenti che eseguono il prodotto nella locale en.

Creazione pacchetti e installazione dell'indice pregenerato

Gli indici pregenerati, i file doc_index.zip, devono essere preparati in pacchetti come i plug-in.   È possibile utilizzare un plug-in associato alla funzione principale, oppure creare un pacchetto per ciascun indice relativo ad una lingua in frammenti separati.

Ad esempio, se la documentazione del prodotto è disponibile in due lingue, ad esempio inglese e tedesco, un plug-in denominato com.my.plugin avrà la seguente struttura:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
altri file del plug-in

L'ID del plug-in deve essere specificato come preferenza productIndex per org.eclipse.help plugin.  Per il plug-in dell'esempio precedente, il file plugin_customization.ini deve contenere la voce
org.eclipse.help/productIndex=com.my.plugin


Copyright IBM Corporation e altri 2000, 2003.