Önálló súgórendszer telepítése

Ha olyan alkalmazást hoz létre, amely nem az Eclipse keretrendszerre épül, akkor is használhatja az Eclipse súgórendszerét. Az alkalmazás képes csomagolni és telepíteni egy önálló súgórendszert, egy nagyon kicsi Eclipse-verziót, amelyből a súgórendszeren kívül minden más hiányzik. Ezután az alkalmazás API hívásokat indíthat a Súgó menüjéből vagy az UI objektumokból a súgó böngésző elindítására. Az önálló súgórendszer az integrált súgórendszer minden szolgáltatásával rendelkezik az előugró súgók és az aktív súgó kivételével. Amikor egy alkalmazás nem Java alapú, vagy súgóra van szükség, amikor az alkalmazás nem fut, az önálló súgó egy rendszer-parancsértelmezőből, egy parancsértelmező parancsfájlból vagy egy asztali parancsikonból is elindítható, és parancssori beállításokat kínál a Java API-k meghívása helyett.

Az önálló súgórendszer számos beállítás átadását lehetővé teszi, amelyekkel az önálló súgórendszer számos vonatkozása személyre szabható. A rendszer a következő beállításokat támogatja:

Telepítés/csomagolás

Ezek a lépések a súgórendszer-integrátorok számára készültek, és nem azt jelentik, hogy minden lehetséges szituációban megfelelők. Feltételezzük, hogy az Ön összes dokumentuma Eclipse bedolgozók formájában áll rendelkezésre, és általában, hogy ismeri az Eclipse súgórendszerét.
  1. Töltse le az Eclipse Platform Runtime Binary illesztőprogramot a www.eclipse.org címről.
  2. Telepítse (tömörítse ki) az illesztőprogramot az alkalmazás könyvtárában (pl.:d:\myApp). Ez létrehoz egy eclipse alkönyvtárat (d:\myApp\eclipse), amely az Eclipse platformhoz szükséges kódot tartalmazza; ennek része a súgórendszer is.

A súgóosztályok meghívása Javából

  1. Győződjön meg róla, hogy a d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar szerepel az osztályútvonalak között. A súgórendszer indításához és lezárásához használt osztály az org.eclipse.help.standalone.Help.
  2. Hozzon létre egy karaktersorozat-tömböt, amely az súgórendszer számára átadni kívánt paramétereket tartalmazza. Általában az eclipsehome paraméterre van szükség.
    String[] options = new String[]
    { "-eclipsehome", "d:\\myApp\\eclipse" }; 
  3. Az alkalmazásban hozza létre a Help osztály egy példányát a paraméterek átadásával. Ezt az objektumot meg kell tartani az alkalmazás végéig.
    Help helpSystem = new Help(options); 
  4. A súgórendszer indításához:
    helpSystem.start(); 
  5. A súgó meghívásához, amikor szükséges:
    helpSystem.displayHelp(); 

    Egyes elsődleges tartalomjegyzék-fájlokkal vagy témakörökkel kapcsolatban is meghívhatja a súgót:

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. A környezetérzékeny súgó elindításához hívja meg a helpSystem.displayContext(contextId, x, y) metódust, ahol a contextId a teljes képzésű kontextusazonosító. Az x és y képernyő-koordináták jelenleg nincsenek használatban.
  7. Az alkalmazás használatának végén a súgó bezárásához:

    helpSystem.shutdown(); 

Súgó meghívása parancssorból

Az org.eclipse.help.standalone.Help osztálynak van egy fő metódusa, amellyel a súgó parancssorból elindítható. A parancssori argumentumok szintaxisa:

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

A súgó megjelenítésének egy egyszerű módja a következő meghívása:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp

Ez a d:\myApp\eclipse könyvtárban található. Adott tartalomjegyzék fájlok vagy témakörök megjelenítéséhez:

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

A súgó megjelenítésére használt fenti hívások hatására elindul a rendszer, megjelenik a súgó és folyamatosan fut, lehetőséget adva a felhasználóknak, hogy folytassák a súgó böngészését a parancs végrehajtása után. A súgórendszer életciklusának vezérléséhez használja a start és a shutdown parancsokat a displayHelp parancs mellett. Például meghívhatja a következőt:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command start

[Nem kötelező] A bedolgozók minimális készletének telepítése

Az önálló súgóhoz nincs szükség a teljes  Eclipse platform csomag telepítésére. Az önálló súgót a következő bedolgozókkal lehet futtatni (megtalálhatók az   eclipse\plugins könyvtárban):

org.apache.lucene
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.webapp
org.eclipse.osgi
org.eclipse.tomcat
org.eclipse.update.configurator

Windowson és Linuxon a következő bedolgozókra és töredékekre van szükség a minimális konfiguráción felül a robusztus böngészőtámogatás biztosításához (egy SWT-beágyazásos Internet Explorer Windowson, és Mozilla Linuxon vagy egy önálló rendszerböngésző Windowson).

org.eclipse.core.expressions
org.eclipse.help.ui
org.eclipse.jface
org.eclipse.swt
org.eclipse.swt.win32 vagy org.eclipse.swt.gtk
org.eclipse.ui
org.eclipse.ui.workbench

Bizonyos dokumentációs bedolgozók függőségi viszonyban lehetnek más bedolgozókkal, általában azáltal, hogy meghatározzák a megkívánt bedolgozókat plugin.xml fájljukban. A függő bedolgozókat is telepíteni kell az Információs központban. Emellett az Eclipse 3.0 verziója előtt készített bedolgozók működéséhez magától értetődően szükség van a org.eclipse.core.runtime.compatibility jelenlétére.

A súgórendszer személyre szabásával kapcsolatban további információkért lásd: Súgórendszer beállítások.

org.eclipse.help.base beállítások