Pomoc HTML Help

Pliki w formacie CHM (HTML Help) są obecnie najpopularniejszą postacią pomocy w programach dla MS Windows.

Plik CHM zawiera zwykłe dokumenty HTML, oraz obrazki, spis treści, skorowidz, a także dane umożliwiające odwoływanie się do poszczególnych dokumentów z programu, do którego ww. pomoc jest utworzona.

Pająk wspomaga tworzenie takich plików udostępniając bardzo wygodny interfejs. Do skompilowania pliku CHM konieczne jest jednak zainstalowanie programu HTML Help Workshop.

Instalacja programu MS HTML Help Workshop

Program MS HTML Help Workshop należy pobrać ze strony Microsoft MSDN.

Po pobraniu programu należy go zainstalować w systemie.

Kolejną czynnością jest wskazanie w ustawieniach Pająka ścieżki dostępu do kompilatora HTML Help - programu hhc.exe. Standardowo jest ona następująca: C:\Program Files (x86)\HTML Help Workshop\hhc.exe.

Okno ustawień służące do wskazania ścieżki dostępu możesz wyświetlić korzystając z polecenia w Menu głównym / Wyświetl / Ogólne ustawienia programu / Dostosuj Tidy i dodatkowe narzędzia. Po uruchomieniu ww. okna przejdź do zakładki HTML Help i wskaż ścieżkę.

Szybkie kompilowanie folderu do pliku CHM

Najprostszym sposobem utworzenia pliku w formacie HTML Help jest skompilowanie całego folderu do pliku CHM. Możesz to zrobić korzystając narzędzia Szybki HTML Help z folderu. Narzędzie to uruchomisz korzystając z polecenia w Menu głównym / HTML Help / Kompilacja folderu do HTML Help.

Po wybraniu folderu do skompilowania i ustawieniu pozostałych opcji (tutaj dokładny opis okna) kliknij na przycisk "Kompiluj". narzędzie utworzy listę plików, a następnie skompiluje plik pomocy.

Jeśli kompilacja zostanie ukończona pomyślnie, wyświetlony zostanie raport o przebiegu kompilacji, a następnie pytanie, czy chcesz obejrzeć skompilowany plik CHM.

Kompilacja może potrwać od kilku do kilkudziesięciu sekund w zależności od szybkości komputera, a także ilości i wielkości plików wchodzących w skład docelowego pliku pomocy.

Korzystanie z Serwisu będącego projektem HTML Help

Znaczącym ułatwieniem podczas tworzenia pomocy w formacie CHM jest możliwość zdefiniowania Serwisu jako Projektu HTML Help. W tym celu zaznacz opcję "Ten serwis jest również projektem HTML Help" w drugiej zakładce okna Właściwości serwisu. Dzięki temu wszystkie ustawienia bieżącego projektu HTML Help będziesz miał w dostępne z jednego miejsca.

Przygotowanie projektu w Edytorze HTML Help

Po zaznaczeniu ww. opcji musisz jeszcze wykonać kilka czynności, aby utworzyć główny plik projektu (*.HHP). W tym celu kliknij w oknie ustawień serwisu na polecenie "Edytuj projekt". Spowoduje to otwarcie Edytora projektu HTML Help.

Pierwszą czynnością będzie wskazanie folderu, w którym znajdują się pliki mające wejść w skład projektu HTML Help. Wskazane jest, by wszystkie pliki wchodzące w skład tego projektu znajdowały się w tym folderze, lub w znajdujących się w nim podfolderach. Folder projektu wskażesz za pomocą polecenia w górnej części okna.

Następnie możesz kliknąć polecenie "Zapisz bieżący projekt HTML Help" znajdujące się z prawej strony. Zostaniesz poproszony o podanie nazwy docelowego pliku *.CHM. Kursor automatycznie zostanie umieszczony w odpowiednim polu Edytora w zakładce "Ogólne ustawienia projektu".

Kolejną czynnością będzie dodanie wszystkich plików, które mają wejść w skład pomocy, na listę "Pliki projektu przeznaczone do wkompilowania" w pierwszej zakładce okna edytora. Jest to ważne przede wszystkim dla plików, do których odsyłacze nie są jawnie zadeklarowane w dokumentach HTML Help, czyli np. do obrazków używanych w efektach podmiany po najechaniu kursorem myszy nad przycisk itp. Inne pliki, do których odsyłacze umieszczone są bezpośrednio w znacznikach HTML, kompilator dołączy do pliku CHM automatycznie.

Aby po otwarciu pliku CHM od razu widać było początkowy dokument, musisz go wskazać w polu "Domyślna strona startowa" (w lewej, górnej części drugiej zakładki edytora).

Utworzenie spisu treści

Aby ułatwić użytkownikom korzystanie z pomocy, należy utworzyć spis treści. W tym celu uruchom Edytor spisu treści HTML Help. Możesz to zrobić korzystając z polecenia w drugiej zakładce Edytora projektu HTML Help, jak również w Menu głównym / HTML Help. W pierwszym przypadku, po zapisaniu pliku spisu treści, zostanie on automatycznie przypisany do projektu. W przeciwnym wypadku nazwę pliku spisu treści będziesz musiał wpisać w ręcznie edytorze projektu.

W spisie treści możesz wstawiać Kategorie (w pomocy do Pająka są to np. 'foldery' Jak to wykonać? itp.), a w każdej kategorii możesz umieszczać jej elementy, jak kolejne podkategorie i pozycje. Możesz to zrobić korzystając z poleceń z prawej strony listy pozycji spisu treści.

Pozycja różni się od kategorii tym, iż nie może zawierać podelemetów. Możliwa jest jednak zamiana kategorii na pozycje i odwrotnie (w zakładce "Ustawienia elementu"). W tej samej zakładce możesz przypisać do każdej kategorii i pozycji dokument, który zostanie wyświetlony na ten element w spisie treści. Pamiętaj, aby po każdej zmianie w ustawieniach elementu kliknąć na przycisk "Aktualizuj dane elementu".

Szczegółowy opis narzędzia znajdziesz w temacie pomocy Edytor spisu treści HTML Help

Utworzenie indeksu

Indeks (skorowidz) umożliwia przeglądanie wszystkich tematów pomocy. Jest to lista wszystkich tematów, jakie są zawarte w pliku CHM.

Korzystając z Edytora indeksu HTML Help możesz utworzyć projekt skorowidza (plik *.HHK). Tworzenie go jest bardzo podobne do tworzenia spisu treści, przy czym nie można tworzyć kategorii - wszystkie elementy umieszczone są kolejno na jednej liście.

Aby szybko utworzyć skorowidz, możesz skorzystać z polecenia "Przekształć zawartość folderu na skorowidz", które znajdującego się z prawej strony listy skorowidza. W podmenu, które się pokaże, możesz ustawić kilka opcji w celu lepszego dopasowania skorowidza do Twoich potrzeb.

Wyszukiwanie w pomocy HTML Help
Aby dodać do pliku pomocy zestaw słów kluczowych ułatwiających wyszukiwanie, zaznacz opcję "Włącz słowa kluczowe z plików HTML" w Edytorze projektu HTML Help, w zakładce "Ogólne ustawienia projektu".

Kompilacja projektu w bieżącym serwisie

Gdy wszystko jest już przygotowane, możesz skompilować projekt. W tym celu skorzystaj z polecenia "Skompiluj projekt" w Menu głównym / HTML Help / HTML Help w bieżącym serwisie, bądź w oknie Właściwości serwisu.