Voit antaa käyttäjille mahdollisuuden käyttää ohjejärjestelmää Internetin tai intranetin kautta asentamalla Info Centerin ja dokumentaatiolisäosat palvelimeen. Asiakkaat tarkastelevat ohjetta siirtymällä URL-osoitteeseen, ja ohjejärjestelmä näkyy heidän Web-selaimissaan. Info Center -ohjejärjestelmää voidaan käyttää sekä työasema- että Web-sovellusten yhteydessä, ja niiden kummankin ohjetta voidaan käyttää etäyhteyden kautta. Kaikki ohjejärjestelmän ominaisuudet paitsi kohdeohje, aktiivinen ohje ja ohjenäkymä ovat tuettuja.
Info Center -ohjejärjestelmässä voidaan siirtää tiettyjä asetuksia, joiden avulla Info Centeriä voidaan mukauttaa. Seuraavia asetuksia tuetaan:
osgi.instance.area
- tai osgi.instance.area.default
-ominaisuuksien ohittamiseksi.-nl en -locales de en es fr it ja ko pt_BR zh_CN zh_TW
avulla Info Center toimii kymmenellä paikallistunnuksella. Kaikki muut paikallistunnukset saavat sisällön paikallistunnuksella en
.
-vmargs -Xmx256M
lisäävät Info Centerin käyttöönsä saamaa muistia, jolloin se voi palvella entistä laajempaa kirjakokoelmaa.
Nämä vaiheet koskevat ohjejärjestelmän käyttöönottoa, eikä niitä ole tarkoitettu kaikkien mahdollisten skenaarioiden ratkaisuun. Oletuksena on, että koko dokumentaatio toimitetaan Eclipse-lisäosina ja että olet yleisesti perehtynyt Eclipse-ohjejärjestelmään.
d:\myApp
. Tällöin luodaan Eclipse-alihakemisto d:\myApp\eclipse
, joka sisältää Eclipse-ympäristössä tarvittavan koodin (myös ohjejärjestelmän).
Luokalla org.eclipse.help.standalone.Infocenter
on main()
-metodi, jonka avulla voit
aloittaa Info Centerin komentoriviltä. Komentorivin argumenttien muoto on seuraava:
-command start | shutdown | [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-locales localeList] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]
Kun haluat aloittaa Info Centerin portissa 8081, anna start
-komento ajamalla
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
Kun haluat sulkea Info Centerin, anna shutdown
-komento ajamalla
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
Aloita Info Center edellä kuvattujen ohjeiden mukaan. Määritä Web-selain osoittamaan "/help"-Web-sovellukseen, joka on ajossa Info Centerin aloituksen yhteydessä määritetyssä portissa (esimerkiksi 8081). Esimerkiksi koneessa, johon Info Center on asennettu, tämä on http://localhost:8081/help/
.
Kun Info Center sisällytetään osaksi toista sovellusta, voi olla kätevämpää aloittaa ja lopettaa se käyttämällä Java-ohjelmointirajapinnan kutsuja järjestelmäkomentojen sijasta. Toimi tässä tapauksessa seuraavasti:
d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar
. Luokka, jota käytät ohjejärjestelmän aloitukseen ja sulkemiseen, on org.eclipse.help.standalone.Infocenter
.String
), joka sisältää ne asetukset, jotka haluat siirtää
Info Centeriin. Yleensä tarvitaan eclipsehome
- ja port
-asetukset. String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
Help
-luokan ilmentymä
siirtämällä asetukset. Infocenter infocenter = new Help(options);
helpSystem.start();
helpSystem.shutdown();
Eclipse sisältää täydellisen Info Centerin, eikä se tarvitse ajoa varten muita
palvelinohjelmistoja. Koska Internet on kuitenkin turvaton ympäristö, on suositeltavaa, etteivät työasemat pääse käyttämään Info Centeriä suoraan, vaan HTTP- tai sovelluspalvelimen kautta. Useimpiin palvelimiin kuuluu moduuleja tai palvelinsovelmia, joiden avulla tietyt pyynnöt voidaan delegoida muille Web-resursseille. Voidaan esimerkiksi määrittää Apache HTTP -palvelimen välitysmoduuli ohjaamaan palvelimeen http://mycompany.com/myproduct/infocenter
osoitetut pyynnöt palvelimeen http://internalserver:8081/help
, jossa Info Centeriä ajetaan. Tämä tehdään lisäämällä rivit
LoadModule proxy_module modules/ApacheModuleProxy.dll ProxyPass /myproduct/infocenter http://internalserver:8081/help ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help
Web-sivustoa mycompany ajavan Apache-palvelimen conf/httpd.conf
-tiedostoon.
Joissakin Apache HTTP -palvelimen versioissa voi olla AddDefaultCharset-ohjauskoodi otettuna käyttöön kokoonpanotiedostossa. Kun ohjauskoodi poistetaan tai korvataan
AddDefaultCharset Off
-määrityksellä, selaimet käyttävät asiakirjojen näyttämiseen oikeaa merkistöä.
Yhdestä asennuksesta voidaan ajaa koneessa useita Info Center -ilmentymiä. Jokaisen aloitetun ilmentymän täytyy käyttää omaa porttiaan ja saada työtila, minkä vuoksi asetukset -port
ja -data
täytyy määrittää. Ilmentymät voivat palvella dokumentaatiota eri lisäosajoukoista tuomalla käyttöön kelvollisen ympäristökokoonpanon asetuksella -configuration
.
Jos asetusta -configuration
ei käytetä ja kokoonpanohakemisto on usean Info Center -ilmentymän yhteiskäytössä siten, että paikallistunnukset menevät päällekkäin, on varmistettava, että yksi Info Center -ilmentymä luo kaikki hakuindeksit, ennen kuin toinen ilmentymä aloitetaan. Indeksit tallennetaan kokoonpanohakemistoon, eikä kirjoituskäyttöä synkronoida Info Center -ilmentymien kesken.
Suodatuksen tuki on pois käytöstä, kun ohjetta käytetään Info Center -tilassa, jolloin kaikki sisältö, myös suodatettu sisältö, on näkyvissä. Jos aiot sijoittaa ohjeet sekä työympäristöön että Info Center -tilaan, käytä suodattimia tavalla, josta on hyötyä myös silloin, kun suodatus ei ole käytössä.
Info Center ei edellytä koko Eclipse-ympäristöpakettia. Info Centeriä voidaan ajaa seuraavien (eclipse\plugins
-hakemistossa sijaitsevien) lisäosien avulla:
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
Joillakin dokumentaatiolisäosilla voi olla riippuvuuksia muista lisäosista, ja pakolliset lisäosat määritetään yleensä niiden resurssijoukon manifest-tiedostossa. Alisteiset lisäosat on asennettava myös Info Centeriin.
Info Center -lisäosia voi päivittää aloittamatta Info Centeriä uudelleen käyttämällä kohdassa
Käynnissä olevan Info Centerin päivitys komentoriviltä selitettyjä komentoja. Jotta tätä toimintoa voisi käyttää, lisäosien vähimmäisjoukon täytyy sisältää org.eclipse.update.core
-lisäosa.
Kohdassa Tuotteen mukautus on lisätietoa ohjejärjestelmän mukautuksesta.