HTML Help - Edytor projektu HTML Help

Za pomocą edytora projektu HTML Help ustalamy wszystkie parametry projektu, oraz decydujemy o późniejszych właściwościach, jakie będzie miał utworzony z projektu plik CHM. Także w tym edytorze ustalamy, jakie dodajemy do projektu składniki.

Uruchamianie

Opisywane narzędzie możesz uruchomić za pomocą przycisku oznaczonego ikoną pokazaną powyżej. Przycisk uruchomienia tego okna znajduje się np. w menu HTML Help oraz na pasku narzędzi HTML Help.

Użycie edytora projektu

Edytor projektu podzielony jest na cztery części-zakładki, każda spełniający inną funkcję w procesie tworzenia projektu.

Pliki składowe projektu

Pliki projektu przeznaczone do wkompilowania
W jedynym, dużym oknie należy wczytać z dysku wszystkie pliki, jakie chcemy umieścić w projekcie. Do tego celu służy ikonka z plusem znajdująca się prawej stronie okna. Można dodawać wiele plików jednocześnie, lub, w czasie dalszego tworzenia projektu, dodawać również pojedyncze pliki. Ikona z minusem służy do usuwania zbytecznych plików.

Ogólne ustawienia projektu

W zakładce tej ustalamy takie parametry, jak domyślne ustawienia ogólne, parametry międzynarodowe języka i czcionek, rodzaje plików definicyjnych, oraz ustawienia samego kompilatora.


Domyślne parametry

  • Domyślny tytuł
    W tym polu wpisz domyślny tytuł okna pomocy. Wartość ta ma jednak mniejsze znaczenie niż tytuł zdefiniowany dla domyślnego okna.

  • Domyślna strona startowa
    Korzystając z rozwijanej listy wybierz plik, który będzie załadowany do okna HTML Help w momencie uruchomienia pliku CHM. Wartość ta ma jednak mniejsze znaczenie niż strona startowa zdefiniowana dla domyślnego okna.

  • Domyślne okno
    Korzystając z rozwijanej listy wybierz okno, które będzie używane do wyświetlania zawartości HTML Help. Lista może być na tym etapie pusta, bowiem okna definiuje się w następnej zakładce.

Ustawienia międzynarodowe

  • Język
    Z listy tej można wybrać język, w jakim napisane są strony wchodzące w skład projektu HTML Help.

  • Zestaw znaków
    Z listy tej można wybrać odpowiedni skrypt dla czcionki używanej na stronach projektu HTML Help.

  • Czcionka
    Korzystając z przycisku obok oznaczonym literką "A" móżna wybrać rodzaj czcionki, oraz jej rozmiar. Czcionka ta będzie miała zastosowanie w interfejsie skompilowanego pliku CHM - nie do wyświetlenia zawartości stron.

Pliki definicyjne projektu

  • Nazwa pliku CHM po kompilacji
    W polu tym jest miejsce na wpisanie nazwy pliku, jaka będzie nadana skompilowanemu plikowi HTML Help. Jeśli nie podasz rozszerzenia nazwy pliku (.chm), Pająk zrobi to automatycznie.

  • Nazwa pliku raportu
    Jeśli chcemy, by sporządzony został raport z kompilacji, należy w tym polu wpisać nazwę pliku raportu z rozszerzeniem (np. raport.txt).

  • Nazwa pliku spisu treści
    W polu tym należy wprowadzić nazwę pliku spisu treści, który ma być użyty do tego projektu HTML Help. Spis treści można utworzyć edytorem, jaki zostanie otwarty po kliknięciu na ikonkę obok pola. Jeśli plik ze spisem treści istnieje już na dysku, możesz wskazać go za pomocą okienka otwieranego przyciskiem obok.

  • Nazwa pliku skorowidza
    W polu tym należy wprowadzić nazwę pliku skorowidza (indeksu), który ma być użyty do tego projektu HTML Help. Skorowidz można utworzyć edytorem, jaki zostanie otwarty po kliknięciu na ikonkę obok pola. Jeśli plik indeksu istnieje już na dysku, możesz wskazać go za pomocą okienka otwieranego przyciskiem obok.

  • Automatyczne tworzenie spisu treści (.hhc) podczas kompilacji
    Włączenie tej opcji pozwala na automatyczne utworzenie spisu treści na podstawie znajdujących się w plikach składowych projektu tytułów stopnia pierwszego, drugiego, itd., odpowiednio zagnieżdżając poziomy. Funkcja ta działa tym poprawniej, im mniej poziomów uwzględniamy. Nazwami w spisie treści stają się tytuły danego stopnia.

    • Maks. poziom zagłębienia:
      W polu zdefiniować można, ile poziomów zagłębienia uwzględniać ma automatycznie tworzony spis treści.

  • Włącz słowa kluczowe z plików HTML
    Włączenie tej opcjio powoduje automatyczne utworzenie skorowidza na podstawie słów kluczowych znajdujących się w plikach składowych projektu. Słowa kluczowe tworzy się w specjalny sposób. Przykładowa definicja słowa kluczowego w pliku HTML może wyglądać następująco: 

    <object type="aplication/x-oleobject"
classid="clasid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
   <param name="Keyword" value="Pająk">
   <param name="Keyword" value="HTML">
   <param name="Keyword" value="PHP">
   <param name="Keyword" value="XHTML">
</object>
    W Pająku, na pasku narzędzi "HTML Help" znajduje się narzędzie do tworzenia słów kluczowych HTML Help.

Ustawienia kompilatora

  • Kompatybilność
    Opcja wybrana z listy określa zgodność z bibliotekami HTML Help. Nowsza wersja wymaga posiadania w systemie nowszej wersji przeglądarki MS Internet Explorer, ale daje również większe możliwości, jak np. tworzenie binarnych skorowidzów.

  • Bez folderów w pliku wynikowym
    Zaznaczenie tej opcji spowoduje wyłączenie z kompilacji wszystkich podfolderów w katalogu projektu.

  • Wsparcie dla rozszerzonej dekompilacji
    Opcja ta została dodana ze względu na obecność w specyfikacji HTML Help, jednakże nawet jej wyłączenie nie powoduje, iż dekompilacja projektu jest niemożliwa. Można odzyskać wszystko, oprócz definicji projektu (plik HHP).

  • Wkompiluj informację o wyszukiwaniu pełnotekstowym
    Zaznaczenie tej opcji pozwala utworzyć bazę dla pełnotekstowego wyszukiwania. Jest ona w formie osobnej zakładki w skompilowanym pliku CHM.

  • Nazwa pliku stop list dla wyszukiwania pełnotekstowego
    W tym polu wprowadź nazwę pliku z definicją stop list dla wyszukiwania pełnotekstowego. Zdefiniowanie takiego pliku oraz wpisanie w nim słów, które nie powinny być uwzględniane podczas wkompilowywania informacji o wyszukiwaniu pełnotekstowym, pozwalają zmniejszyć rozmiar pliku wynikowego CHM. Przykładowa lista takich słów może zawierać spójniki lub inne słowa, które nie mają znaczenia przy wyszukiwaniu. Plik stop listy definiuje się wpisując do niego po jednym słowie w każdym wierszu.

  • Utwórz binarny skorowidz
    Zaznaczenie tej opcji pozwala na utworzenie binarnej wersji skorowidza. W HTML Help istnieją dwie wersje indeksu: binarna, i jako mapa witryny. Binarna jest mniejsza, szybsza w działaniu, pozwala łączyć ze sobą skorowidze różnych plików, jest automatycznie sortowana w trakcie kompilacji, pozwala łączyć wyrazy kluczowe zawarte w dokumentach HTML (KLinks). Mapa natomiast nie musi być kompilowana, można ją wykorzystać nie tylko w pliku *.chm, ale i na stronach WWW, użytkownik ma pełną kontrolę nad jej zawartością (jest to plik tekstowy z formatowaniem HTML).

  • Utwórz binarny spis treści
    Pozwala utworzyć binarną wersję spisu treści, co przyspiesza jej ładowanie, gdy spis jest bardzo obszerny. Jedną z jego zalet jest możliwość zastosowania nieobecnej w HTML Help Workshop opcji Next/Previous w pasku narzędziowym (pozwala to przeglądać po kolei dokumenty do przodu lub wstecz za pomocą przycisków na pasku). Wersja binarna ma ograniczenia, np. nie obsługuje ikon innych niż książka i strona, a także typów informacji. W normalnych warunkach tworzenie binarnego spisu treści nie jest konieczne. Jeżeli chcemy łączyć później pliki archiwów (Merge), jest to wręcz niedozwolone.


Definiowanie okien

Definiowanie okien nie jest obowiązkowe. Utworzenie jednak chociaż jednego okna pozwala na określenie mnóstwa dodatkowych parametrów wyglądu i zachowania okna HTML Help. Dodatkowe definicje okien mogą być również użyteczne, jeśli niektóre tematy mają być wyświetlane w osobnych oknach. Definicje okien mają pierwszeństwo przed niektórymi domyślnymi ustawieniami projektu.

Uwaga! W oknie tym po dokonaniu jakiejkolwiek zmiany należy ją zatwierdzić klikając na przycisku "Zapamiętaj ustawienia aktualnego okna" oznaczonym ikonką w przeciwnym razie dokonane zmiany nie będą uwzględnione.


Nazwa okna
Lista zawiera nazwy wszystkich okien zdefiniowanych dla aktualnego projektu. Okna można dodawać i usuwać za pomocą przycisków obok, oznaczonych "+" oraz "-".

Poniżej listy okien znajduje się pięć zakładek z umieszczonymi wyżej przyciskami służącymi do ich przełączania:

Rozmiary, panel

  • Tytuł okna
    W tym polu należy wpisać tytuł, jaki będzie pokazywał się na pasku tytułowym okna HTML Help.

  • Pamiętaj pozycję i rozmiar okna po zmianie przez użytkownika
    Zaznaczenie tej opcji powoduje, że będzie zapamiętywana pozycja i rozmiar okna po ich zmianie przy następnym otwarciu.

  • Okno pomocy HTML Help zawsze na wierzchu
    Zaznaczenie tej opcji powoduje, że okno HTML Help będzie wobec innych okien systemu zawsze na wierzchu.

  • Rozmiar i pozycja okna
    W czterech polach: "Od lewej", "Od góry", "Szerokość", "Wysokość" ustawiamy pozycję okna wobec ekranu.

  • Autoustawianie
    Po kliknięciu na przycisku "Autoustawianie" otworzy się przykładowe okno, którego ręczne ustawienie spowoduje wpisanie wybranych wymiarów i położenia do ustawień.

  • Domyślne rozmiary
    Po kliknięciu na przycisku "Domyślne rozmiary" spowoduje ustawienie rozmiarów okna HTML Help według rozmiarów domyślnych.

Panel nawigacyjny

  • Wyświetlaj panel nawigacyjny
    Nie zaznaczenie tej opcji spowoduje, że nie będą pokazywane zakładki: spisu treści, indeksu, wyszukiwania, ulubionych.

  • Po otwarciu panel ukryty
    Zaznaczając tą opcję powodujemy, że po otwarciu okna HTML Help schowany będzie panel nawigacyjny z zakładkami.

  • Automatycznie ukrywaj lub wyświetlaj
    Włączenie tej opcji spowoduje automatyczne ukrywanie lub pokazywanie panelu nawigacyjnego w momencie, gdy użytkownik opuszcza lub uaktywnia okno HTML Help.

  • Szerokość
    W oknie tym można ustalić, jaką szerokość będzie miał panel nawigacyjny w oknie HTML Help.

  • Pozycja zakładek
    Z listy rozwijanej wybieramy pozycję zakładek panelu nawigacyjnego. Są trzy możliwości: standardowo "Na górze", oraz "Po lewej" i "Na dole".

  • Synchronizuj automatycznie spis treści
    Włączenie tej opcji umożliwia automatyczną synchronizację oglądanego dokumentu ze spisem treści - zaznaczona w spisie treści zostaje wtedy aktualnie oglądana pozycja.

  • Ukryj pasek przycisków
    Zaznaczając tę opcję powodujemy, iż pasek z przyciskami funkcyjnymi zostanie ukryty. Można go uaktywnić wybierając odpowiednią pozycję w menu.

  • Ukryj tekst na pasku
    Po zaznaczeniu tej opcji spowodujemy, że napisy pod przyciskami na pasku nie będą pokazywane.

  • Domyślna zakładka
    Z listy rozwijanej możemy wybrać, która z zakładek panelu nawigacyjnego będzie eksponowana w momencie otworzenia HTML Help. Domyślnie jest to "Spis treści". Ilość zakładek na liście zależna jest od tego, ile ich zdefiniujemy w poniższych opcjach.

  • Zakładka "Wyszukaj"
    Zaznaczenie tej opcji spowoduje uaktywnienie zakładki wyszukaj. Stosuje się to w przypadku dużych i bardzo dużych projektów, lub ze względu na ich specyfikę, np. jako baza danych.

    • Zaawansowane
      Włączenie tej opcji spowoduje, że zakładka wyszukiwania będzie posiadała dodatkową możliwość logicznych warunków wyszukiwania. Odbywa się to przez dodanie obok pola na wpisanie szukanego ciągu znaków listy rozwijanej z operatorami: AND, OR, NEAR, NOT. Dzięki temu wyszukiwanie zyskuje nowe możliwości i staje się bardziej precyzyjne.

  • Zakładka "Ulubione"
    Zaznaczenie tej opcji powoduje, że do panelu nawigacyjnego dodana zostanie dodatkowa zakładka. Do niej można dopisać każdy z aktualnie przeglądanych stron, co umożliwia później szybsze do nich dotarcie.


Pasek narzędzi

Podstawowe przyciski

  • Pokaż/Ukryj
    Zaznaczenie tej opcji dodaje na pasku narzędziowym przycisk, który chowa lub pokazuje schowany panel nawigacyjny.

  • Wstecz
    Zaznaczenie tej opcji dodaje na pasku narzędziowym przycisk, który powoduje cofnięcie do poprzednio przeglądanej strony.

  • Dalej
    Zaznaczenie tej opcji dodaje na pasku narzędziowym przycisk, który przenosi nas do następnej ze stron, jeśli cofnęliśmy się do poprzedniej.

  • Zatrzymaj
    Przycisk szczególnie przydatny, gdy za pomocą HTML Help poruszamy się po zasobach Internetu. Przycisk zatrzymuje ładowanie strony.

  • Odśwież
    Przycisk ten powoduje ponowne załadowanie zawartości okna.

  • Start
    Przycisk ten ładuje stronę zdefiniowaną w następnej zakładce "Pliki główne" jako stronę startową.

  • Opcje
    Przycisk uruchamia listę, na której znajdują się wszystkie zdefiniowane przez użytkownika opcje HTML Help, dodatkowo: systemowe opcje internetowe, drukowanie, oraz przełącznik wyróżniania podczas wyszukiwania (zaznaczanie blokiem wyszukanych fraz)

  • Drukuj
    Przycisk umożliwia drukowanie. Po jego kliknięciu pokazuje się okno wyboru dwóch możliwości: drukowanie wybranego tematu, albo drukowanie zaznaczonego nagłówka ze wszystkimi podtematami.

  • Zlokalizuj
    Kliknięcie na tym przycisku powoduje wskazanie pozycji aktualnie przeglądanej strony w spisie treści.

Dodatkowe przyciski

  • Skocz 1
    Przycisk definiowany całkowicie przez użytkownika. W dwu polach jest miejsce na opis przycisku, który pojawiał się będzie pod jego ikoną na pasku, oraz na odwołanie do lokalnej strony, bądź na wpisanie adresu internetowego.

  • Skocz 2
    Przycisk definiowany całkowicie przez użytkownika. W dwu polach jest miejsce na opis przycisku, który pojawiał się będzie pod jego ikoną na pasku, oraz na odwołanie do lokalnej strony, bądź na wpisanie adresu internetowego.

  • Wstecz
    Przycisk powoduje cofnięcie się do wcześniej przeglądanej strony. Uwaga! Wymaga obecności binarnego spisu treści.

  • Dalej
    Przycisk powoduje przejście do następnej strony. Uwaga! Wymaga obecności binarnego spisu treści.

  • Zwiększenie rozmiaru czcionki
    Przycisk ten powoduje przełączanie między rozmiarami czcionek, zdefiniowanymi w przeglądarce internetowej w menu Widok->Rozmiar tekstu. Do wyboru są następujące ustawienia czcionek: największa, większa, średnia, mniejsza, najmniejsza. Uwaga! Zmiana rozmiaru czcionki za pomocą tego przycisku powoduje identyczną zmianę we wszystkich oknach przeglądarki systemowej.

Nietypowe przyciski
Zaznaczenie tych przycisków pozwala na umieszczenie na pasku narzędziowym nietypowych przycisków. W tej jednak wersji HTML Help Workshop nie zostały włączone przez firmę Microsoft do użytkowania. Są wprawdzie wyświetlane, ale nie są czynne zgodnie ze swoim przeznaczeniem.

Dostępne są następujące przyciski: "Spis treści", "Skorowidz", "Wyszukaj", "Historia", "Ulubione", "Notatki", "Wstecz", "Dalej".

Pliki główne

  • Spis treści
    W polu tym wpisujemy nazwę pliku spisu treści HHC wraz z rozszerzeniem. Można go wczytać z dysku, korzystając z ikonki obok pola. W razie otwierania edytora, gdy plik spisu treści już jest sporządzony i znajduje się w katalogu projektu, zostaje on automatycznie w tym polu uwzględniony.

  • Skorowidz
    W polu tym wpisujemy nazwę pliku skorowidza HHK wraz z rozszerzeniem. Można go wczytać z dysku, korzystając z ikonki obok pola. W razie otwierania edytora, gdy plik indeksu już jest sporządzony i znajduje się w katalogu projektu, zostaje on automatycznie w tym polu uwzględniony.

  • Domyślny temat
    W polu tym wpisujemy nazwę pliku projektu wraz z rozszerzeniem, który będzie otwierany w momencie otwarcia HTML Help. Plik ten można również wczytać z dysku korzystając z ikonki obok pola.

  • Strona startowa
    W polu tym wpisujemy nazwę pliku wraz z rozszerzeniem, który będzie uaktywniany w razie zdefiniowania w poprzedniej zakładce przycisku "Start". Plik ten można również wczytać z dysku, korzystając z ikonki obok pola.

Styl wyglądu

Poniższe opcje mają tylko niewielkie znaczenie dla wyglądu HTML Help. Wiele z nich nigdy nie jest używane przy budowaniu projektu - te nie zostaną opisane.

Podstawowe

  • Przycisk maksymalizacji
    Tylko po zaznaczeniu tej opcji pokazany zostanie przycisk maksymalizacji okna HTML Help.

  • Pokaż zmaksymalizowane
    Po zaznaczeniu tej opcji okno HTML Help otwierane będzie jako zmaksymalizowane.

  • Przycisk minimalizacji
    Tylko po zaznaczeniu tej opcji pokazany zostanie przycisk minimalizacji okna HTML Help.

  • Pokaż zminimalizowane
    Po zaznaczeniu tej opcji okno HTML Help otwierane będzie jako zminimalizowane do paska zadań.

  • Okno Pop-Up
    Po zaznaczeniu tej opcji w oknach HTML Help dozwolone będzie otwierane okien Pop-Up.

  • Okno typu dziecko
    Po zaznaczeniu tej opcji w oknach HTML Help dozwolone będzie otwierane okien typu dziecko.

  • Obcinaj (clip) okna dzieci
    Obcinane będą okna typu dzieci.

  • Obcinaj (clip) okna równorzędne
    Obcinane będą okna równorzędne.

  • Poziomy pasek przesuwu
    Tylko po zaznaczeniu tej opcji pojawi się poziomy pasek przesuwu, gdy okno będzie zmniejszane. W przeciwnym razie zawartość okna będzie automatycznie dopasowywana do jego rozmiarów.

  • Pionowy pasek przesuwu
    Tylko po zaznaczeniu tej opcji pojawi się pionowy pasek przesuwu, gdy okno będzie zmniejszane. W przeciwnym razie zawartość okna będzie automatycznie dopasowywana do jego rozmiarów.

  • Obramowanie
    Po zaznaczeniu tej opcji pojawi się obramowanie strony o charakterze dekoracyjnym. Inne opcje określają rodzaj obramowania.

  • Okno typu dialogowego
    Po zaznaczeniu tej opcji w oknach HTML Help dozwolone będzie otwierane okien typu dialogowego.

  • Pokrywające
    Po zaznaczeniu tej opcji w oknach HTML Help dozwolone będzie pokrywanie się okien.

  • Grubsze obramowanie
    Po zaznaczeniu tej opcji obramowanie strony będzie znacznie grubsze niż standardowe.

  • Zablokowane
    Po zaznaczeniu tej opcji rozmiary okna HTML Help będą zablokowane.

Rozszerzone

  • Okno typu narzędziowego
    Po zaznaczeniu tej opcji w oknach HTML Help dozwolone będzie otwierane okien typu narzędziowego.

  • Wklęsłe obramowanie
    Po zaznaczeniu tej opcji obramowania będą typu wklęsłego.

  • Obramowanie trójwymiarowe
    Po zaznaczeniu tej opcji obramowania będą trójwymiarowe.

  • Wyrównanie do prawej
    W niezdefiniowanych stylami tekstach nastąpi wymuszenie wyrównania do prawej. Stosuje się to głównie do tekstów narodowości typu hebrajskiego, gdzie czyta się od prawej do lewej strony.

  • Czytanie z prawej do lewej.
    Stosuje się to głównie do tekstów narodowości typu hebrajskiego, gdzie czyta się od prawej do lewej strony.

  • Kontroluj okno rodzica
    Następuje ścisłe powiązanie okna podrzędnego z nadrzędnym.

  • Akceptuj przenoszone pliki
    Po zaznaczeniu tej opcji następuje akceptacja przenoszonych plików.

  • Zawsze na wierzchu
    Po zaznaczeniu tej opcji okno HTML Help ustawiane będzie wobec innych okien systemu zawsze na wierzchu.

  • Przycisk pomocy kontekstowej
    Po zaznaczeniu tej opcji dozwolony będzie przycisk pomocy kontekstowej.

  • Nie informuj okna rodzica
    Po zaznaczeniu tej opcji nastąpi wymuszenie braku kontroli między oknem podrzędnym a głównym.

  • Przezroczyste
    Po zaznaczeniu tej opcji dodatkowe okna będą przezroczyste.

HTML Help API oraz dołączona pomoc


Lista połączonych z aktualną pomocą innych plików pomocy
HTML Help może składać się również z wielu podrzędnych plików HTML Help włączonych do głównego pliku. Włączenie ich odbywa się przez tę listę. Korzystając z przycisków obok można wybrać pliki CHM do włączenia. Należy jednak pamiętać, że dołączone pliki CHM muszą zawsze znajdować się w tym samym katalogu, co plik projektu głównego. Trzeba również do spisu treści głównego projektu dodać odsyłacz do spisów treści dołączonych plików CHM.

Lista stałych przypisanych do tematu
Na liście tej można przypisać stałe tekstowe do wybranych plików HTML Help, lub też wskazać pliki nagłówkowe zawierające te definicje. Definicje tutaj umieszczone przydatne są podczas korzystania z HTML Help API w programach Windows, dzięki czemu można wywoływać określone tematy pomocy bezpośrednio z tych programów.

Gdy ta stała lub numer jest przekazana do HTML Help API
W tym polu należy wpisać nazwę stałej, jaka będzie przypisana do pliku wybranego w polu niżej.

Niech odnosi się ona do tego pliku
Z listy rozwijanej tego pola należy wybrać plik, jaki ma być powiązany z nazwą lub numerem z pola powyżej.

Mapowanie dla HTML Help API
Lista przeznaczona jest do wskazania plików nagłówkowych zawierających powiązania między numerami kontekstowymi pomocy a stałymi powiązanymi z plikami. W językach programowania pomoc kontekstowa jest najczęściej wywoływana przez wartości liczbowe. Ta sekcja pozwala powiązać (zamapować) stałe liczbowe ze stałymi powiązanymi z plikami Przykładowa zawartość pliku nagłówkowego może wyglądać następująco:

#define IDH_CI_CONTENTS 1060
#define IDH_CI_INTRO 1040
#define IDH_CI_STEP 1010

Okienka wyskakujące Pop_Up
Lista przeznaczona jest do wskazania plików nagłówkowych zawierających definicje okienek wyskakujących Pop_Up.


Pokrewne tematy

Do góry