Installazione del sistema della Guida come centro informazioni

È possibile consentire agli utenti l'accesso al sistema della Guida su Internet o Intranet mediante l'installazione dei plug-in di documentazione e del centro informazioni su un server Web. I client hanno accesso alla Guida attraverso un URL, quindi il sistema della Guida viene visualizzato nel browser Web. Il sistema della Guida come centro informazioni può essere utilizzato sia per le applicazioni client, sia per le applicazioni Web: entrambe possono fornire accesso remoto alla Guida. Sono supportate tutte le funzioni, eccetto la guida a comparsa e la guida attiva.

Il sistema del centro informazioni consente di trasmettere le opzioni richieste per personalizzare i vari aspetti del centro informazioni. Sono supportate le seguenti opzioni:

Installazione/creazione 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 d:\myApp. Verrà creata in tal modo una sottodirectory eclipse, d:\myApp\eclipse, contenente il codice richiesto per la piattaforma Eclipse (che include il sistema della Guida).

Modalità di avvio e chiusura del centro informazioni da riga comandi

La classe org.eclipse.help.standalone.Infocenter dispone di un metodo principale che può essere utilizzato per avviare il centro informazioni da riga comandi. La sintassi per la riga comandi è:

-command start | shutdown | [-eclipsehome eclipseInstallPath] [-host helpServerHost] [-port helpServerPort] [-servertimeout timeout] [-noexec] [platform options] [-vmargs JavaVMarguments]

Per avviare il centro informazioni sulla porta 8081 immettere il seguente comando di avvio:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\myApp\eclipse -port 8081

Per chiudere il centro informazioni immettere il seguente comando:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse

Utilizzo del centro informazioni

Avviare il server Web. Indicare nel browser Web il percorso dell'applicazione Web della "Guida" in esecuzione sulla porta specificata all'avvio del centro informazioni.  Sul computer in cui è installato il centro informazioni dovrebbe essere http://localhost:8081/help/.

Modalità di avvio e chiusura del centro informazioni da Java

Se il centro informazioni diventa parte di un'altra applicazione, può essere più conveniente avviarlo e arrestarlo utilizzando API Java invece di comandi di sistema. In questo caso, eseguire le seguenti operazioni:

  1. Accertarsi che d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar si trovi nel percorso classi dell'applicazione. La classe utilizzata per avviare e chiudere il centro informazioni è org.eclipse.help.standalone.Infocenter.
  2. Creare una matrice di String che contenga le opzioni da trasmettere al centro informazioni. Di solito, le opzioni eclipsehome e porta sono obbligatorie.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" }; 
  3. Creare, nella propria applicazione, un'istanza della classe Help utilizzando queste opzioni.
    Infocenter infocenter = new Help(options); 
  4. Per avviare il sistema della Guida:
    helpSystem.start();
  5. Per chiudere il centro informazioni:

    helpSystem.shutdown(); 

Disponibilità del centro informazioni nel Web

Eclipse contiene un centro informazioni completo e non richiede altro software su server per l'esecuzione. Tuttavia, in un ambiente non protetto come Internet, si consiglia di non far accedere i client direttamente, ma di rendere disponibile il centro informazioni tramite un server HTTP o un server applicativo. La maggior parte dei server dispongono di moduli o servlet per il trasferimento delle richieste ad altre risorse Web. Ad esempio, è possibile configurare un modulo proxy del server HTTP Apache per trasferire le richieste effettuate verso http://mycompany.com/myproduct/infocenter a http://internalserver:8081/help dove viene eseguito il centro informazioni. Questo si ottiene aggiungendo le righe

LoadModule proxy_module modules/ApacheModuleProxy.dll
ProxyPass /myproduct http://internalserver:8081/help
ProxyPassReverse /myproduct http://internalserver:8081/help
al file conf/httpd.conf del server Apache sul quale è in esecuzione il sito web aziendale.

[Facoltativo] Installazione di un insieme minimo di plug-in

Il centro informazioni non richiede l'intero pacchetto della piattaforma  Eclipse. Il centro informazioni può essere eseguito con i seguenti plug-in (presenti nella directory   eclipse\plugins):

org.apache.lucene
org.apache.xerces
org.eclipse.core.boot
org.eclipse.core.resources
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.update.core

In funzione del sistema operativo o dell'architettura della macchina, oltre a questi plug-in può essere necessario installare anche i corrispondenti frammenti dei plug-in indicati in precedenza (se esistono). Ad esempio, su Windows, è necessario aggiungere i seguenti frammenti (presenti sempre nella directory eclipse\plugins):

org.eclipse.core.resources.win32
org.eclipse.update.core.win32

Copyright IBM Corporation e altri 2000, 2003.