Informasjonssenter

Du kan tillate at brukere får tilgang til hjelpesystemet via Internett eller et intranett ved å installere informasjonssenteret og plugin-modulen for dokumentasjonen på en server. Klientene viser hjelpen ved å navigere til en URL, og hjelpesystemet blir vist i nettleseren. Hjelpesystemet for informasjonssenteret kan brukes både for klientapplikasjoner og web-applikasjoner, som begge kan få tilgang til hjelpen eksternt. Alle funksjoner i hjelpesystemet unntatt konteksthjelp, aktiv hjelp, kommandostøtte og hjelpevisning støttes.

Hjelpesystemet for informasjonssenteret gjør det mulig å oppgi en rekke alternativer som kan brukes for å tilpasse forskjellige aspekter ved informasjonssenteret. Følgende alternativer støttes:

Installering/pakking

Disse trinnene gjelder for hjelpesystemintegratoren og har ikke til hensikt å ta for seg alle mulige scenarier. Det antas at all dokumentasjonen er i form av plugin-moduler for Eclipse, og at du generelt er kjent med Eclipse-hjelpesystemet.

  1. Last ned driveren Eclipse Platform Runtime Binary fra eclipse.org.
  2. Installer (unzip) driveren i en katalog, f.eks. d:\myApp. Dette vil opprette en Eclipse-delkatalog, d:\myApp\eclipse, som inneholder den nødvendige koden for Eclipse-plattformen (inkludert hjelpesystemet).

Slik starter eller stopper du informasjonssenteret fra kommandolinjen

Klassen org.eclipse.help.standalone.Infocenter har en main()-metode som du kan bruke for å starte informasjonssenteret fra en kommandolinje. Syntaksen for kommandolinjeargumentet er:

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

Hvis du vil starte et informasjonssenter på port 8081, sender du en start-kommando ved å kjøre

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

Hvis du vil avslutte informasjonssenteret, sender du en shutdown-kommando ved å kjøre

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

Bruke informasjonssenteret

Start informasjonssenteret etter instruksjonene ovenfor. Bruk en nettleser og pek på "/help" til web-applikasjonen som kjøres på porten som oppgis når informasjonssenteret starter (f.eks. 8081). Dette kan for eksempel, fra maskinen der informasjonssenteret er installert, være http://localhost:8081/help/.

Slik starter eller stopper du et informasjonssenter fra Java

Når du tar med et informasjonssenter som en del av en annen applikasjon, kan det være enklere å starte og stoppe den med Java-APIer i stedet for å bruke systemkommandoer. I dette tilfellet gjør du slik:

  1. Kontroller et d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar er i applikasjonens klassebane. Klassen du bruker for å starte og avslutte informasjonssenteret, er org.eclipse.help.standalone.Infocenter.
  2. Opprett en matrise av String-objekter som inneholder alternativer som du vil sende til informasjonssenteret. Vanligvis trenger du alternativene eclipsehome og port.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
  3. I applikasjonen oppretter du en forekomst av klassen Help ved å sende alternativene.
    Infocenter infocenter = new Help(options);
  4. Slik starter du hjelpesystemet:
    helpSystem.start();
  5. Slik avslutter du informasjonssenteret:
    helpSystem.shutdown();

Gjøre informasjonssenteret tilgjengelig på nettet

Eclipse inneholder et fullstendig informasjonssenter og krever ikke at annen serverprogramvare kjøres. Men i usikre miljøer som Internett anbefales det at klienter ikke får direkte tilgang til informasjonssenteret, men at det gjøres tilgjengelig via en HTTP-server eller en applikasjonsserver. De fleste servere har moduler eller servletter for delegering av bestemte forespørsler til andre web-ressurser. Man kan for eksempel konfigurere en proxy-modul i Apache HTTP Server slik at forespørsler til http://mycompany.com/myproduct/infocenter blir omdirigert til http://internalserver:8081/help som kjører informasjonssenteret. Dette kan oppnås ved å legge til linjene

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

i conf/httpd.conf-filen til Apache-serveren som kjører nettstedet mycompany.

Noen versjoner av Apache HTTP-serveren kan inneholde et AddDefaultCharset-direktiv aktivert i konfigurasjonsfilen. Fjern direktivet eller erstatt det med

AddDefaultCharset Off

for å få nettlesere til å vise dokumenter med det riktige tegnsettet.

Kjøre flere forekomster av informasjonssenteret

Du kan kjøre flere forekomster av informasjonssenteret på en maskin fra en installering. Hver forekomst du starter, må bruke sin egen port og ha et arbeidsområde, og alternativene -port og -data må derfor oppgis. Forekomstene kan levere dokumentasjon fra forskjellige sett med plugin-moduler ved å oppgi en gyldig plattformkonfigurasjon med alternativet -configuration.

Hvis -configuration ikke blir brukt, og konfigurasjonskatalogen deles mellom flere forekomster av informasjonssenteret med overlappende sett med språkmiljøer, må du passe på at alle søkeindekser blir opprettet av en forekomst av informasjonssenteret før en annen forekomst blir startet. Indekser blir lagret i konfigurasjonskatalogen, og skrivetilgang blir ikke synkronisert på tvers av informasjonssenterforekomster.

Filtrering

Filtreringsstøtte slås av når du kjører hjelp i informasjonssenter-modus, slik at alt innhold, inkludert filtrert innhold, er synlig. Hvis du vil være vert for dokumentasjonen både på arbeidsbenken og i informasjonssenter-modus, bør du bruke filtre på en måte som gir mening dersom filtrering er slått av.

[Valgfritt] Installere et minimumssett med plugin-moduler

Informasjonssenteret krever ikke hele Eclipse-plattformpakken. Det er mulig å kjøre informasjonssenteret med følgende plugin-moduler (som ligger i katalogen eclipse\plugins):

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

Noen plugin-moduler for dokumentasjon kan ha avhengigheter på andre plugin-moduler, vanligvis ved å oppgi nødvendige plugin-moduler i buntmanifesten. De avhengige plugin-modulene må også installeres i informasjonssenteret.

Plugin-moduler for informasjonssenteret kan oppdateres uten å starte informasjonssenteret på nytt, ved hjelp av kommandoer som er forklart i emnet Oppdatere et informasjonssenter som kjøres, fra kommandolinjen. Hvis du vil bruke denne funksjonaliteten, må minimumssettet med plugin-moduler inneholde plugin-modulen org.eclipse.update.core.

Du finner flere opplysninger om hvordan du tilpasser hjelpesystemet, i emnet Produkttilpasning.