Instalowanie autonomicznego systemu pomocy

Systemu pomocy Eclipse można użyć nawet w przypadku tworzenia aplikacji, która nie jest oparta na platformie Eclipse. Aplikacja może zawierać pakiet instalacyjny autonomicznego systemu pomocy, który jest mniejszą wersją platformy Eclipse pozbawioną wszystkich funkcji poza systemem pomocy. Po zainstalowaniu aplikacja może wykonywać wywołania funkcji API (z poziomu menu Pomoc lub z poziomu innych obiektów interfejsu użytkownika) w celu uruchamiania przeglądarki pomocy. Autonomiczny system pomocy ma wszystkie funkcje zintegrowanego systemu pomocy, z wyjątkiem pomocy kontekstowej i pomocy aktywnej. W przypadku aplikacji opartej na innym środowisku niż Java lub w sytuacji, gdy aplikacja nie działa i jest konieczne wyświetlenie pomocy, autonomiczny system pomocy można wywołać przy użyciu powłoki systemu, skryptu powłoki lub skrótu znajdującego się na pulpicie. Można przy tym podać odpowiednie opcje w wierszu komend zamiast wywoływać funkcje API języka Java.

Autonomiczny system pomocy umożliwia przekazywanie wielu opcji, których można użyć do dostosowywania różnych aspektów systemu pomocy. 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 aplikacji d:\myApp. Zostanie utworzony podkatalog o nazwie d:\myApp\eclipse zawierający kod wymagany przez platformę Eclipse (w tym system pomocy).

Wywoływanie klas pomocy przy użyciu kodu Java

  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 systemu pomocy jest klasa org.eclipse.help.standalone.Help.
  2. Utwórz tablicę wartości typu String zawierającą opcje, które mają zostać przekazane do systemu pomocy. Zwykle potrzebna jest opcja eclipsehome.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" }; 
  3. W aplikacji utwórz instancję klasy Help, przekazując odpowiednie opcje (options). Ten obiekt powinien zostać zachowany do momentu zamknięcia aplikacji.
    Help helpSystem = new Help(options); 
  4. Aby uruchomić system pomocy:
    helpSystem.start(); 
  5. Aby wywołać pomoc w razie potrzeby:
    helpSystem.displayHelp(); 

    Można także wywołać pomoc ze wskazaniem konkretnych tematów lub plików ze spisami treści:

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. Aby uruchomić pomoc kontekstową, wywołaj metodę helpSystem.displayContext(contextId, x, y), gdzie contextId to pełny identyfikator kontekstu. Współrzędne ekranu x i y nie są aktualnie używane.
  7. Aby zamknąć system pomocy przy zamykaniu aplikacji:

    helpSystem.shutdown(); 

Wywoływanie pomocy przy użyciu wiersza komend

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

-command start | shutdown | (displayHelp [href]) [-eclipsehome ścieżka_instalacyjna_eclipse] [-data obszar_instancji] [-host host_serwera_pomocy] [-port port_serwera_pomocy] [-dir rtl] [opcje platformy] [-vmargs argumenty_maszyny_Java_VM]

Prostą metodą wyświetlenia pomocy jest użycie komendy

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp

w katalogu d:\myApp\eclipse. Aby wyświetlić konkretny plik ze spisem treści lub temat, należy użyć komendy:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm

Powyższe wywołania spowodują uruchomienie systemu pomocy i wyświetlenie tekstu pomocy oraz umożliwią użytkownikowi przeglądanie pomocy po wykonaniu komendy. Do sterowania systemem pomocy należy używać komend start, shutdown i displayHelp. Na przykład można użyć poniższej komendy:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command start

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

Autonomiczny system pomocy nie wymaga całego pakietu platformy Eclipse. Aby można go było uruchomić, wystarczą następujące moduły dodatkowe (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

W systemach Windows i Linux, aby zapewnić odpowiednią obsługę przeglądarek (wbudowanej przeglądarki Internet Explorer w systemie Windows i Mozilla w systemie Linux lub autonomicznej przeglądarki systemowej w systemie Windows), oprócz konfiguracji minimalnej są wymagane poniższe moduły dodatkowe i fragmenty.

org.eclipse.core.expressions
org.eclipse.help.ui
org.eclipse.jface
org.eclipse.swt
org.eclipse.swt.win32 lub org.eclipse.swt.gtk
org.eclipse.ui
org.eclipse.ui.workbench

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.

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

org.eclipse.help.base preferences