Centrum informacyjne

Użytkownicy mogą mieć dostęp do systemu pomocy przez Internet lub intranet, jeśli na serwerze zainstalowane zostaną centrum informacyjne oraz wtyczki dokumentacji. Klienty mają dostęp do pomocy przy użyciu adresu URL, a system pomocy jest widoczny w przeglądarce WWW. System pomocy centrum informacyjnego może być wykorzystywany zarówno w klientach, jak i aplikacjach WWW. W obu przypadkach pomoc może być dostępna zdalnie. Obsługiwane są wszystkie funkcje systemu pomocy oprócz pomocy kontekstowej, pomocy aktywnej, obsługi komend oraz widoku pomocy.

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:

Instalowanie/pakowanie

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

  1. Pobierz sterownik binarnego środowiska wykonawczego platformy Eclipse spod adresu eclipse.org.
  2. Zainstaluj (rozpakuj) sterownik w katalogu, na przykład 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 z wiersza komend

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

-command start | shutdown | [-eclipsehome ścieżkaInstalacyjnaEclipse] [-data obszarInstancji] [-host hostSerweraPomocy] [-locales listaUstawieńNarodowych] [-port portSerweraPomocy] [-dir rtl] [-noexec] [platform options] [-vmargs argumentyWirtualnejMaszynyJęzykaJava]

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

Uruchom centrum informacyjne w sposób opisany powyżej. Otwórz w przeglądarce WWW aplikację WWW "/help" działającą na porcie określonym przy uruchamianiu centrum informacyjnego (np. 8081). Jeśli znajduje się ona na tym samym komputerze co zainstalowane centrum informacyjne, adresem będzie 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 wykonaj następujące czynności:

  1. Upewnij się, że w ścieżce klasy aplikacji występuje d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar. Klasą używaną do uruchamiania i zamykania centrum informacyjnego jest klasa org.eclipse.help.standalone.Infocenter.
  2. Utwórz tablicę obiektów 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. Utwórz w aplikacji instancję klasy Help, przekazując odpowiednie opcje.
    Infocenter infocenter = new Help(opcje);
  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 jest dostarczanych z modułami lub serwletami umożliwiającymi delegowanie określonych żą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. Usuń tę dyrektywę lub zastąp ją następującą:

AddDefaultCharset Off

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 wtyczek, 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 przed uruchomieniem innej instancji. Indeksy są zapisywane w katalogu konfiguracyjnym, a dostęp do zapisu nie jest synchronizowany między różnymi instancjami centrum informacyjnego.

Filtrowanie

Podczas uruchamiania systemu pomocy w trybie centrum informacyjnego obsługa filtrowania jest wyłączana, co powoduje że widoczna jest cała treść, również ta filtrowana. Jeśli dokumentacja ma być udostępniana zarówno w trybie środowiska roboczego, jak i centrum informacyjnego, warto użyć filtrów, tak aby dokumentacja była sensowna nawet przy wyłączeniu filtrowania.

[Opcjonalnie] Instalowanie minimalnego zestawu wtyczek

Centrum informacyjne nie wymaga instalowania pełnego pakietu platformy Eclipse. Można je uruchomić z następującymi wtyczkami (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 wtyczki dokumentacji mogą być zależne od innych wtyczek. Jest tak zwykle w przypadku, gdy wymagane wtyczki wpisano do manifestu pakunku. Wtyczki zależne także należy zainstalować na potrzeby centrum informacyjnego.

Wtyczki 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 z wiersza komend. Aby można było użyć tej funkcji, minimalny zestaw wtyczek musi obejmować wtyczkę org.eclipse.update.core.

Więcej informacji na temat dostosowywania systemu pomocy zawiera temat Dostosowywanie produktu.