Frittstående hjelp

Hvis du skal opprette en applikasjon som ikke er basert på Eclipse-rammeverket, kan du likevel bruke Eclipse-hjelpefunksjonen. Applikasjonen kan pakke og installere den frittstående hjelpefunksjonen, en veldig liten versjon av Eclipse som er rensket for alt unntatt hjelpefunksjonen. Da kan applikasjonen foreta API-kall fra Hjelp-menyen, eller fra brukergrensesnittobjekter, for å starte nettleseren for hjelpen. Den frittstående hjelpefunksjonen har alle de samme funksjonene som den integrerte hjelpefunksjonen, bortsett fra arbeidsbenkintegrert konteksthjelp, hjelpevisningen og aktiv hjelp. Hvis en applikasjon ikke er Java-basert, eller du trenger hjelp når applikasjonen ikke kjøres, er det mulig å bruke frittstående hjelp fra et systemskall, et skallskript eller en skrivebordssnarvei og oppgi kommandolinjealternativer i stedet for å kalle opp Java-APIer.

Den frittstående hjelpefunksjonen gjør det mulig å oppgi en rekke alternativer som kan brukes for å tilpasse forskjellige aspekter ved hjelpefunksjonen. Følgende alternativer støttes:

Installering/pakking

Disse trinnene gjelder for hjelpefunksjonsintegratoren og har ikke til hensikt å ta for seg alle mulige scenarier. Det antas at all dokumentasjonen er i form av plugin-moduler for Eclipse, og at du generelt er kjent med Eclipse-hjelpefunksjonen.
  1. Last ned driveren Eclipse Platform Runtime Binary fra eclipse.org.
  2. Installer (unzip) driveren i applikasjonskatalogen, for eksempel d:\myApp. Dette vil opprette en Eclipse-delkatalog, d:\myApp\eclipse, som inneholder den nødvendige koden for Eclipse-plattformen (som inneholder hjelpefunksjonen).

Slik kaller du opp klassene for hjelp fra Java

  1. Kontroller at d:\myApp\eclipse\plugins\org.eclipse.help.base_[versjon].jar er i klassebanen, der [versjon] er versjonen av plugin-modulen du bruker (f.eks. org.eclipse.help.base_3.2.0.jar). Klassen du bruker for å starte og avslutte hjelpesystemet, er org.eclipse.help.standalone.Help.
  2. Opprett en matrise av String-objekter som inneholder alternativer som du vil sende til hjelpesystemstøtten. Vanligvis trenger du alternativet eclipsehome.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
  3. I applikasjonen oppretter du en forekomst av klassen Help ved å sende alternativene. Ta vare på dette objektet til applikasjonen er ferdig.
    Help helpSystem = new Help(options);
  4. Slik starter du hjelpefunksjonen:
    helpSystem.start(); 
  5. Slik aktiverer du hjelpen ved behov:
    helpSystem.displayHelp(); 

    Du kan også kalle opp hjelp til bestemte primære TOC-filer eller emner:

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. Hvis du skal starte kontekstavhengig hjelp, kaller du opp helpSystem.displayContext(contextId, x, y) der contextId er en fullstendig kvalifisert kontekst-ID. Skjermkoordinatene, x og y, brukes ikke for øyeblikket.
  7. Slik avslutter du hjelpefunksjonen når applikasjonen er ferdig:

    helpSystem.shutdown(); 

Slik kaller du opp hjelp fra kommandolinjen

Klassen org.eclipse.help.standalone.Help har en hovedmetode som du kan bruke for å starte den frittstående hjelpen fra en kommandolinje. Syntaksen for kommandolinjeargumentene er:

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

En enkel måte å vise hjelp på, er å aktivere

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[versjon].jar org.eclipse.help.standalone.Help -command displayHelp

fra katalogen d:\myApp\eclipse, der versjon er plugin-modulens versjon. Du kan få frem en bestemt fil med innholdsfortegnelse eller et bestemt emne ved å bruke

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

Kallene over for å vise hjelp starter hjelpefunksjonen, viser hjelpen og fortsetter å kjøre, slik at en bruker kan fortsette å bla gjennom hjelpen etter at kommandoen er utført. Hvis du vil styre livssyklusen til hjelpefunksjonen, bruker du kommandoene start og shutdown, i tillegg til kommandoen displayHelp. Du kan for eksempel kalle opp

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[versjon].jar org.eclipse.help.standalone.Help -command start

[Valgfritt] Installere et frittstående minimumshjelepsystem

Den frittstående hjelpen krever ikke hele Eclipse-plattformpakken. Det er mulig å kjøre den frittstående hjelpen med RCP Runtime Binary med følgende plugin-moduler lagt til i katalogen eclipse/plugins:

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

Merk: Du må sørge for at følgende linje finnes i filen eclipse/configuration/config.ini:

osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start, org.eclipse.core.runtime@start

Noen plugin-moduler for dokumentasjon kan ha avhengigheter på andre plugin-moduler, vanligvis ved å oppgi nødvendige plugin-moduler i manifesten. De avhengige plugin-modulene må også installeres. I tillegg krever plugin-moduler som ble utformet for tidligere utgaver enn Eclipse versjon 3.0, at det finnes en plugin-modul av typen org.eclipse.core.runtime.compatibility for å virke.

Du finner flere opplysninger om hvordan du tilpasser hjelpesystemet, i emnet Produkttilpasning.