Információs központ

A súgórendszer Interneten vagy intraneten is elérhetővé tehető az Információs központ és a dokumentációbedolgozók kiszolgálón telepítésével. Az ügyfelek egy URL cím megadásával a súgórendszer a böngészőben megjeleníthető. Az Információs központ súgórendszere ügyfél és webes alkalmazásokhoz is használható, amelyek távolról elérhető súgóval rendelkeznek. A helyzetfüggő és az aktív súgó, a parancstámogatás és a súgó nézet kivételével az összes súgórendszer-szolgáltatás támogatott.

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 az eclipse.org címről.
  2. Telepítse (csomagolja ki) az illesztőprogramot a d:\myApp könyvtárba. Ez létrehozza a d:\myApp\eclipse eclipse alkönyvtárat, 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ályának van egy main() metódusa, amellyel az Információs központ parancssorból elindítható. A parancssori argumentum szintaxisa:

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

Az Információs központ 8081 porton indításához adjon ki start 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 stop 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

Információs központ használata

Indítsa el az információs központot a fenti útmutatót követve. 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 (pl. 8081). Például arról a gépről, amelyen az információs központ fut, ez a http://localhost:8081/help/ lesz.

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 hívásokat használni az indításhoz és leállításhoz a rendszerparancsok helyett. Ebben az esetben tegye a következőket:

  1. Győződjön meg róla, hogy a d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar szerepel az alkalmazás osztályútvonalán. Az Információs központ indításához és leállításához használt osztály az org.eclipse.help.standalone.Infocenter .
  2. Hozza létre Karaktersorozat-objektumok tömbjé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 Súgó osztály egy példányát a paraméterekben átadással.
    Infocenter infocenter = new Help(options);
  4. A súgórendszer indítása:
    helpSystem.start();
  5. Az információs központ leállítása:
    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. Nem biztonságos környezetekben, mint az Internet, nem ajánlott, hogy az ügyfelek az Információs központhoz közvetlenül hozzáférhessenek. Inkább egy HTTP kiszolgálón vagy alkalmazáskiszolgálón keresztül tegye elérhetővé azt. 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://mycompany.com/myproduct/infocenter címre érkezett kéréseket az Információs központ alkalmazásait futtató http://internalserver:8081/help címre. A feladat végrehajtásához hozzá kell 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 sajátcég 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.

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. Ehhez a -port és -data paramétereket meg kell adni. A példányok különböző bedolgozókból származó dokumentációkat szolgáltathatnak azáltal, hogy érvényes platformkonfigurációt biztosítanak a -configuration paraméterrel.

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ós kö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özpont példányok között.

Szűrés

A Szűrés támogatás információs központ módban futás esetén kikapcsolt állapotban van, ezáltal minden tartalom, a szűrtet is beleértve, láthatóvá válik. Ha munkaterület és az információs központ módban egyaránt üzemeltetni kívánja a dokumentációt, akkor oly módon kell használnia a szűrőket, hogy azoknak a szűrés kikapcsolt állapotában is legyen értelmük.

[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 (az eclipse\plugins könyvtárban találhatók meg):

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 köteg leírófájljukban meghatározzák a szükséges bedolgozókat. A függő bedolgozókat is telepíteni kell az Információs központban.

Az információs központ bedolgozók az információs központ újraindítása nélkül frissíthetők a Futó információs központ frissítése parancssorból témakörben tárgyalt parancsok segítségével. Ennek a szolgáltatásnak a használatához a minimális bedolgozóhalmazban szerepelnie kell az org.eclipse.update.core bedolgozónak.

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