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 all'utente con ciascun plugin, dalla versione 3.1, oppure come indice completo per un prodotto.  Questo evita che la creazione dell'indice avvenga sul computer dell'utente e consente all'utente di ottenere i risultati della prima ricerca più rapidamente.

Generazione di un indice di documentazione per un plugin

Per generare un indice eseguire le seguenti operazioni:

Generazione dell'indice per un prodotto

L'indice per prodotto è un indice aggregato di tutta la documentazione del prodotto. Dovrebbe essere utilizzato in scenari nei quali l'insieme dei plugin di documentazione non cambia. Ad esempio, un'installazione del Centro informazioni trae vantaggio dall'indice per prodotto.

Per generare un indice eseguire le seguenti operazioni:

Ad esempio, con il comando

eclipse -nosplash -application org.eclipse.help.base.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.

Assemblaggio e installazione dell'indice pregenerato del prodotto

Gli indici pregenerati, i file doc_index.zip, devono essere preparati in pacchetti come i plugin.   È possibile utilizzare un plugin 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 tre lingue, vale a dire inglese, tedesco e cinese semplificato, un plugin denominato com.my.plugin avrà la seguente struttura:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
altri file del plugin

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