Konfigurowanie/instalowanie

W tej sekcji zawarto tematy związane z instalowaniem, konfigurowaniem i dostosowywaniem systemu pomocy do działania w różnych środowiskach i produktach.

Tryby pomocy

System pomocy może działać w trzech trybach: środowiska roboczego (normalnym), centrum informacyjnego i autonomicznym. Tryb środowiska roboczego służy do wyświetlania pomocy zintegrowanej z produktem, zazwyczaj za pośrednictwem menu Pomoc. Tryb ten oferuje też pomoc kontekstową i widok pomocy, które nie są dostępne w dwóch pozostałych trybach. Tryb autonomiczny służy tym samym celom, co tryb środowiska roboczego, ale jest przeznaczony do użycia w produktach, które nie są oparte na środowisku Eclipse (pomoc będzie mniej zintegrowana). Tryb centrum informacyjnego służy do wyświetlania pomocy przez stronę WWW. Szczegółowe informacje można uzyskać po kliknięciu na przedstawione powyżej odsyłacze.

Obsługa platformy pełnego klienta (RCP)

System pomocy jest opcjonalnym komponentem platformy pełnego klienta (Rich Client Platform, RCP). Nie jest on częścią minimalnego zestawu RCP, ale można go dodać, aby udostępnić pomoc w aplikacjach RCP.

Dostosowywanie produktów

System pomocy umożliwia korzystanie z preferencji, które umożliwiają dostosowanie go do potrzeb produktu. Preferencje umożliwiają oznakowanie marką, dostosowane wyglądu, włączanie lub wyłączanie funkcjonalności itp.

Wstępne indeksowanie

W przypadku produktów, które oferują dużą liczbę dokumentów pomocy, etap wstępnego indeksowania, który następuje przy pierwszej próbie wyszukiwania, może trwać długo. Aby uniknąć tego opóźnienia, można wstępnie poindeksować treść pomocy i dostarczyć dokumentację razem ze wstępnie zbudowanym indeksem. Należy jednak dokonać wyboru między wydajnością (unikanie etapu indeksowania) i przestrzenią na dysku (niezbędną do zapisania indeksu).