System pomocy Eclipse można odpowiednio skonfigurować i oznaczyć marką w celu dostosowania go do określonego produktu. W tym celu wystarczy określić niestandardowe wartości domyślne dla preferencji systemu pomocy.
System pomocy jest podzielony na wiele oddzielnych modułów dodatkowych.
W poniższych tabelach pokazano dostępne preferencje definiowane dla poszczególnych modułów dodatkowych. Informacje na temat modyfikowania tych preferencji można znaleźć w sekcji Dostosowywanie produktu.
Klucz preferencji | Opis |
Domyślnie |
baseTOCS | Porządek spisów treści. Uporządkowana lista spisów treści pomocy (podręczników) określająca kolejność ich wyświetlania. Wszystkie pozostałe spisy treści będą znajdować się za tymi podręcznikami. Niedostępne spisy treści znajdujące się na tej liście będą ignorowane. Należy podać położenie poszczególnych spisów treści w następujący sposób: /IdModułuDodatkowego/ścieżka/do/toc.xml. | /org.eclipse.platform.doc.user/toc.xml, /org.eclipse.jdt.doc.user/toc.xml, /org.eclipse.platform.doc.isv/toc.xml, /org.eclipse.jdt.doc.isv/toc.xml, /org.eclipse.pde.doc.user/toc.xml |
ignoredTOCS | Wyłączenie spisów treści. Lista spisów treści pomocy (podręczników), które zostaną zignorowane przez system pomocy. Wyłączone spisy treści nie będą wyświetlane na liście podręczników i nie będą mogły zostać dowiązane. Tematy zdefiniowane w wyłączonych spisach treści nie będą dostępne w procesie wyszukiwania. Niedostępne spisy treści znajdujące się na tej liście będą ignorowane. Należy podać położenie poszczególnych spisów treści w następujący sposób: /IdModułuDodatkowego/ścieżka/do/toc.xml. |
Klucz preferencji | Opis |
Domyślnie |
banner | Położenie baneru wyświetlanego w górnej ramce. Przykład: banner=/org.eclipse.help.webapp/advanced/banner.html |
|
banner_height | Wysokość ramki baneru. Przykład: banner_height=60 |
|
help_home | Strona wyświetlana w obszarze treści podczas otwierania pomocy. Należy podać odpowiednią stronę html w następujący sposób: /IdModułuDodatkowego/ścieżka/do/home.html. | /org.eclipse.help.base/doc/help_home.html |
linksView | Można ustawić wartość true lub false w celu określenia, czy ma być wyświetlany widok odsyłaczy do stron pokrewnych. Uwaga: Ta opcja nie ma wpływu na centrum informacyjne. |
true |
bookmarksView | Można ustawić wartość true lub false w celu określenia, czy ma być widoczny widok zakładek. Uwaga: Ta opcja nie ma wpływu na centrum informacyjne. |
true |
windowTitlePrefix | Można ustawić wartość true lub false w celu określenia sposobu wyświetlania tytułu okna przeglądarki. W przypadku wartości true tytuł będzie wyświetlany w formie Pomoc - <NAZWA_PRODUKTU>, w przeciwnym razie tytułem będzie tylko <NAZWA_PRODUKTU> (gdzie <NAZWA_PRODUKTU> to nazwa produktu Eclipse ustawiona w składniku podstawowym). | true |
loadBookAtOnceLimit | Maksymalna liczba tematów zawartych w podręczniku, które przeglądarka może załadować jako pojedynczy dokument (ze strukturą nawigacyjną). Struktura nawigacyjna większych podręczników jest ładowana dynamicznie po kilka poziomów równocześnie. Podczas rozwijania kolejnych gałęzi są w razie potrzeby ładowane następne tematy. | 1000 |
dynamicLoadDepthsHint | Proponowana liczba poziomów struktury nawigacyjnej tematów pobieranych przez przeglądarkę w przypadku większych podręczników.
Wartość ta musi być większa od 0. W przypadku dużych drzew rzeczywista liczba poziomów może być inna, jeśli proponowana liczba poziomów obejmuje bardzo dużą liczbę tematów. |
3 |
imagesDirectory | Katalog zawierający obrazy używane w widoku pomocy. Obrazy muszą mieć takie same nazwy jak te w module dodatkowym org.eclipse.help.webapp. Należy użyć formatu /IdModułuDodatkowego/katalog. | images |
advanced.toolbarBackground | Tło CSS dla pasków narzędzi. Wartość tej preferencji jest używana w przeglądarkach wyświetlających zaawansowany interfejs użytkownika systemu pomocy. | ButtonFace |
advanced.viewBackground | Tło CSS dla widoków nawigacyjnych. Wartość tej preferencji jest używana w przeglądarkach wyświetlających zaawansowany interfejs użytkownika systemu pomocy. | Window |
advanced.toolbarFont | Czcionka CSS dla pasków narzędzi. Wartość tej preferencji jest używana w przeglądarkach wyświetlających zaawansowany interfejs użytkownika systemu pomocy. | icon |
advanced.viewFont | Czcionka CSS dla widoków nawigacyjnych. Wartość tej preferencji jest używana w przeglądarkach wyświetlających zaawansowany interfejs użytkownika systemu pomocy. | icon |
basic.toolbarBackground | Kolor tła dla pasków narzędzi. Wartość tej preferencji jest używana w przeglądarkach wyświetlających podstawowy interfejs użytkownika systemu pomocy. | #D4D0C8 |
basic.viewBackground | Kolor tła dla widoków nawigacyjnych. Wartość tej preferencji jest używana w przeglądarkach wyświetlających podstawowy interfejs użytkownika systemu pomocy. | #FFFFFF |
locales | Lista ustawień narodowych, które centrum informacyjne będzie rozpoznawać i dla których będzie udostępniać dostosowaną treść. Jeśli ustawienia narodowe (lub języki) akceptowane przez przeglądarkę klienta nie pasują do żadnej pozycji tej listy, treść do przeglądarki będzie przesyłana na podstawie domyślnych ustawień narodowych (ustawień serwera lub ustawień określonych przy użyciu opcji -nl wiersza komend platformy Eclipse). Jeśli lista nie zostanie określona, treść do przeglądarki będzie przesyłana na podstawie jej własnych preferowanych ustawień narodowych. Uwaga: Pominięcie tej opcji może spowodować duże zapotrzebowanie na pamięć i miejsce na dysku, ponieważ struktury nawigacyjne i indeksy będą tworzone dla wszystkich preferowanych ustawień narodowych poszczególnych przeglądarek mających dostęp do centrum informacyjnego. Przykład: locales=en ja zh_CN zh_TW |
|
productIndex | Jeśli razem z produktem udostępniono wstępnie utworzony indeks dokumentacji, należy przy użyciu tej preferencji określić identyfikator modułu dodatkowego zawierającego indeks. | |
always_external_browser |
Można zdecydować, że ma być używana (jeśli jest to możliwe) przeglądarka wbudowana (w systemach Windows i Linux) lub że zawsze ma być używana przeglądarka zewnętrzna. Ustawienie wartości true wymusi stosowanie przeglądarki zewnętrznej. Ustawienie tej preferencji nie przynosi żadnego efektu, jeśli w przypadku danej platformy nie jest dostępna przeglądarka wbudowana. |
false |
default_browser | Domyślna przeglądarka zewnętrzna. Identyfikator zewnętrznej przeglądarki WWW (zarejestrowanej w punkcie rozszerzenia org.eclipse.help.base.browser), która ma być używana przez system pomocy. Metoda available() adaptera przeglądarki musi zwracać wartość true w bieżącym systemie. Ta opcja steruje zewnętrznymi przeglądarkami w autonomicznym trybie systemu pomocy. W trybie środowiska roboczego system pomocy korzysta z przeglądarek udostępnianych przez funkcję obsługi przeglądarki środowiska roboczego. |
Wartość domyślna określana dynamicznie na podstawie przeglądarki dostępnej w danym systemie |
custom_browser_path | Ścieżka do pliku wykonywalnego przeglądarki niestandardowej. Ta opcja steruje zewnętrznymi przeglądarkami w autonomicznym trybie systemu pomocy. W trybie środowiska roboczego system pomocy korzysta z przeglądarek udostępnianych przez funkcję obsługi przeglądarki środowiska roboczego. |
C:\Program
Files\Internet Explorer\IEXPLORE.EXE" %1 - w systemie Windows "konqueror %1" - w systemie Linux "mozilla %1" - na innych platformach |
showDisabledActivityTopics | System pomocy odfiltrowuje tematy dotyczące wyłączonych możliwości. Ta opcja pozwala sterować tym działaniem i widocznością przycisku Pokaż wszystkie tematy. Dopuszczalne wartości: never, off, on, always. never - tematy dotyczące wyłączonych możliwości nie są wyświetlane. off - użytkownik może sam zdecydować o wyświetleniu wszystkich tematów, przy czym tematy dotyczące wyłączonych możliwości są wstępnie ukryte. on - użytkownik może sam zdecydować o wyświetleniu wszystkich tematów, przy czym tematy dotyczące wyłączonych możliwości są wstępnie widoczne. always - tematy dotyczące wyłączonych możliwości są wyświetlane (filtrowanie jest wyłączone). |
off |
activeHelp | Pozwala włączyć lub wyłączyć pomoc aktywną.
Opcja nie ma wpływu na konfigurację centrum informacyjnego, w której pomoc aktywna jest wyłączona. Dopuszczalne wartości: true - pomoc aktywna jest włączona (wartość domyślna). false - pomoc aktywna jest wyłączona. |
true |
window_infopop | Umożliwia włączenie informacji wywoływanych w starym stylu, wyświetlanych po naciśnięciu przycisku pomocy w oknach środowiska roboczego. W przypadku wartości false otwarty zostanie w zastępstwie nowy dynamiczny widok pomocy. | false |
dialog_infopop |
Umożliwia włączenie informacji wywoływanych w starym stylu, wyświetlanych po naciśnięciu przycisku pomocy w oknach dialogowych. W przypadku wartości false otwarte zostanie w zastępstwie nowe dynamiczne okno pomocy. |
false |
Klucz preferencji | Opis |
Domyślnie |
port | Numer portu, na którym serwer nasłuchuje żądań http. Jeśli nie podano portu, system wybiera dowolny port. | |
host |
Adres lub nazwa hosta używanego do nawiązywania połączenia z serwerem. W przypadku tej preferencji nie ma wartości domyślnej. Platforma Eclipse wybierze dostępny adres lokalny. Produkty korzystające z systemu pomocy w trybie lokalnym (tryb środowiska roboczego lub autonomiczny,
a nie tryb centrum informacyjnego) mogą ustawić tę opcję na wartość "127.0.0.1",
aby nie prezentować serwera pomocy dla innych użytkowników w sieci. |
Klucz preferencji | Opis |
Domyślnie |
acceptCount | Maksymalna długość kolejki przychodzących żądań dotyczących połączeń, gdy wszystkie możliwe wątki przetwarzania żądań są zajęte. Wszystkie żądania otrzymane po zapełnieniu kolejki będą odrzucane. | 100 |
maxProcessors |
Maksymalna liczba wątków przetwarzania żądań, które może utworzyć dany łącznik. Ta wartość określa także maksymalną liczbę równocześnie obsługiwanych żądań. |
75 |
minProcessors |
Liczba wątków przetwarzania żądań, które zostaną utworzone po pierwszym uruchomieniu łącznika. Ten atrybut powinien być ustawiony na wartość mniejszą niż wartość atrybutu maxProcessors. |
5 |