Pomoc autonomiczna

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 zintegrowanej ze środowiskiem roboczym pomocy kontekstowej, widoku pomocy 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:

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 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_[wersja].jar została uwzględniona w ścieżce klasy aplikacji, gdzie [wersja] oznacza wersję wykorzystywanej wtyczki (np. org.eclipse.help.base_3.2.0.jar). Klasą używaną do włączania, uruchamiania i zamykania systemu pomocy jest klasa org.eclipse.help.standalone.Help.
  2. Utwórz tablicę obiektów typu String zawierającą opcje, które mają zostać przekazane do obsługi systemu pomocy. Zwykle potrzebna jest opcja eclipsehome.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
  3. Utwórz w aplikacji instancję klasy Help, przekazując odpowiednie opcje. 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 z wiersza komend

Klasa org.eclipse.help.standalone.Help zawiera metodę main, która pozwala uruchamiać autonomiczny system pomocy z 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_[wersja].jar org.eclipse.help.standalone.Help -command displayHelp

z katalogu d:\myApp\eclipse directory, gdzie wersja oznacza wersję wtyczki. 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_[wersja].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_[wersja].jar org.eclipse.help.standalone.Help -command start

[Opcjonalnie] Instalowanie minimalnego autonomicznego systemu pomocy

Autonomiczny system pomocy nie wymaga instalowania pełnego pakietu platformy Eclipse. Aby można go było uruchomić przy użyciu pliku binarnego środowiska wykonawczego RCP, wystarczy dodać następujące wtyczki do katalogu eclipse/plugins:

org.apache.lucene
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.ui
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.ui.forms

Uwaga: należy upewnić się, że w pliku eclipse/configuration/config.ini występuje następujący wiersz:

osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start, org.eclipse.core.runtime@start

Niektóre wtyczki dokumentacji mogą być zależne od innych wtyczek. Jest tak zwykle w przypadku, gdy wymagane wtyczki wpisano do manifestu. Wtyczki zależne także należy zainstalować. Ponadto wtyczki, które utworzono dla wersji wcześniejszej niż Eclipse 3.0, wymagają niejawnie do działania wtyczki org.eclipse.core.runtime.compatibility.

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