Installazione del sistema autonomo della guida

È possibile utilizzare il sistema della Guida di Eclipse anche se si sta creando un'applicazione che non si basa sul framework di Eclipse. L'applicazione può comprimere e installare il sistema autonomo della Guida, una versione molto ridotta di Eclipse che dispone di tutto eccetto che del sistema della Guida che ne è stato estratto. Quindi l'applicazione può effettuare chiamate API dal menu ? o dagli oggetti di interfaccia utente e avviare il browser della Guida. Il sistema autonomo della Guida dispone di tutte le funzioni del sistema della Guida integrata, eccetto la guida a comparsa e la guida attiva. Quando un'applicazione non è basata su Java, oppure se è necessaria la guida quando l'applicazione non è in esecuzione, è possibile utilizzare una guida indipendente da una shell di sistema, uno script shell oppure un collegamento al desktop, e fornire le opzioni della riga comandi invece di richiamare le API Java.

Il sistema di guida indipendente consente di trasmettere le opzioni richieste per personalizzare vari aspetti del sistema della guida. Sono supportate le seguenti opzioni:

Installazione/creazione di pacchetti

Questa procedura è destinata all'esperto di integrazione del sistema della Guida e non prevede di ricoprire tutti i possibili scenari. Si presuppone che tutta la documentazione venga recapitata come plug-in di Eclipse e che, generalmente, si abbia familiarità con il sistema della Guida di Eclipse.
  1. Scaricare il driver binario di run-time della piattaforma Eclipse da www.eclipse.org.
  2. Installare (decomprimere) il driver nella directory dell'applicazione, ad esempio, d:\myApp. Verrà creata in tal modo una sottodirectory di Eclipse, d:\myApp\eclipse, contenente il codice richiesto per la piattaforma Eclipse (che include il sistema della Guida).

Modalità di richiamo delle classi Help da Java

  1. Verificare che d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar si trovi nel percorso classi dell'applicazione. La classe utilizzata per avviare, aprire e chiudere il sistema della Guida è org.eclipse.help.standalone.Help.
  2. Creare una matrice di String che contenga le opzioni da trasmettere al sistema della guida. Di solito, l'opzione eclipsehome è obbligatoria.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" }; 
  3. Creare, nella propria applicazione, un'istanza della classe Help alla quale trasmettere le opzioni. È consigliabile mantenere questo oggetto fino al termine dell'applicazione.
    Help helpSystem = new Help(options); 
  4. Per avviare il sistema della Guida:
    helpSystem.start(); 
  5. Per richiamare la Guida all'occorrenza:
    helpSystem.displayHelp(); 

    È inoltre possibile richiamare la Guida relativamente a specifici file del Sommario o argomenti principali:

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. Per avviare la Guida sensibile al contesto richiamare helpSystem.displayContext(contextId, x, y), dove contextId corrisponde a un id contesto completo. Le coordinate dello schermo, x e y,non vengono correntemente utilizzate.
  7. Al termine dell'applicazione, per la chiusura del sistema della Guida:

    helpSystem.shutdown(); 

Modalità di richiamo della guida da riga comandi

La classe org.eclipse.help.standalone.Help dispone di un metodo principale che può essere utilizzato per avviare una guida indipendente dalla riga comandi. La sintassi per la riga comandi è:

-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]

Un modo semplice per visualizzare la guida consiste nel richiamare

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp

dalla directory d:\myApp\eclipse. Per visualizzare file TOC o argomenti specifici utilizzare

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm

In questo caso il sistema della guida verrà avviato, effettuerà la visualizzazione e resterà attivo per consentire all'utente di continuare a consultare la guida dopo l'esecuzione del comando. Per controllare la durata dell'esecuzione del sistema di guida, utilizzare i comandi start e shutdown, con il comando displayHelp. Ad esempio, è possibile richiamare

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command start

[Facoltativo] Installazione di un insieme minimo di plugin

La guida autonoma non richiede l'intero pacchetto della piattaforma  Eclipse. La guida autonoma può essere eseguita con i seguenti plugin (presenti nella directory   eclipse\plugins):

org.apache.lucene
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.webapp
org.eclipse.osgi
org.eclipse.tomcat
org.eclipse.update.configurator

Su Windows e Linux, in aggiunta alla configurazione minima, sono necessari i plugin e frammenti indicati di seguito per fornire un valido supporto del browser (un browser Internet Explorer su Windows e Mozilla su Linux SWT-incorporato o un browser di un sistema autonomo su Windows).

org.eclipse.core.expressions
org.eclipse.help.ui
org.eclipse.jface
org.eclipse.swt
org.eclipse.swt.win32 or org.eclipse.swt.gtk
org.eclipse.ui
org.eclipse.ui.workbench

Alcuni plugin di documentazione possono presentare dipendenze da altri plugin, generalmente i plugin richiesti sono specificati in plugin.xml. I plugin dipendenti devono essere installati anche nel centro informazioni. Inoltre, i plugin indicati come precedenti alla versione 3.0 di Eclipse, richiedono implicitamente la presenza di org.eclipse.core.runtime.compatibility.

Vedere Preferenze del sistema della Guida per ulteriori informazioni sulla personalizzazione del sistema della Guida.

Preferenze org.eclipse.help.base