Fristående hjälp

Om du skapar en tillämpning som inte är baserad på Eclipse-ramverket kan du ändå använda Eclipse-hjälpsystemet. Tillämpningen kan paketera och installera det fristående hjälpsystemet, en mycket liten version av Eclipse där allt utom hjälpsystemet har tagits bort. Sedan kan tillämpningen göra API-anrop från hjälpmenyn eller från användargränssnittsobjekt för att starta hjälpwebbläsaren. Det fristående hjälpsystemet har samma funktioner som det inbyggda hjälpsystemet, förutom arbetsmiljöintegrerad sammanhangsberoende hjälp, hjälpvyn och aktiv hjälp. När en tillämpning inte är Java-baserad, eller om hjälp behövs när en tillämpning inte körs, är det möjligt att använda den fristående hjälpen från ett systemskal, ett skalskript eller en skrivbordsgenväg och använda kommandoradsalternativ i stället för att anropa Java-API:er.

För fristående hjälpsystemet går det att överföra ett antal alternativ för anpassning av olika aspekter av hjälpsystemet. Följande alternativ finns:

Installation/paketering

De här anvisningarna används av hjälpsystemintegratören och är inte ämnade för alla tänkbara scenarion. Det antas att all dokumentation levereras som Eclipse-insticksprogram och att du i det stora hela är bekant med Eclipse-hjälpsystemet.
  1. Hämta drivrutinen Eclipse Platform Runtime Binary från eclipse.org.
  2. Installera (zippa upp) drivrutinen i katalogen för tillämpningen, till exempel d:\myApp. Då skapas en Eclipse-underkatalog, d:\myApp\eclipse, som innehåller den kod som krävs för Eclipse-plattformen (där hjälpsystemet ingår).

Så här startar du hjälpklasser från Java

  1. Kontrollera att d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar finns i klassökvägen där [version] är versionen för det insticksprogram du använder (till exempel org.eclipse.help.base_3.2.0.jar). Den klass du använder till att stara och stänga hjälpsystemet är org.eclipse.help.standalone.Help.
  2. Skapa en matris av String-objekt som innehåller alternativ som du vill överföra till hjälpsystemfunktionerna. Vanligen krävs alternativet eclipsehome.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
  3. I tillämpningen skapar du en förekomst av klassen Help genom att överföra alternativen. Det här objektet bör sparas tills tillämpningen är klar.
    Help helpSystem = new Help(options);
  4. Så här startar du hjälpsystemet:
    helpSystem.start(); 
  5. Så här anropar du hjälp vid behov:
    helpSystem.displayHelp(); 

    Du kan även anropa hjälp för specifika primära innehållsförteckningsfiler eller -avsnitt:

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. Om du vill starta den sammanhangsberoende hjälpen anropar du helpSystem.displayContext(contextId, x, y), där contextId är ett fullständigt sammanhangs-ID. Skärmkoordinaterna, x och y, används inte.
  7. När tillämpningen är klar stänger du av systemet på följande sätt:

    helpSystem.shutdown(); 

Så här anropar du hjälp från kommandoraden

Klassen org.eclipse.help.standalone.Help har en huvudmetod som du kan använda till att starta fristående hjälp från kommandoraden. Syntaxen för kommandoradsargumentet är:

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

Ett enkelt sätt att visa hjälpen är att anropa

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

från katalogen d:\myApp\eclipse directory, där version är versionen för insticksprogrammet. Om du vill visa en specifik innehållsförteckningsfil eller -avsnitt använder du

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

Anropen ovan för visning av hjälp gör att hjälpsystemet startar och hjälpen visas och hjälpen fortsätter att vara öppen så att användaren kan fortsätta söka i hjälpen efter att kommandot har utförts. Du kan kontrollera livscykeln för hjälpsystemet med hjälp av start- och avstängningskommandona, förutom kommandot displayHelp. Du kan till exempel anropa

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

[Valfritt] Installera ett minimalt fristående hjälpsystem

För fråstående hjälp krävs inte hela Eclipse-plattformspaketet. Det är möjligt att köra den fristående hjälpen med RCP Runtime Binary med följande insticksprogram tillagda 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

Obs! Du måste se till att följande rad ingår 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

Vissa insticksprogram för dokumentation kan ha beroenden för andra insticksprogram, vanligen genom att de anger nödvändiga insticksprogrammen i manifestet. De beroende insticksprogrammen måste också installeras. Dessutom krävs implicit för insticksprogram som skapades för tidigare versioner än 3.0 av Eclipse att insticksprogrammet org.eclipse.core.runtime.compatibility används för att de ska fungera.

Mer information om anpassning av hjälpsystemet finns i avsnittet om produktanpassning.