Súgórendszer telepítése Információs központként

A súgórendszer elérhetővé tehető az Interneten vagy az intraneten is az Információs központ és a dokumentációs bedolgozók telepítésével egy kiszolgálón. Az ügyfelek egy URL-címre lépve böngészőjükben láthatják a súgót. Az Információs központ súgórendszere ügyfélalkalmazásokhoz és webes alkalmazásokhoz is használható, amelyeknél van távolról elérhető súgó. A súgórendszer minden szolgáltatása támogatott, kivéve az előugró súgókat és az aktív súgókat.

Az Információs központ súgórendszere számos beállítás átadását lehetővé teszi, amelyekkel az Információs központ 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 egy könyvtárba (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.

Az Információs központ elindítása és leállítása parancssorból

Az org.eclipse.help.standalone.Infocenter osztálynak van egy fő metódusa, amellyel az Információs központ parancssorból elindítható. A parancssori argumentumok szintaxisa:

-command start | shutdown | [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-locales localeList] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]

Egy Információs központ 8081 porton indításához adjon ki egy indítóparancsot az alábbiak futtatásával:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\myApp\eclipse -port 8081

A súgórendszer leállításához adjon ki egy leállítási parancsot az alábbiak futtatásával:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse

Az Információs központ használata

Indítsa el a webkiszolgálót. A webböngészőbe írja be a "help" webalkalmazás súgójának elérési útvonalát és az Információs központ indításakor megadott portját.  Azon a gépen, amelyen az Információs központ fut, ez valószínűleg a http://localhost:8081/help/ lesz.

Az Információs központ elindítása és leállítása Javából

Ha az Információs központ más alkalmazás részeként kerül elhelyezésre, sokkal kényelmesebb lehet Java API-k használatával indítani és leállítani a rendszerparancsok helyett. Ha ez a helyzet, tegye az alábbiakat:

  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. Az Információs központ indításához és leállításához használt osztály az isorg.eclipse.help.standalone.Infocenter.
  2. Hozzon létre egy karaktersorozat-tömböt, amely az Információs központ számára átadni kívánt paramétereket tartalmazza. Általában az eclipsehome és a port beállításokra van szükség.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" }; 
  3. Az alkalmazásban hozza létre a Help osztály egy példányát a paraméterek átadásával.
    Infocenter infocenter = new Help(options); 
  4. A súgórendszer indításához:
    helpSystem.start();
  5. A súgórendszer leállításához:

    helpSystem.shutdown(); 

Az Információs központ webes elérésének biztosításához:

Az Eclipse egy teljes Információs központot kínál, amelyhez nincs szükség más kiszolgálószoftverek futtatására. Az olyan nem biztonságos környezetekben viszont, mint az Internet, ajánlott, hogy az Információs központot ne érhessék el közvetlenül az ügyfelek, de egy HTTP-kiszolgálón vagy alkalmazáskiszolgálón keresztül elérhető legyen. A legtöbb kiszolgáló rendelkezik olyan modulokkal vagy kiszolgáló kisalkalmazásokkal, amelyekkel bizonyos kérések más webes erőforrásokhoz delegálhatók. Az egyik például beállíthatja az Apache HTTP kiszolgáló egyik proxymodulját úgy, hogy átirányítsa a http://sajatceg.com/sajattermek/infocenter címre érkezett kéréseket az Információs központ alkalmazásait futtató http://belsokiszolgalo:8081/help címre. A feladat végehajtásához hozzá kel adni a következő sorokat:

LoadModule proxy_module modules/ApacheModuleProxy.dll
ProxyPass /myproduct/infocenter http://internalserver:8081/help
ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help

a sajatceg webhelyet működtető Apache kiszolgáló conf/httpd.conf fájljához.

Az Apache HTTP kiszolgáló bizonyos verziói engedélyezhetik az AddDefaultCharset utasítást a konfigurációs fájlban. Törölje vagy helyettesítse ezt az

AddDefaultCharset Off

utasítással, hogy a böngésző a helyes karakterkészlet alkalmazásával jelenítse meg a dokumentumokat.

Az Információs központ több példányának futtatása

Egy telepítésből az Információs központ több példánya is futhat egy gépen. Minden elindított példánynak a saját portját kell használnia, és biztosítani kell számára egy munkaterületet, emiatt meg kell adni a -port és -data paramétereket. A példányok különböző bedolgozókból származó dokumentációkat szolgáltathatnak, és érvényes platformkonfigurációt biztosíthatnak a -configuration paraméter használatával.

Ha a -configuration paraméter nincs megadva, és a konfigurációs könyvtár a területi beállítások átfedő készletével meg van osztva több információsközpont-példány között, biztosítani kell, hogy egyetlen információs központ készítse el az összes keresési indexet, mielőtt egy másik példány elindulna. Az indexek a konfigurációs könyvtárban vannak elmentve, és az írási hozzáférés nincs szinkronizálva az információs központi folyamatok között.

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

Az Információs központhoz nincs szükség a teljes  Eclipse platform csomag telepítésére. Az Információs központot 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

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.

Az Információs központ bedolgozók az Információs központ újraindítása nélkül frissíthetők, a következő témakörben tárgyalt parancsok használatával: Egy futó Információs központ frissítése parancssorból. Ennek a szolgáltatásnak a használatához a minimális bedolgozókészletben szerepelnie kell az org.eclipse.update.core bedolgozónak.

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.