Infocenter

Du kan give dine brugere adgang til hjælpen via internettet eller et intranet ved at installere et infocenter og dokumentations-plugins på en server. Klienter få vist hjælp ved at navigere til en URL, og hjælpen vises i deres webbrowser. Infocenter-hjælpen kan både bruges til klientprogrammer og webprogrammer, og der kan oprettes ekstern adgang til hjælpen for begge dele. Alle funktioner i hjælpesystemet undtagen konteksthjælp, aktiv hjælp, kommandounderstøttelse og hjælpeoversigt understøttes.

Infocenter-hjælpen giver mulighed for at overføre en række parametre, der kan bruges til at tilpasse de forskellige aspekter i infocenteret. Følgende parametre er understøttet:

Installation/pakning

Følgende trin er skrevet til integratoren af hjælpen og beskriver ikke alle de mulige scenarier. Det forudsættes, at din dokumentation leveres i form af Eclipse-plugins, og at du har et generelt kendskab til Eclipse-hjælpen.

  1. Overfør styreprogrammet Eclipse Platform Runtime Binary til Eclipse-platformen fra eclipse.org.
  2. Installér (pak ud med unzip) programmet i et bibliotek, f.eks. d:\myApp. Det opretter underbiblioteket d:\myApp\eclipse, som indeholder den krævede kode til Eclipse-platformen, herunder hjælpen.

Sådan starter og stopper du infocenter fra kommandolinjen

Klassen org.eclipse.help.standalone.Infocenter har en main()-metode, som du kan bruge til at starte infocenteret fra en kommandolinje. Syntaksen for kommandolinjeargumentet er:

-command start | shutdown | [-eclipsehome installationssti] [-data forekomstområde] [-host hjælpeservervært] [-locales sprogkonventionsliste] [-port hjælpeserverport] [-dir rtl] [-noexec] [platformindstillinger] [-vmargs JavaVMarguments]

For at starte et infocenter på port 8081 skal du sende kommandoen start ved at udfø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

Luk infocenteret ned ved at sende kommandoen shutdown ved at udfø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

Brug af infocenteret

Start infocenteret med instruktionerne ovenfor. Dirigér en webbrowser til webprogrammet "/help" på en port, der angives, når infocenteret starter (f.eks. 8081). Det vil være http://localhost:8081/help/ på den maskine, hvor infocenteret er installeret.

Sådan starter og stopper du infocenter fra Java

Når infocenteret inkluderes som en del af et andet program, kan det være lettere at starte og stoppe det med et Java-API i stedet for med systemkommandoer. Sådan gør du:

  1. Kontrollér, at d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar er placeret i programmets classpath. Du bruger klassen eclipse.help.standalone.Infocenter til at starte og stoppe infocenteret.
  2. Opret et array af String, der indeholder de parametre, du vil overføre til infocenteret. Normalt er parametrene eclipsehome og port påkrævet.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
  3. Opret en forekomst af Help-klassen i dit program ved at overføre parametrene.
    Infocenter infocenter = new Help(options);
  4. Start hjælpen:
    helpSystem.start();
  5. Sådan stopper du infocenteret:
    helpSystem.shutdown();

Gør infocenteret tilgængeligt på nettet

Eclipse indeholder et komplet infocenter og kræver ikke andre serverprogrammer for at køre. I usikre miljøer, som f.eks. internettet, anbefales det ikke, at klienter opretter direkte adgang til infocenteret, men at infocenteret i stedet gøres tilgængeligt via en HTTP-server eller en programserver. De fleste servere leveres med moduler eller miniservere, der bruges til at delegere visse anmodninger til andre webressourcer. En server kan f.eks. konfigurere et proxymodul for Apache HTTP Server, som dirigerer anmodninger til http://mitfirma.com/mitprodukt/infocenter videre http://internalserver:8081/help, der afvikler et infocenter. Tilføj følgende linjer:

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

til conf/httpd.conf-filen for den Apache-server, der afvikler webstedet Mitfirma.

På nogle versioner af Apache HTTP-serveren kan direktivet AddDefaultCharset være aktiveret i konfigurationsfilen. Fjern direktivet, og erstat det med

AddDefaultCharset Off

for at lade browserne vise dokumenterne med det rigtige tegnsæt.

Afvikling af flere forekomster af infocenter

En maskine kan afvikle flere forekomster af et infocenter fra én installation. Hver startet forekomst skal bruge sin egen port og have et arbejdsområde, så du skal angive parametrene -port og -data. Forekomsterne kan betjene dokumentation fra forskellige sæt af plugins ved at stille en gyldig platformskonfiguration til rådighed med parameteren -configuration.

Hvis -configuration ikke bruges, og biblioteket configuration deles af flere infocenterforekomster med et overlappende sæt af sprogkonventioner, skal det kontrolleres, at alle søgeindekserne er oprettet af en infocenterforekomst, før den næste forekomst startes. Indekserne gemmes i biblioteket configuration, og skriveadgangen er ikke synkroniseret på tværs af infocenterforekomsterne.

Filtrering

Filtreringsunderstøttelse er deaktiveret, når hjælp afvikles i tilstanden infocenter, der bevirker, at alt indhold, herunder filtreret indhold, vises. Hvis du vil opbevare dokumentationen i både arbejdsbænk- og infocenter-tilstand, skal du anvende filtre på en måde, der giver mening, også hvis filtrering er deaktiveret.

[Valgfrit] Installation af et mindstesæt af plugins

Infocenteret kræver ikke hele Eclipse-platformspakken. Det er muligt at afvikle infocenteret med følgende plugins, som er placeret i biblioteket 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

Visse dokumentations-plugins kan være afhængige af andre plugins. Det gøres normalt ved at angive de krævede plugins i deres bundtmanifest. De afhængige plugins skal også være installeret på infocenteret.

Infocenter-plugins kan opdateres uden at genstarte infocenteret ved at bruge de kommandoer, der er beskrevet i emnet Opdatering af igangværende infocenter fra kommandolinjen. Mindstesættet af plugins skal omfatte plugin'en org.eclipse.update.core, for at du kan bruge denne funktionalitet.

Der er flere oplysninger om tilpasning af hjælpen under emnet Produkttilpasning.