È 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. The stand-alone help system has all the features of the integrated help system, except workbench-integrated context help, the help view, and active help. 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:
-nl fr_FR
si avvia il sistema della guida in francese invece di quello della lingua
specificata dalla locale della macchina.d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar
is on your classpath, where [version]
is the version of the plugin
you're using (e.g. org.eclipse.help.base_3.2.0.jar
). The class you use
to start, launch, and shut down the help system is
org.eclipse.help.standalone.Help
.
String
objects containing options that you want
to pass to help system support. Typically, the eclipsehome
option is
needed.
String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
Help
class by
passing in the options. This object should be held onto until the end of your
application.
Help helpSystem = new Help(options);
helpSystem.start();
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");
Al termine dell'applicazione, per la chiusura del sistema della Guida:
helpSystem.shutdown();
The org.eclipse.help.standalone.Help
class has a main method you can
use to launch stand-alone help from the command line. 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_[version].jar org.eclipse.help.standalone.Help -command displayHelp
from within d:\myApp\eclipse directory, where version
is the plug-in's version. To display a specific TOC file or topic use
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].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_[version].jar org.eclipse.help.standalone.Help -command start
The stand-alone help does not require the entire eclipse Platform package.
It is possible to run the stand-alone help with the RCP Runtime Binary with the
following plug-ins added to the eclipse/plugins
directory):
org.apache.lucene
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.ui
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.ui.forms
Note: You must ensure that the following line is present in the
eclipse/configuration/config.ini
file:
osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start, org.eclipse.core.runtime@start
Some documentation plug-ins may have dependencies on other plug-ins, usually by
specifying required plug-ins in their manifest. The dependent plug-ins need to be
installed as well. Additionally, plug-ins that were designed for earlier than 3.0
version of eclipse implicitly require
org.eclipse.core.runtime.compatibility
plug-in being present to work.
See Product customization for more information on customizing the help system.