Kontrolka HTML Help

[ Strona główna ] [ Do góry ] [ Praktyczny przykład ] [ Pierwsze archiwum ] [ Rozszerzanie projektu ] [ Archiwum i źródła ]

 

Strona główna
Do góry
Kitty

W archiwach HTML Help można wykorzystywać kontrolkę ActiveX, która odpowiada za wyświetlanie pomocniczych elementów informacyjnych i nawigacyjnych. Niektóre działają w zwykłych stronach HTML, inne - jedynie w ramach skompilowanego archiwum.

Kontrolka jest wstawiana do dokumentu wchodzącego w skład archiwum. Należy więc wczytać taki dokument za pomocą podwójnego kliknięcia na nazwie pliku w sekcji [FILES] projektu. Kursor należy ustawić w wybranym miejscu i wybrać w menu polecenie Tags - HTML Help Control lub kliknąć na przycisku kontrolki (trzeci od lewej) w pasku narzędziowym.

Na ekranie ukaże się pierwsze okienko dialogowe kontrolki.

Na rozwijanej liście mamy do dyspozycji kilka typów kontrolki. Domyślnym typem jest Related Topics. Identyfikator hhctrl pozostawiamy bez zmian.

W codziennej praktyce używanych jest na ogół kilka z nich - w wyspecjalizowanych programach do tworzenia HTML Help rzadko spotyka się pełny zestaw.

Related Topics

Przyjrzyjmy się, jak wygląda wprowadzanie Related Topics, czyli pokrewnych tematów. Przycisk wyświetla listę odsyłaczy do stron o pokrewnej tematyce.

Na tym etapie pozostawiamy As a button i podejmujemy decyzję co do sposoby wyświetlania listy odsyłaczy.

Display on a pop-up menu pozwala wyświetlać zestaw odsyłaczy w postaci rozwijanej listy, "wychodzącej" z przycisku. W przeciwnym razie zostanie wyświetlone odrębne okienko z odsyłaczami.

Display dialog or menu even if only one title pozwala wyświetlić listę lub okienko nawet gdy istnieje tylko jeden odsyłacz. W przeciwnym razie następuje od razu skok do danego dokumentu.

Tutaj decydujemy się, czy na przycisku ma być wyświetlany podany tekst, mapa bitowa .bmp, czy też ikona .ico.

To okienko pozwala dodać nazwy i adresy dokumentów, do których będziemy się odwoływać. Niestety, trzeba je wpisywać z pamięci, gdyż HHW nie przewidział przeglądania!

Po podaniu całej listy kończymy działanie kreatora, a w kodzie strony pojawia deklaracja kontrolki, np.:

<OBJECT id=hhctrl type="application/x-oleobject"
classid="clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11"
codebase="hhctrl.ocx#Version=4,74,8702,0"
width=100
height=100
>
<PARAM name="Command" value="Related Topics, MENU">
<PARAM name="Button" value="Text:Pokrewne tematy">
<PARAM name="Item1" value="M. Czajkowski;mczajkowski.html">
<PARAM name="Item2" value="P. Tęczyński;pteczynski.html">
</OBJECT>

 Niestety, kontrolka jakoś nie chce uwzględniać strony kodowej, wskutek czego mogą się pojawić krzaczki w miejsce polskich liter. A oto przykład kontrolki działającej zarówno na stronie WWW, jak i w archiwum .chm.

Close Window

Kontrolka Close Window pozwala zamknąć aktywne okno archiwum lub przeglądarki. Wstawiamy ją w identyczny sposób, wybierając typ Button i podając treść przycisku lub grafikę. Wstawiony kod ma postać:

<OBJECT id=hhctrl type="application/x-oleobject"
classid="clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11"
codebase="hhctrl.ocx#Version=4,74,8702,0"
width=100
height=100
>
<PARAM name="Command" value="Close">
<PARAM name="Button" value="Text:Zamknij okno">
</OBJECT>

Efekt jest pokazany poniżej - jeśli chcesz zamknąć przeglądarkę, możesz wypróbować ten przycisk.

HHCTRL Version

Kontrolka podaje numer wersji używanej przez czytelnika strony lub archiwum. Przechodzimy analogiczną procedurę, podając jako treść np. "Twoja wersja kontrolki" czy cokolwiek innego.

<OBJECT id=hhctrl type="application/x-oleobject"
classid="clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11"
codebase="hhctrl.ocx#Version=4,74,8702,0"
width=100
height=100
>
<PARAM name="Command" value="HH Version">
<PARAM name="Button" value="Text:Twoja wersja kontrolki">
</OBJECT>

I efekt:

 

W ostatnim poleceniu PARAM można zastosować także (HHW tego nie oferuje):

<PARAM name="Text" value="Text:Wersja HTML Help Control">

co wyświetli tekst:

 

Splash screen

Splash screen to powitalna grafika, wyświetlana przez kilka sekund po załadowaniu strony lub archiwum. W trakcie definiowania ekranu musimy z pamięci podać adres pliku GIF, który zostanie wyświetlony.

<OBJECT id=hhctrl type="application/x-oleobject"
classid="clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11"
codebase="hhctrl.ocx#Version=4,74,8702,0"
>
<PARAM name="Command" value="Splash">
<PARAM name="Item1" value="image/kitty.gif">
<PARAM name="Item2" value="5000">
</OBJECT>

value=5000 oznacza wyświetlanie grafiki przez 5000 milisekund.

A oto przykład, na osobnej stronie:

Table of contents

Niekiedy zachodzi potrzeba wprowadzenia bezpośrednio na stronę spisu treści - może się na przykład zdarzyć, że budujemy archiwum bez panelu nawigacyjnego albo po prostu tworzymy jakiś specjalny "podspis", którego nie uzwględnia się w spisie głównym w panelu nawigacyjnym (a poszczególne rozdziały tego podspisu ukazują się w oknie głównym, oknie zewnętrznym czy choćby pływającej ramce). Możemy wtedy wstawić taki element na jedną ze stron, co wykonujemy za pomocą kontrolki Table of contents. Czytelnicy kursu HTML znają już tę technikę - jak widać, działa ona zarówno na stronach WWW, jak i w archiwum. Oto praktyczny przykład:

Kod ma tutaj przykładową postać:

<OBJECT
CLASSID="clsid:ADB880A6-D8FF-11CF-9377-00AA003B7A11"
ID="TOC"
ALIGN=BOTTOM
WIDTH="300"
HEIGHT="150"
BORDER="0"
VSPACE="0"
HSPACE="0">
<PARAM NAME="Command" VALUE="Contents">
<PARAM NAME="Item1" VALUE="spistresci.hhc">
</OBJECT>

Index

Index, czyli skorowidz, także może być wstawiony bezpośrednio na stronę (WWW lub archiwum), o czym także się już przekonali czytelnicy kursu HTML. Konkretny przykład:

ALink i KLink

Zanim przedstawimy następne metody wykorzystania kontrolki HTML Help, musimy dokonać istotnego rozróżnienia między trzema pokrewnymi pojęciami, z jakimi spotyka się autor archiwów: Related topics, ALink Search i Keyword Search. Są one bardzo podobne technicznie, ale nieco odmienne koncepcyjnie. Related topics funkcjonują na stronach WWW i w archiwach HTML Help, natomiast Alinks i KLinks są dostępne jedynie w archiwach.

Related topics, czyli pokrewne tematy, zostały już przedstawione wyżej. Autor archiwum tworzy odwołania do wybranych przez siebie dokumentów HTML, które jego zdaniem są związane z treścią danego dokumentu.

KLinks (Keyword links) także pozwalają tworzyć odwołania do innych dokumentów, ale nie do ich tytułów czy nazw, lecz do wyrazów kluczowych zawartych w skorowidzu (index). Wyrazy kluczowe są więc niejako pośrednikiem w docieraniu do określonych dokumentów.

ALinks (Associative links) pozwalają odwoływać się do całych grup tematów. Jeśli jakiś ALink jest związany z pięcioma dokumentami, odwołanie się do tego jednego łącza powoduje wyświetlenie listy wszystkich pięciu tematów. ALink jest po prostu pośrednikiem między danym dokumentem a innymi dokumentami w archiwum. Innymi jeszcze słowami, poszczególne dokumenty możemy przypisać do pewnych kategorii, a następnie do tych kategorii się odwoływać. Jeśli pięć dokumentów zostało zaklasyfikowanych do kategorii "teatr" (ALink = teatr), odwołanie się do tej kategorii spowoduje wyświetlenie ich listy. ALinks (a właściwie ch nazwy - ALink names) pełnią rolę kategoryzujących znaczników, sygnatur.

W przypadku Related topics odwołujemy się do doraźnie podanych dokumentów archiwum, natomiast ALink pozwala się odwołać do uprzednio zdefiniowanych kategorii dokumentów.

HTML Help Workshop oferuje funkcję Compiler information, dostępną w menu Edit po wczytaniu dokumentu z listy dostępnej w sekcji [FILES] (jeszcze jeden powód, dla którego powinno się jawnie deklarować pliki do kompilacji).

Okienko dialogowe Compiler information zawiera dwie zakładki, w których możemy podać wyrazy kluczowe do skorowidza (Keywords - są one kompilowane na równi z hasłami podanymi w zakładce Index całego projektu, jeśli tylko tak zadeklarujemy w opcjach projektu) oraz ALink names, czyli wspomniane wcześniej sygnatury kategoryzujące dokument. To wspólne okienko jest nie tylko wygodne, ale i pokazuje pokrewieństwo obu pojęć, które reprezentują nieco inne sposoby docierania do dokumentów w archiwum.

Przycisk Add pozwala dodać w obu przypadkach konkretne hasła, przy czym można podać od razu kilka, rozdzielając je średnikiem. Na liście pojawią już jeden pod drugim.

Kod źródłowy powstały po takiej akcji ma przykładową postać:

<Object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
	<param name="Keyword" value="artykuł">
	<param name="Keyword" value="dziennikarz">
	<param name="Keyword" value="felieton">
	<param name="ALink Name" value="dom">
	<param name="ALink Name" value="praca">
	<param name="ALink Name" value="szkoła">
</OBJECT>

W ten sposób za jednym zamachem wprowadzamy oba typy haseł, choć oczywiście można się ograniczyć do jednego.

Microsoft zaleca wstawianie tego kodu w ramach BODY, choć wstawienie go w ramach HEAD też jest ważne.

Aby teraz wstawić kontrolkę funkcji wyszukiwania Keyword search lub ALink search, sięgamy po prostu do polecenia HTML Help Control i wybieramy odpowiedni rodzaj wyszukiwania na rozwijanej liście. zostawiamy opcję Button, podajemy tekst na przycisku, a następnie dodajemy hasła - jeśli kilka na raz, rozdzielamy je średnikiem i zaznaczamy opcję Multiple keywords:

Przykładowy kod wyszukiwania dokumentów za pośrednictwem wyrazów kluczowych może mieć postać:

<OBJECT id=hhctrl type="application/x-oleobject"
classid="clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11"
codebase="hhctrl.ocx#Version=4,74,8702,0"
width=100
height=100
>
<PARAM name="Command" value="KLink, MENU">
<PARAM name="Button" value="Text:Inne strony">
<PARAM name="Item1" value="">
<PARAM name="Item2" value="praca">
<PARAM name="Item3" value="szkoła">
</OBJECT>

Dość dziwnie zachowuje się opcja MENU, która oznacza tutaj wyświetlanie listy metodą popup - mimo tej deklaracji wyświetlane jest odrębne okienko. Nie zdołałem wykryć przyczyny takiego zachowania - być może jest to jakaś wada kompilatora.

Wyszukiwanie słów kluczowych (keywords) za pomocą Keyword search obejmuje zarówno wyrazy kluczowe wprowadzone do skorowidza klasyczną metodą, z poziomu projektu, jak i wyrazy wprowadzone za pomocą metody Compiler information, pod warunkiem, że w opcjach projektu, w zakładce Files, zaznaczymy opcję Include keywords from HTML files.

Na zakończenie, pamiętajmy, że każdą z kontrolek można poddać reedycji, albo ręcznie, albo ustawiając kursor na jednym z poleceń konkretnej kontrolki (najlepiej na OBJECT) i sięgając do przycisku kontrolki w pasku narzędziowym.