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.
Per generare un indice eseguire le seguenti operazioni:
index
all'estensione org.eclipse.help.toc
in un
plugin di documentazione, per specificare la directory in cui si troverà l'indice,help.buildHelpIndex
per ciascun plugin e frammento con documentazione.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:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localedalla directory che contiene il prodotto. È necessario impostare i seguenti argomenti:
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.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
altri file del plugin
org.eclipse.help.base/productIndex=com.my.plugin