Standalone Help

Als u een toepassing maakt die niet is gebaseerd op het framework van Eclipse, kunt u toch het Eclipse-helpsysteem gebruiken. Het stand-alone Help-systeem, een hele kleine versie van Eclipse die alles bevat behalve het Helpsysteem dat eruit is verwijderd, kan door uw toepassing worden ingepakt en geïnstalleerd. Vervolgens kan uw toepassing API-aanroepen doen vanuit het Helpmenu of vanaf UI-objecten om de Helpbrowser te starten. Het stand-alone Helpsysteem bevat alle features van het geïntegreerde Help-systeem, behalve in de workbench geïntegreerde specifieke Help, de view Help en actieve Help. Als een toepassing geen Java-toepassing is of Help vereist is wanneer de toepassing niet wordt uitgevoerd, is het mogelijk stand-alone Help te gebruiken vanaf een systeemshell, een shellscript of een bureaubladsnelkoppeling en opdrachtregelopties te leveren in plaats van Java-API's aan te roepen.

Het stand-alone Helpsysteem maakt het mogelijk een aantal opties door te geven die kunnen worden gebruikt voor het aanpassen van verschillende aspecten van het Help-systeem. De volgende opties worden ondersteund:

Installatie/inpakken

Deze stappen zijn voor de Help-systeemintegrator en zijn niet bedoeld voor alle andere mogelijke scenario's. Verondersteld wordt dat al uw documentatie wordt geleverd als eclipse-plugins en dat u in het algemeen bekend bent met het Eclipse-Helpsysteem.
  1. Download het stuurprogramma Eclipse Platform Runtime Binary van eclipse.org.
  2. Installeer het stuurprogramma (pak het bestand uit) onder de directory van uw toepassing, bijvoorbeeld d:\myApp. Hiermee wordt een eclipse-subdirectory gemaakt, d:\myApp\eclipse, die de code bevat die vereist is voor het Eclipse-platform (dat het Help-systeem bevat).

Procedure voor het aanroepen van de Help-klassen van Java

  1. Zorg ervoor dat d:\myApp\eclipse\plugins\org.eclipse.help.base_[versie].jar zich bevindt op het klassenpad, waarbij [versie] de versie is van de plugin die u gebruikt (bijvoorbeeld org.eclipse.help.base_3.2.0.jar). De klasse die u gebruikt om het Help-systeem te starten, op te starten of af te sluiten, is org.eclipse.help.standalone.Help.
  2. Definieer een aantal String-objecten met opties die u wilt doorgeven aan het Help-systeem. Gewoonlijk is de optie eclipsehome vereist.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
  3. Maak in uw toepassing een instance van de klasse Help door de opties door te geven. Dit object moet worden vastgehouden tot het einde van uw toepassing.
    Help helpSystem = new Help(options);
  4. Voor het starten van het Help-systeem:
    helpSystem.start(); 
  5. Voor het oproepen van Help wanneer dit nodig is:
    helpSystem.displayHelp(); 

    U kunt Help ook aanroepen op specifieke primaire TOC-bestanden of onderwerpen:

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. Als u de contextafhankelijke Help wilt opstarten, roept u helpSystem.displayContext(contextId, x, y) aan, waarin contextId een volledig gekwalificeerd context-ID is. De rastercoördinaten x en y worden op dit moment niet gebruikt.
  7. Aan het einde van de toepassing sluit u het Help-systeem als volgt af:

    helpSystem.shutdown(); 

Procedure voor het aanroepen van de Help vanaf een opdrachtregel

De klasse org.eclipse.help.standalone.Help heeft een main-methode die u kunt gebruiken voor het starten van standalone Help vanaf een opdrachtregel. De argumentensyntaxis van de opdrachtregel is:

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

Een eenvoudige manier voor het weergeven van Help wordt uitgevoerd door het oproepen van

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

vanuit de directory D:\myApp\eclipse, waarbij versie de versie van de plugin is. Voor het weergeven van een specifiek TOC-bestand of onderwerp, gebruikt u

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

Bovenstaande aanroepen voor weergave van Help zorgen ervoor dat het Help-systeem wordt gestart, wordt weergegeven en actief blijft, zodat de gebruiker Help kan blijven doorzoeken nadat de opdracht is verwerkt. Om de levenscyclus van het Help-systeem te besturen, gebruikt u de opdrachten voor starten en afsluiten, naast de opdracht displayHelp. U kunt bijvoorbeeld aanroepen:

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

Een minimaal standalone Help-systeem installeren (optioneel)

De standalone Help heeft niet het hele Eclipse-platformpakket nodig. Het is mogelijk de standalone Help uit te voeren met de volgende plugins (deze bevinden zich in de directoryeclipse\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

Opmerking: Controleer of de volgende regel aanwezig is in het bestand eclipse/configuration/config.ini:

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

Een aantal documentatieplugins kan dependency's hebben op andere plugins, meestal door de vereiste plugins in het bijbehorende manifest op te geven. De afhankelijke plugins moeten ook worden geïnstalleerd. Bovendien vereisen de plugins die zijn ontworpen voor eerdere versies dan Eclipse versie 3.0 impliciet dat de plugin org.eclipse.core.runtime.compatibility aanwezig is om te kunnen worden uitgevoerd.

Zie Producten aanpassen voor meer informatie over het aanpassen van het Help-systeem.