Samostatná nápověda

Systém nápovědy Eclipse můžete rovněž použít, pokud vytváříte aplikaci, která není naložena na infrastruktuře Eclipse. Vaše aplikace může zabalit a instalovat samostatný systém nápovědy, velmi malou verzi platformy Eclipse, ze které je odebráno vše s výjimkou systému nápovědy. Potom může vaše aplikace provádět volání rozhraní API ze své nabídky nápovědy nebo z objektů uživatelského rozhraní, aby spustila prohlížeč nápovědy. Samostatný systém nápovědy má všechny funkce integrovaného systému nápovědy kromě kontextové nápovědy integrované do pracovní plochy, pohledu Nápověda a aktivní nápovědy. Pokud nejde o javovskou aplikaci nebo má-li být nápověda k dispozici i v situacích, kdy aplikace není spuštěna, lze používat samostatnou nápovědu z nadstavby systému, skriptu nadstavby nebo ze zástupce pracovní plochy a poskytnout volby příkazového řádku namísto volání API.

Samostatný systém nápovědy podporuje řadu voleb, které lze použít k přizpůsobení různých aspektů systému nápovědy. Podporovány jsou tyto volby:

Instalace/balení

Popsané úkony jsou určeny pro integrátora systému nápovědy a neuvádějí všechny možné situace. Předpokládejme, že je veškerá vaše dokumentace dodána v podobě modulů plug-in a že jste se obecně seznámili se systémem nápovědy Eclipse.
  1. Stáhněte binární ovladač běhové komponenty platformy Eclipse z adresy eclipse.org.
  2. Instalujte (rozbalte) ovladač do adresáře své aplikace, např. d:\myApp. Vytvoří se podadresář Eclipse,d:\myApp\eclipse, který obsahuje kód požadovaný platformou Eclipse (který obsahuje systém nápovědy).

Volání tříd nápovědy z prostředí Java

  1. Ujistěte se, že soubor d:\myApp\eclipse\plugins\org.eclipse.help.base_[verze].jar je v cestě k vaší třídě, kde [verze] je verze používaného modulu plug-in (např. org.eclipse.help.base_3.2.0.jar). Třída používaná k aktivaci, spuštění a vypnutí systému nápovědy je org.eclipse.help.standalone.Help.
  2. Vytvořte pole objektů String obsahující volby, které chcete předat podpoře systému nápovědy. Zpravidla je zapotřebí volba eclipsehome.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
  3. Ve své aplikaci vytvořte instanci třídy Help předáním voleb. Tento objekt by měl být uchováván až do ukončení vaší aplikace.
    Help helpSystem = new Help(options);
  4. Spuštění systému nápovědy:
    helpSystem.start(); 
  5. Volání nápovědy dle potřeby:
    helpSystem.displayHelp(); 

    Rovněž můžete volat nápovědu určitých primárních souborů obsahu či hesel:

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. Chcete-li spustit kontextovou nápovědu, použijte příkaz helpSystem.displayContext(idKontextu, x, y), kde contextId je úplné ID kontextu. Souřadnice obrazovky x a y se v současné době nepoužívají.
  7. Vypnutí systému nápovědy při ukončování vaší aplikace:

    helpSystem.shutdown(); 

Volání nápovědy z příkazového řádku

Třída org.eclipse.help.standalone.Help má metodu main, kterou můžete používat ke spuštění samostatné nápovědy z příkazového řádku. Syntaxe argumentů příkazového řádku:

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

Jednoduchým způsobem zobrazení nápovědy je zadání příkazu

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

Z adresáře d:\myApp\eclipse, kde version je verze modulu plug-in. Chcete-li zobrazit konkrétní soubor s obsahem nebo téma, použijte

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

Výše uvedené příkazy zobrazující nápovědu způsobí spuštění systému nápovědy, zobrazení nápovědy a uchování nápovědy v chodu za účelem pokračování v prohlížení nápovědy po provedení příkazu. Ke kontrole životního cyklu systému nápovědy používejte kromě příkazu displayHelp příkazy spuštění a vypnutí. Například lze vyvolat

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

[Volitelné] Instalace minimálního systému samostatné nápovědy

Samostatná nápověda nevyžaduje celý balíček platformy Eclipse. Samostatnou nápovědu s binární běhovou komponentou RCP lze spustit již při použití následujících modulů plug-in (přidaných do adresáře 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

Poznámka: Musíte zkontrolovat, zda je v souboru eclipse/configuration/config.ini přítomen následující řádek:

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

Některé moduly plug-in mohou záviset na jiných modulech plug-in. Požadované moduly plug-in jsou obvykle uvedeny v manifestech. Rovněž takovéto závislé moduly plug-in musejí být instalovány. Kromě toho moduly plug-in navržené pro verze Eclipse předcházející verzi 3.0 implicitně vyžadují ke své funkci přítomnost modulu plug-inorg.eclipse.core.runtime.compatibility.

Podrobnější informace o přizpůsobení systému nápovědy najdete v části Přizpůsobení produktu.