Önálló súgó

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 a munkaterület-integrált helyzetérzékeny súgó, súgó nézet é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 összes dokumentum eclipse bedolgozók formájában áll rendelkezésre, és hogy általában ismeri az Eclipse súgórendszerét.
  1. Töltse le az Eclipse Platform Runtime Binary illesztőprogramot a 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_[version].jar szerepel az osztályútvonalon, ahol a [version] a használt bedolgozóverzió (pl. org.eclipse.help.base_3.2.0.jar). A súgórendszer indításához és leállításához használt osztály az org.eclipse.help.standalone.Help.
  2. Hozza létre Karaktersorozat-objektumok tömbjét, amely a súgórendszer számára átadni kívánt paramétereket tartalmazza. Jellemzően az eclipsehome paraméter szükséges.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
  3. Az alkalmazásban hozza létre a Súgó osztály egy példányát a paraméterekben átadással. 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(); 

A 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_[version].jar org.eclipse.help.standalone.Help -command displayHelp

a d:\myApp\eclipse könyvtárból, ahol version a bedolgozó verziója. Egy adott TOC fájl vagy témakör megjelenítése:

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

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_[version].jar org.eclipse.help.standalone.Help -command start

[Nem kötelező] Minimális önálló súgórendszer 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 RCP Runtime Binary szoftverrel futtatható az eclipse/plugins könyvtárhoz adott következő bedolgozókkal):

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

Megjegyzés: Győződjön meg róla, hogy a következő sor megjelenik az eclipse/configuration/config.ini fájlban:

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

Bizonyos dokumentációs bedolgozók függőségi viszonyban lehetnek más bedolgozókkal, általában azáltal, hogy leírófájljukban meghatározzák a szükséges bedolgozókat. A függő bedolgozókat is telepíteni kell. Ezen felül az eclipse 3.0 verziója előtt létrehozott bedolgozók működéséhez az org.eclipse.core.runtime.compatibility implicit jelenlétére is szükség van.

A súgórendszer személyre szabásával kapcsolatos további információkat a Termék személyre szabása részben tartalmaz.