Instalowanie systemu pomocy jako centrum informacyjnego

Aby umożliwić użytkownikom dostęp do systemu pomocy za pośrednictwem Internetu lub intranetu, można na serwerze zainstalować centrum informacyjne i moduły dodatkowe dokumentacji. Klient może wyświetlić pomoc, przechodząc pod odpowiedni adres URL - system pomocy jest wyświetlany w przeglądarce. System pomocy oparty na centrum informacyjnym może być używany przez aplikacje klienckie oraz aplikacje WWW. W każdym z tych dwóch typów aplikacji możliwy jest zdalny dostęp do pomocy. Obsługiwane są wszystkie funkcje systemu pomocy, z wyjątkiem pomocy kontekstowej i pomocy aktywnej.

System pomocy oparty na centrum informacyjnym umożliwia przekazanie wielu opcji, których można użyć w celu dostosowania różnych aspektów centrum informacyjnego. Obsługiwane są następujące opcje:

Instalacja/pakowanie

Poniższą procedurę przygotowano na potrzeby integratorów systemu pomocy (jednak nie obejmuje ona wszystkich możliwych sytuacji). Przyjęto założenie, że cała dokumentacja ma postać modułów dodatkowych Eclipse oraz że integrator zna system pomocy platformy Eclipse.

  1. Pobierz sterownik binarnego środowiska wykonawczego platformy Eclipse spod adresu www.eclipse.org.
  2. Zainstaluj (rozpakuj) sterownik w katalogu d:\myApp. Zostanie utworzony podkatalog o nazwie d:\myApp\eclipse zawierający kod wymagany przez platformę Eclipse (w tym system pomocy).

Uruchamianie i zatrzymywanie centrum informacyjnego przy użyciu wiersza komend

Klasa org.eclipse.help.standalone.Infocenter zawiera metodę main, która pozwala uruchamiać centrum informacyjne z poziomu wiersza komend. Składnia argumentów w wierszu komend wygląda następująco:

-command start | shutdown | [-eclipsehome ścieżka_instalacyjna_eclipse] [-data obszar_instancji] [-host host_serwera_pomocy] [-locales lista_ustawień_narodowych] [-port port_serwera_pomocy] [-dir rtl] [-noexec] [opcje platformy] [-vmargs argumenty_maszyny_Java_VM]

Aby uruchomić centrum informacyjne na porcie 8081, należy podać komendę start w następujący sposób:

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

Aby zamknąć centrum informacyjne, należy podać komendę shutdown w następujący sposób:

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

Korzystanie z centrum informacyjnego

Należy uruchomić serwer WWW. Potem trzeba w przeglądarce WWW podać ścieżkę aplikacji WWW "help" działającej na porcie określonym przy uruchamianiu centrum informacyjnego. Na komputerze, na którym jest zainstalowane centrum informacyjne, będzie to ścieżka http://localhost:8081/help/.

Uruchamianie i zatrzymywanie centrum informacyjnego przy użyciu kodu Java

Jeśli centrum informacyjne ma być częścią innej aplikacji, wygodniej jest uruchamiać i zatrzymywać je przy użyciu funkcji API w języku Java, a nie komend systemowych. W takim przypadku należy wykonać poniższe kroki:

  1. Sprawdź, czy ścieżka d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar została uwzględniona w ścieżce klasy aplikacji. Klasą używaną do uruchamiania i zamykania centrum informacyjnego jest klasa org.eclipse.help.standalone.Infocenter.
  2. Utwórz tablicę wartości typu String zawierającą opcje, które mają zostać przekazane do centrum informacyjnego. Zwykle potrzebne są opcje eclipsehome i port.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" }; 
  3. W aplikacji utwórz instancję klasy Help, przekazując odpowiednie opcje (options).
    Infocenter infocenter = new Help(options); 
  4. Aby uruchomić system pomocy:
    helpSystem.start();
  5. Aby zamknąć centrum informacyjne:

    helpSystem.shutdown(); 

Udostępnianie centrum informacyjnego w sieci WWW

Platforma Eclipse zawiera wszystkie elementy centrum informacyjnego i do jego uruchomienia nie wymaga innego oprogramowania serwerowego. Jednak w niezabezpieczonym środowisku (takim jak Internet) zaleca się, aby dostęp do centrum informacyjnego odbywał się za pośrednictwem serwera HTTP lub serwera aplikacji, a nie bezpośrednio z poziomu klienta. Większość serwerów dostarczana jest z modułami lub serwletami umożliwiającymi delegowanie żądań do innych zasobów WWW. Na przykład jeden z nich może konfigurować moduł proxy serwera HTTP Apache, tak aby żądania zasobu http://mycompany.com/myproduct/infocenter były przekierowywane na adres http://internalserver:8081/help, pod którym działa centrum informacyjne. W tym celu wystarczy dodać wiersze:

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

do pliku conf/httpd.conf serwera Apache obsługującego serwis WWW mycompany.

Niektóre wersje serwera HTTP Apache mogą w pliku konfiguracyjnym zawierać włączoną dyrektywę AddDefaultCharset. Dyrektywę tę należy usunąć albo zastąpić dyrektywą

AddDefaultCharset Off

tak, aby dokumenty w przeglądarce były wyświetlane przy użyciu poprawnego zestawu znaków.

Uruchamianie wielu instancji centrum informacyjnego

Pojedyncza instalacja na jednym komputerze umożliwia uruchamianie wielu instancji centrum informacyjnego. Każda uruchomiona instancja musi używać własnego portu i mieć udostępniony obszar roboczy, dlatego należy użyć opcji -port i -data. Poszczególne instancje mogą udostępniać dokumentacje z różnych zestawów modułów dodatkowych, pod warunkiem określenia poprawnej konfiguracji platformy przy użyciu opcji -configuration.

Jeśli opcja -configuration zostanie pominięta, a katalog konfiguracyjny jest współużytkowany przez wiele instancji centrum informacyjnego z pokrywającymi się zestawami ustawień narodowych, należy zadbać o to, aby wszystkie indeksy wyszukiwania zostały utworzone przez pojedynczą instancję centrum jeszcze przed uruchomieniem innej instancji. Indeksy są zapisywane w katalogu konfiguracyjnym, a dostęp do zapisu nie jest synchronizowany między różnymi procesami centrum informacyjnego.

[Krok opcjonalny] Instalowanie minimalnego zestawu modułów dodatkowych

Centrum informacyjne nie wymaga instalowania pełnego pakietu platformy Eclipse. Centrum informacyjne można uruchomić z następującymi modułami dodatkowymi (znajdują się one w katalogu 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

Niektóre moduły dodatkowe dokumentacji mogą być zależne od innych modułów dodatkowych. Jest tak zwykle w przypadku, gdy wpisano wymagane moduły do pliku plugin.xml. Zależne moduły dodatkowe także należy zainstalować na potrzeby centrum informacyjnego. Moduły dodatkowe, które utworzono dla platformy w wersji wcześniejszej niż Eclipse 3.0, wymagają do działania obecności modułu dodatkowego org.eclipse.core.runtime.compatibility.

Moduły dodatkowe centrum informacyjnego mogą być aktualizowane bez potrzeby jego ponownego uruchamiania. W tym celu można użyć komend opisanych w temacie Aktualizowanie działającego centrum informacyjnego przy użyciu wiersza komend. Aby można było użyć tej funkcji, minimalny zestaw modułów dodatkowych musi obejmować moduł org.eclipse.update.core.

Więcej informacji na temat dostosowywania systemu pomocy można znaleźć w sekcji Preferencje systemu pomocy.