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:
osgi.instance.area
vagy az osgi.instance.area.default
tulajdonságok újradefiniálásával
került testreszabásra. -nl en
-locales de en es fr it ja ko pt_BR zh_CN zh_TW
. Minden más területi beállítás az en
területi
beállítástól kapja a tartalmat. -vmargs -Xmx256M
paraméterek átadása például megnöveli az Információs központ rendelkezésére álló memória mennyiségét és
lehetőséget ad a nagyobb könyvgyűjtemények kiszolgálására. 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.
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 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
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.
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:
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
.
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" };
Súgó
osztály egy példányát a paraméterekben átadással. Infocenter infocenter = new Help(options);
helpSystem.start();
helpSystem.shutdown();
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.
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.
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.
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.