Voit käyttää Eclipse-ohjejärjestelmää, vaikka luomasi sovellus ei perustuisikaan Eclipse-järjestelmään. Sinun sovelluksesi voi paketoida ja asentaa erillisohjejärjestelmän, hyvin pienen Eclipse-version, josta on riisuttu kaikki lukuun ottamatta ohjejärjestelmää. Silloin sovelluksesi voi tehdä ohjelmointirajapintakutsuja ohjevalikostaan tai käyttöliittymän objekteista ohjeselaimen käynnistystä varten. Erillisohjejärjestelmässä on kaikki sisäisen ohjejärjestelmän tuoteominaisuudet lukuun ottamatta työympäristöön integroituja kohdeohjeita, ohjenäkymää ja aktiivista ohjetta. Kun sovellus ei ole Java-pohjainen tai apua tarvitaan, vaikka sovellus ei ole käynnissä, erillisohjetta voidaan käyttää järjestelmän komentoliittymästä, komentoliittymän komentosarjasta tai työpöydän pikakuvakkeesta, jolloin käytetään komentoriviä Java-ohjelmointirajapintakutsujen sijaan.
Erillisohjejärjestelmässä voidaan siirtää tiettyjä asetuksia, joiden avulla ohjejärjestelmää voidaan mukauttaa. Seuraavia asetuksia tuetaan:
-nl fr_FR
ohjejärjestelmä käynnistyy ranskan kielellä eikä koneen paikallistunnuksen määrittämällä kielellä.d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar
on luokkapolulla, missä [version]
on käytössä olevan lisäosan versio (esimerkiksi org.eclipse.help.base_3.2.0.jar
). Luokka, jota käytät ohjejärjestelmän aloitukseen, käynnistykseen ja sulkemiseen, on org.eclipse.help.standalone.Help
.
String
), joka sisältää ne asetukset, jotka haluat siirtää ohjejärjestelmätukeen. Yleensä tarvitaan eclipsehome
-asetus.
String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
Help
-luokan ilmentymä
siirtämällä asetukset. Tämä objekti olisi säilytettävä sovelluksesi loppuun saakka.
Help helpSystem = new Help(options);
helpSystem.start();
helpSystem.displayHelp();
Voit kutsua ohjetta myös tietyistä ensisijaisista sisällysluettelon tiedostoista tai aiheista:
helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml"); helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
Voit sovelluksen päätteeksi lopettaa ohjejärjestelmän näin:
helpSystem.shutdown();
Luokalla org.eclipse.help.standalone.Help
on päämetodi, jonka avulla voit
käynnistää erillisohjeen komentoriviltä. Komentorivin argumenttien muoto on seuraava:
-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]
Ohje saadaan helposti näkyviin kutsulla
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp
hakemistosta d:\myApp\eclipse directory, jossa version
on lisäosan versio. Tietyn sisällysluettelotiedoston tai -aiheen saa näkyviin kutsulla
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
Edellä olevat ohjeen näyttökutsut käynnistävät ohjejärjestelmän, tuovat ohjeen näkyviin ja antavat käyttäjän jatkaa ohjeen selailua, kun komento on suoritettu. Voit ohjata ohjejärjestelmän elinkaarta aloitus- ja lopetuskomennoilla displayHelp-komennon lisäksi. Voit esimerkiksi tehdä kutsun
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command start
Erillisohjeeseen ei edellytetä koko Eclipse-ympäristöpakettia.
Erillisohje voidaan ajaa RCP Runtime Binaryn avulla asentamalla seuraavat lisäosat eclipse/plugins
-hakemistoon:
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
Huomautus: Varmista, että eclipse/configuration/config.ini
-tiedostossa on seuraava rivi:
osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start, org.eclipse.core.runtime@start
Joillakin dokumentaatiolisäosilla voi olla riippuvuuksia muista lisäosista,
ja pakolliset lisäosat määritetään yleensä niiden manifest-tiedostossa. Myös alisteiset lisäosat on asennettava. Lisäksi Eclipse-versiota 3.0 aikaisempiin versioihin suunniteltuihin lisäosiin
tarvitaan org.eclipse.core.runtime.compatibility
-lisäosa, jotta ne toimivat.
Kohdassa Tuotteen mukautus on lisätietoa ohjejärjestelmän mukautuksesta.