Enkeltstående hjælp

Hvis du opretter et program, der ikke er baseret på Eclipse-rammen, kan du stadig bruge Eclipse-hjælpen. Dit program kan pakke og installere den enkeltstående hjælp, en meget lille version af Eclipse, der kun indeholder hjælpen. Derefter kan programmet foretage API-kald fra hjælpemenuen eller fra brugergrænsefladeobjekter for at starte hjælpebrowseren. Den enkeltstående hjælp indeholder alle funktioner, der findes i den integrerede hjælp med undtagelse af arbejdsbænk-integreret konteksthjælp, hjælpeoversigten og aktiv hjælp. Når et program ikke er Java-baseret, eller hjælpen skal bruges, når programmet ikke udføres, er det muligt at bruge enkeltstående hjælp fra en system-shell, et shell-script eller en genvej på desktoppen og angive kommandolinjeparametre i stedet for at kalde Java-API'er.

Den enkeltstående hjælp gør det muligt at overføre et antal parametre, der kan anvendes til at tilpasse forskellige aspekter i hjælpen. Følgende parametre er understøttet:

Installation/pakning

Følgende trin er skrevet til integratoren af hjælpen og beskriver ikke alle de mulige scenarier. Det forudsættes, at din dokumentation leveres i form af Eclipse-plugins, og at du har et generelt kendskab til Eclipse-hjælpen.
  1. Overfør styreprogrammet Eclipse Platform Runtime Binary fra eclipse.org.
  2. Installér (pak ud med unzip) programmet i programbiblioteket, f.eks. d:\myApp. Det opretter Eclipse-underbiblioteket d:\myApp\eclipse, som indeholder den krævede kode til Eclipse-platformen, herunder hjælpen.

Sådan kalder du hjælpeklasser fra Java

  1. Sørg for, at d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar er i klassestien, hvor [version] er versionen på den plugin, du anvender, f.eks. org.eclipse.help.base_3.2.0.jar. Den klasse, du anvender til at starte og lukke hjælpesystemet med, er org.eclipse.help.standalone.Help.
  2. Opret et array af String, der indeholder de parametre, du vil overføre til hjælpen. Parameteren eclipsehome er normalt påkrævet.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
  3. Opret en forekomst af Help-klassen i dit program ved at overføre parametrene. Objektet skal bevares, indtil slutningen af programmet.
    Help helpSystem = new Help(options);
  4. Start hjælpen:
    helpSystem.start(); 
  5. Start hjælpen, når det er nødvendigt:
    helpSystem.displayHelp(); 

    Du kan også kalde hjælpen ved specifikke primære TOC-filer eller emner:

    helpSystem.displayHelp("/com.mitfirma.mitvaerktoej.doc/toc.xml");
    helpSystem.displayHelp("/com.mitforma.mitvaerktoej.doc/tasks/task1.htm");
  6. Hvis du vil starte den kontekstafhængige hjælp, skal du kalde helpSystem.displayContext(contextId, x, y), hvor contextId er den fuldstændige kontekst-id. Skærmkoordinaterne x og y anvendes ikke øjeblikket.
  7. For at afslutte hjælpen skal der stå følgende i slutningen af programmet:

    helpSystem.shutdown(); 

Sådan kalder du hjælp fra kommandolinjen

Klassen org.eclipse.help.standalone.Help har en overordnet metode, som du kan bruge til at starte den enkeltstående hjælp fra kommandolinjen. Syntaks for kommandolinjeparametrene er:

-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data forekomstområde] [-host hjælpeservervært] [-port hjælpeserverport] [-dir rtl] [platformsparametre] [-vmargs JavaVMarguments]

En enkel måde at få vist hjælp på er at starte

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

fra biblioteket d:\myApp\eclipse, hvor version er plugin'ens version. Hvis du vil have vist en bestemt TOC-fil eller et emne, skal du bruge

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

Ovenstående kald for at få vist hjælp medfører, at hjælpesystemet starter, hjælpen vises og fortsætter med at være aktiv, så en bruger kan fortsætte med at se hjælpen, efter at kommandoen er udført. Du kan styre varigheden af hjælpen med kommandoerne start og shutdown foruden kommandoen displayHelp. Du kan f.eks. aktivere

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

Installér et minimalt enkeltstående hjælpesystem (valgfrit)

Den enkeltstående hjælp kræver ikke hele pakken til Eclipse-platformen. Det er muligt at udføre den enkeltstående hjælp med RCP Runtime Binary med følgende plugins tilføjet til biblioteket 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

Bemærk: Du skal sikre dig, at følgende linje er til stede 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

Visse dokumentations-plugins kan være afhængige af andre plugins. Det gøres normalt ved at angive de krævede plugins i deres manifest. De afhængige plugins skal også være installeret. Plugins, der er designet til tidligere versioner af eclipse end version 3.0, kræver desuden en underforstået org.eclipse.core.runtime.compatibility-plugin for at kunne fungere.

Der er flere oplysninger om tilpasning af hjælpen under emnet Produkttilpasning.