Informatiecentrum

U kunt uw gebruikers toegang verlenen tot een Help-systeem op internet of een intranet door een informatiecentrum en de documentatieplugins te installeren op een server. De clients bekijken Help door te navigeren naar een URL, waarna het Help-systeem in de webbrowser wordt afgebeeld. Het Help-systeem van het Informatiecentrum kan zowel worden gebruikt voor client- als webtoepassingen, en van beide kan Help op afstand worden geraadpleegd. Alle features van het Help-systeem worden ondersteund, met uitzondering van specifieke Help, actieve Help, ondersteuning voor opdrachten en de view Help.

Het Informatiecentrum-Helpsysteem maakt het mogelijk een aantal opties door te geven die kunnen worden gebruikt voor het aanpassen van verschillende aspecten van het Informatiecentrum. De volgende opties worden ondersteund:

Installatie/inpakken

Deze stappen zijn voor de Help-systeemintegrator en zijn niet bedoeld voor alle andere mogelijke scenario's. Verondersteld wordt dat al uw documentatie wordt geleverd als Eclipse-plugins en dat u in het algemeen bekend bent met het Eclipse-Helpsysteem.

  1. Download het stuurprogramma Eclipse Platform Runtime Binary van eclipse.org.
  2. Installeer het stuurprogramma (pak het bestand uit) in een directory, bijvoorbeeld d:\myApp. Hierdoor wordt een subdirectory d:\myApp\eclipse gemaakt met de vereiste code voor het Eclipse-platform (dat het Help-systeem bevat).

Het Informatiecentrum starten of stoppen vanaf een opdrachtregel

De klasse org.eclipse.help.standalone.Infocenter class heeft een main()-methode waarmee u het Informatiecentrum kunt starten vanaf een opdrachtregel. De syntaxis voor de opdrachtregel(argumenten) is:

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

Om het Informatiecentrum te starten op poort 8081, typt u de volgende start-opdracht:

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 het Informatiecentrum af te sluiten, typt u de volgende shutdown-opdracht:

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

Het Informatiecentrum gebruiken

Start het Informatiecentrum volgens de bovenstaande instructies. Verwijs de webbrowser naar de subdirectory "/help" van de webtoepassing die wordt uitgevoerd op de poort waarop het Informatiecentrum is gestart (bijvoorbeeld 8081). Op de machine waarop het Informatiecentrum is geïnstalleerd, is dit bijvoorbeeld http://localhost:8081/help/.

Het Informatiecentrum starten en stoppen vanuit Java

Wanneer het Informatiecentrum is opgenomen als onderdeel van een andere toepassing, kan het handiger zijn het Informatiecentrum te starten en af te sluiten met Java-API-aanroepen in plaats van systeemopdrachten. In dat geval gaat u als volgt te werk:

  1. Zorg ervoor dat d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar zich op het klassenpad van uw toepassing bevindt. De klasse die u gebruikt om het Informatiecentrum te starten en af te sluiten is org.eclipse.help.standalone.Infocenter.
  2. Definieer een aantal String-objecten met opties die u aan het Informatiecentrum wilt doorgeven. Gewoonlijk zijn de opties eclipsehome en port vereist.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
  3. Maak in uw toepassing een instance van de klasse Help door de opties door te geven.
    Infocenter infocenter = new Help(options);
  4. Om het Help-systeem te starten, gebruikt u:
    helpSystem.start();
  5. Om het Help-systeem af te sluiten, gebruikt u:
    helpSystem.shutdown();

Het Informatiecentrum op het web beschikbaar stellen

Eclipse bevat een volledig Informatiecentrum en heeft geen andere serversoftware nodig om te worden uitgevoerd. In een onveilige omgeving zoals internet is echter het verstandig om de clients niet direct toegang tot het Informatiecentrum te geven, maar het Informatiecentrum beschikbaar te stellen via een HTTP-server of een toepassingenserver. De meeste servers bevatten modules of servlets om bepaalde aanvragen naar andere webresources te delegeren. U kunt bijvoorbeeld een proxymodule van een Apache HTTP Server configureren om aanvragen aan http://mycompany.com/myproduct/infocenter door te verwijzen naar http://internalserver:8081/help waarop een informatiecentrum wordt uitgevoerd. Wanneer de regels

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

worden toegevoegd aan het bestand conf/httpd.conf op de Apache-server van de website mycompany, wordt dit bereikt.

Bij sommige versies van de Apache-HTTP-server bevat het configuratiebestand mogelijk de geactiveerde instructie AddDefaultCharset. Verwijder deze instructie of vervang de instructie door

AddDefaultCharset Off

zodat de browsers de documenten met de juiste tekenset weergeven.

Meerdere instances van Informatiecentrum uitvoeren

Op een machine van een installatie kunnen meerdere instances van een Informatiecentrum worden uitgevoerd. Elke gestarte instance moet een eigen poort gebruiken en moet worden voorzien van een werkgebied. Dit betekent dat de opties -port en -data moeten worden opgegeven. De instances kunnen documentatie aanbieden van verschillende pluginsets, door een geldige platformconfiguratie te leveren met de optie -configuration.

Als de optie -configuration niet wordt gebruikt en de configuratiedirectory gemeenschappelijk wordt gebruikt door verschillende instances van Informatiecentrum met elkaar gedeeltelijk overlappende localesets, moet u ervoor zorgen dat alle zoekindexen gemaakt worden door één instance van Informatiecentrum voordat een andere instance wordt gestart. Indexen worden opgeslagen in de configuratiedirectory en schrijftoegang wordt niet gesynchroniseerd tussen verschillende instances van Informatiecentrum.

Filteren

De ondersteuning voor filters wordt uitgeschakeld in de werkstand Informatiecentrum zodat alle content, inclusief gefilterde content, zichtbaar is. Als u van plan bent om uw documentatie zowel in de workbench- als de informatiecentrumwerkstand te hosten, dient u de filters zodanig te definiëren dat deze ook een logisch geheel opleveren als ze uitgeschakeld worden.

[Optioneel] Een minimale set plugins installeren

Het Informatiecentrum heeft niet het hele Eclipse-platformpakket nodig. Het is mogelijk een Informatiecentrum met de volgende plugins uit te voeren (deze bevinden zich in de directory 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

Een aantal documentatieplugins kan dependency's hebben op andere plugins, meestal door de vereiste plugins in hun bundelmanifest op te geven. De afhankelijke plugins moeten ook op het Informatiecentrum worden geïnstalleerd.

Informatiecentrumplugins kunnen, zonder dat het Informatiecentrum opnieuw gestart hoeft te worden, worden bijgewerkt met behulp van de opdrachten die zijn besproken in het onderwerp Een Informatiecentrum dat wordt uitgevoerd vanaf een opdrachtregel bijwerken. Om deze functionaliteit te gebruiken, moet de minimale set plugins ook de plugin org.eclipse.update.core bevatten.

Zie het onderwerp Producten aanpassen voor meer informatie over het aanpassen van het Help-systeem.