Installazione del sistema autonomo della guida
E' possibile utilizzare il sistema della Guida di Eclipse anche se si
sta creando un'applicazione che non si basa sulla struttura di
Eclipse. L'applicazione può comprimere e installare il sistema autonomo
della Guida, una versione molto ridotta di Eclipse che disponeva 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 infopop e Guida attiva.
Installazione/compressione
Questa procedura è destinata all'esperto di integrazione del sistema
della Guida e non prevede di ricoprire tutti i possibili scenari. Si
presuppone che l'applicazione di avvio si trovi in Java, che tutta la
documentazione venga recapitata come plug-in di
Eclipse e che, generalmente, si abbia familiarità con il sistema della
Guida di Eclipse.
- Scaricare il driver binario di run-time della piattaforma
relativa al livello della Versione 2.0 di Eclipse da www.eclipse.org.
- 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
- Accertarsi che
d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.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.
- Creare, nella propria applicazione, un'istanza della classe Help
mediante passaggio?? della directory dei plug-in. E' consigliabile
mantenere questo oggetto fino al termine dell'applicazione.
Help helpSystem = new Help("d:\\myApp\\eclipse\\plugins");
- Per avviare il sistema della Guida:
helpSystem.start();
Al termine dell'applicazione, per la chiusura del sistema della Guida:
helpSystem.shutdown();
- Per richiamare la Guida all'occorrenza:
helpSystem.displayHelp();
E' inoltre possibile richiamare la Guida relativamente a specifici
file TOC o argomenti principali:
helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
- 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.
Verifica della Guida autonoma
La classe org.eclipse.help.standalone.Help dispone di un semplice
programma principale che è possibile avviare per rendersi conto delle
modalità di funzionamento della Guida autonoma per un ulteriore utilizzo??. Da
una riga di comando eseguire il comando riportato di seguito:
java - percorso classi d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar
org.eclipse.help.standalone.Help d:\myApp\eclipse\plugins