Infocenter

Du kan ge användare åtkomst till hjälpsystemet via Internet eller ett intranät genom att installera ett infocenter och insticksprogrammen för dokumentationen på en server. Klienter kan visa hjälpsystemet i webbläsaren genom att bläddra till en URL-adress. Hjälpsystemet för infocenter kan användas i både klient- och webbtillämpningar. I båda fallen kan hjälpen kan öppnas via en fjärranslutning. Alla funktioner i hjälpsystemet, förutom sammanhangsberoende hjälp, aktiv hjälp, kommandofunktioner och hjälpvyn, kan användas.

För infocenterhjälpsystemet går det att överföra ett antal alternativ för anpassning av olika aspekter av infocenter. Följande alternativ finns:

Installation/paketering

De här anvisningarna används av hjälpsystemintegratören och är inte ämnade för alla tänkbara scenarion. Det antas att all dokumentation levereras som Eclipse-insticksprogram och att du i det stora hela är bekant med Eclipse-hjälpsystemet.

  1. Hämta drivrutinen Eclipse Platform Runtime Binary från eclipse.org.
  2. Installera (zippa upp) drivrutinen i en katalog, till exempel d:\myApp. Då skapas en Eclipse-underkatalog, d:\myApp\eclipse, som innehåller den kod som krävs för Eclipse-plattformen (där hjälpsystemet ingår).

Så här startar och stoppar du infocenter från en kommandorad

Klassen org.eclipse.help.standalone.Infocenter har en main()-metod som du kan använda till att starta infocenter från kommandoraden. Syntax för kommandoradsargumentet är:

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

Om du vill starta ett infocenter vid port 8081 utfärdar du ett startkommando genom att köra

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

Om du vill stänga infocenter utfärdar du ett avstängningskommando genom att köra

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

Använda infocenter

Starta infocenter med hjälp av anvisningarna ovan. Ange sökvägen för den hjälpwebbtillämpning ("/help") som körs på den port som anges när infocenter startas (till exempel 8081). Om du till exempel använder den dator där infocenter är installerad är sökvägen http://localhost:8081/help/.

Så här startar och stoppar du infocenter från Java

När du använder infocenter som en del av en annan tillämpning kan det vara mer praktiskt att starta det och sluta använda anrop till Java-API:er i stället för systemkommandon. Om så är fallet följer du nedanstående anvisningar:

  1. Kontrollera att d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar finns i sökvägen för tillämpningen. Den klass du använder till att starta och stänga infocenter är org.eclipse.help.standalone.Infocenter .
  2. Skapa en matris av strängobjekt som innehåller alternativ som du vill överföra till infocenter. Vanligen behövs alternativen eclipsehome och port.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
  3. I tillämpningen skapar du en förekomst av klassen Help genom att överföra alternativen.
    Infocenter infocenter = new Help(options);
  4. Så här startar du hjälpsystemet:
    helpSystem.start();
  5. Så här stänger du infocenter:
    helpSystem.shutdown();

Göra infocenter tillgängligt på webben

Eclipse innehåller ett fullständigt infocenter och det är inte nödvändigt att någon annan serverprogramvara körs. I osäkra miljöer, till exempel Internet, bör dock infocenter inte öppnas direkt av klienter utan göras tillgängligt via en HTTP-server eller tillämpningsserver. I de flesta servrar finns moduler eller servletprogram för delegering av vissa begäran till andra webbresurser. Till exempel kan det vara möjligt att konfigurera en proxymodul för Apache HTTP Server för omdirigering av begäran till http://mycompany.com/myproduct/infocenter till http://internalserver:8081/help som kör ett infocenter. Det kan du åstadkomma genom att lägga till raderna

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

till conf/httpd.conf-filen för den Apache-server där mycompany-webbplatsen körs.

Vissa versioner av Apache HTTP-servern kan innehålla ett AddDefaultCharset-direktiv som aktiveras i konfigurationsfilen. Ta bort direktivet eller ersätt det med

AddDefaultCharset Off

så visas dokument med rätt teckenuppsättning i webbläsare.

Köra flera förekomster av infocenter

Flera förekomster av infocenter kan köras i en dator från en installation. Varje aktiverad förekomst måste ha en separat port och arbetsmiljö. Därför måste värden för alternativen -port och -data anges. Förekomsterna kan tillhandahålla dokumentation från olika uppsättningar av insticksprogram genom att tillhandahålla en giltig plattformskonfiguration med alternativet -configuration.

Om -configuration inte används och konfigurationskatalogen delas av flera infocenterförekomster, med överlappande språkmiljöer, måste du kontrollera att alla sökindex har skapats av en infocenterförkomst innan en annan förekomst startas. Index sparas i konfigurationskatalogen och skrivbehörighet synkroniseras inte för flera infocenterförekomster.

Filtrering

Funktioner för filtrering avaktiveras i infocenterläge, vilket gör att allt innehåll, inklusive filtrerat innehåll, visas. Om du vill att din dokumentation ska vara tillgänglig i både arbetsmiljö- och infocenterlägena bör du använda filter på ett sätt så att visningen blir logisk även när filtrering är avaktiverat.

[Valfritt] Installera en minimal uppsättning insticksprogram

För infocenter krävs inte hela Eclipse-plattformspaketet. Det är möjligt att köra infocenter med följande insticksprogram (som finns 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

Vissa insticksprogram för dokumentation kan ha beroenden för andra insticksprogram, vanligen genom att de anger nödvändiga insticksprogrammen i samlingspaketsmanifestet. De beroende insticksprogrammen måste också installeras i infocenter.

Infocenterinsticksprogram kan uppdateras utan att infocenter startas om med hjälp av kommandon som förklaras i avsnittet Uppdatera en aktivt infocenter från kommandoraden. Om du vill använda den här funktionen måste även insticksprogrammet org.eclipse.update.core ingå i den minimala uppsättningen av insticksprogram.

Mer information om anpassning av hjälpsystemet finns i avsnittet om produktanpassning.