Edytor pomocy kontekstowej

Pomoc zależna od kontekstu jest mechanizmem umożliwiającym łączenie części interfejsu użytkownika z konkretnym tematem pomocy. Kiedy użytkownik aktywuje powiązaną część interfejsu użytkownika, strona pomocy zostaje wyświetlona w obszarze pomocy dynamicznej. Interfejs użytkownika i strony pomocy są powiązane na dwa sposoby - jako statyczny plik XML lub dostawca kontekstu dynamicznego. Aby powiązać strony statycznie, konieczne jest utworzenie pliku XML pomocy kontekstowej. W tworzeniu tych stron pomaga edytor pomocy kontekstowej.

Na stronie edytora Definicja udostępniany jest widok graficzny pliku XML podzielony na dwie kolumny. Lewa kolumna jest zatytułowana Pomoc kontekstowa. Są w niej wyświetlane elementy XML w formacie drzewa wraz z działaniami dodania, przeniesienia i usunięcia. W drugiej kolumnie udostępnionych jest więcej szczegółowych informacji o elemencie wybranym w lewej kolumnie. Szczegóły można edytować.

Na stronie edytora Źródło dostępny jest widok tekstowy pliku XML. Plik XML można edytować bezpośrednio, a zmiany, o ile będą poprawne, zostaną uwzględnione w widoku graficznym na stronie Definicja.

Dodawanie nowych kontekstów pomocy

Edytor kontekstu pomocy z wypełnionymi polami

Aby dodać nowy kontekst, należy kliknąć opcję Dodaj kontekst. Spowoduje to dodanie nowej pozycji kontekstu do pliku XML i wyświetlenie jej w drzewie na stronie Definicja. Nowy kontekst zostanie wybrany i zostanie otwarta sekcja szczegółów w prawej kolumnie edytora. W tej sekcji można podać bardziej szczegółowe informacje dotyczące kontekstu, w tym:

Dodawanie tematów pomocy i komend

Dodanie kontekstu do pliku zapewni pomoc dynamiczną z podstawowym opisem wyświetlanym użytkownikowi. Zazwyczaj udostępnia się dodatkowe odsyłacze do tematów pokrewnych w systemie pomocy. W tym celu do pliku XML należy dodać tematy i komendy.

Edytor kontekstu pomocy z wypełnionymi polami szczegółów

Kliknięcie przycisku Dodaj temat spowoduje dodanie wpisu nowego tematu do pliku XML w obrębie jednego z kontekstów pomocy. Temat wyświetlany jest użytkownikowi jako odsyłacz. Po utworzeniu nowego tematu można go wybrać, aby otworzyć sekcję Szczegóły tematu w prawej kolumnie na stronie Definicja. W sekcji szczegółów można zmieniać etykietę, która będzie wyświetlana, i położenie pliku, do którego prowadzi odsyłacz. W większości przypadków połączony plik będzie stroną HTML w systemie pomocy. Przy użyciu przycisku Przeglądaj można wyszukać plik do połączenia.

Oprócz tematów, można także dodać komendę. Komenda wyświetlana jest użytkownikowi tak samo jako temat. Jednak po aktywowaniu odsyłacza zamiast otwarcia pliku wykonywana jest komenda kodu. Przy użyciu komend można otwierać strony preferencji i wykonywać inne działania.

Komenda dodania edytora kontekstu pomocy

W celu dodania nowej komendy należy kliknąć przycisk Dodaj komendę. Edycja szczegółów komendy odbywa się tak samo jak edycja tematów.

Komendy Usuń, W górę i W dół

Na stronie Definicja dostępne są trzy dodatkowe przyciski, które umożliwiają zmianę kolejności elementów na liście kontekstów i usuwanie ich.

Kontekst pomocy z przyciskami manipulacyjnymi

Są to następujące przyciski:

Rejestrowanie pliku pomocy kontekstowej

Aby środowisko Eclipse rozpoznawało plik XML pomocy kontekstowej jako źródło dla systemu pomocy dynamicznej, plik ten musi zostać zarejestrowany przy użyciu punktu rozszerzenia org.eclipse.help.contexts. Edytor umożliwia automatyczną rejestrację pliku pomocy kontekstowej. W prawym górnym rogu edytora znajduje się odsyłacz Zarejestruj ten plik pomocy kontekstowej. Kliknięcie tego odsyłacza spowoduje dodanie poprawnego wpisu do pliku plugin.xml.