Übung: Erstellen einer Online-Hilfedatei

Das Ziel dieser Übung ist zu Lernen, wie man eine Microsoft Windows-Hilfedatei schreibt und kompiliert, um diese Datei von einer Visual Basic-Anwendung aufrufen zu können. Am Ende dieser Übung sollte man folgendes beherrschen:

• Schreiben einer Online-Hilfedatei.

• Kompilieren eines Hilfe-Textes zu einer Online-Hilfedatei.

• Aufrufen der Hilfedatei von einer Visual Basic-Anwendung aus.

Schreiben einer Hilfedatei (Software)

Microsoft Windows Online-Hilfedateien werden aus Textdateien im Text Format (.rtf) generiert. Viele Textverarbeitungsprogramme können Dokumente in diesem Format speichern, z.B. auch Microsoft Word. Jede Hilfedatei kann mehrere Seiten (Topics) und Verknüpfungen zwischen diesen enthalten. Die leichteste Art, Topics und Verknüpfungen zu erstellen, kann mit einem Programm zur Hilfedatei-Erstellung bewerkstelligt werden. Ein solches Programm wäre beispielsweise HelpWriter von Teletech Systems. Nach dem Verfassen des Textes der Hilfedatei muß diese nun kompiliert werden, mit einem speziellen Compiler (Hc.exe oder Hcw.exe). Falls dieser Compiler nicht schon auf dem System vorhanden sein sollte, kann er im Paket Hc505.exe oder Hcwsetup.exe an vielen Orten im Internet gefunden werden (z.B. ftp://ftp.wnt.uni-duesseldorf.de/Mirror/ftp.microsoft.com/softlib/mslfiles).

Schreiben einer Hilfedate (Syntax)

Im folgenden Beispiel wird das Programm HelpWriter benutzt, um eine Hilfedatei zu schreiben. Zunächst wird eine leere Seite aufgerufen, im Menü Topic unter dem Menüeintrag New Topic. Alternativ dazu kann auch das vierte Symbol von links in der Symbolleiste angeclickt werden. Es erscheint ein Dialogfeld, in dem eine Bezeichnung für das Blatt eingegeben werden muß, sowie die Art festgelegt werden muß, wie dieses Blatt erscheinen soll. Wählen Sie Standard und Main Window an.

Nach dem Click auf OK steht dieses Blatt nun zur Verfügung. Schreiben Sie nun den Text in dieses Blatt. Beispielsweise
Willkommen zur Hilfe des WaveBsp-Programm.
Hier finden sie eine kurze Übersicht zur Menüleiste und zu einigen Steuerelementen.
Erstellen Sie anschließend ein weiteres Blatt, mit der Bezeichnung Menüleiste.

Tragen sie nun auf diesem Blatt folgenden Text ein:
Öffnen
Öffnet eine Multimedia-Datei.
Schließen
Schließt die aktuell geöffnete Multimedia-Datei
Beenden
Beendet das Programm

Gehen Sie nun zurück zum ersten Blatt, markieren sie dort das Wort Menüleiste und wählen Sie im Menü Insert den Menüeintrag Jump. Wählen Sie dann in der Auswahlliste der erscheinenden Dialogbox den Eintrag Menüleiste aus, und clicken Sie auf Add Jump.

Erstellen Sie anschließend ein weiteres Blatt, namens Steuerelemente, und fügen sie dort z. B. folgenden Text ein:
Die neun Schaltflächen über dem Multimedia-Steuerelement lösen die gleichen Ereignisse aus, wie die entsprechenden Schaltflächen des Multimedia-Steuerelements. Abhängig von der Art der geöffneten Multimedia-Datei sind einige nicht aktiviert.
Mit den Schaltflächen "Verbergen" und "Anzeigen" kann das Multimedia-Steuerelement ein- bzw. ausgeblendet werden.

Erstellen Sie ein weiteres Blatt, namens DateiArt, und fügen Sie in dieses folgenden Text ein:
Es können Audio-Dateien (*.wav), MIDI-Dateien (*.mid), AVI-Video-Dateien (*.avi) und CD-Audio-Dateien (*.cda) abgespielt werden.

Markieren Sie nun auf dem Blatt Steuerelemente die Phrase Art der geöffneten Multimedia-Datei, und fügen Sie eine Verknüpfung ein, wie zuvor beschrieben, diesmal allerdings vom Typ PopUp. Stellen Sie dann noch von der Hauptseite eine Verbindung (Typ: Standard) zum Blatt Steuerelemente her.

Clicken Sie nun auf das Computer-Symbol in der Symbolleiste (siehe nachfolgende Abbildung), um die Hilfedatei jetzt zu kompilieren.

Nach erfolgreicher Kompilierung wird in der Statusleiste "Compilation successful!" angezeigt, und die fertige Hilfedatei kann nun duch ein Click auf das Ampel-Symbol eingesehen werden.

Aufrufen einer Hilfedatei von Visual Basic aus

Nachdem die Hilfedatei geschrieben und kompiliert worden ist, ist sie fertig vorbereitet für den Einsatz in einer Anwendung. Dies kann jede beliebige Anwendung sein, es braucht nicht zwingend eine in VB geschriebene Anwendung sein. Um eine Hilfedatei von Visual Basic aus aufzurufen, folgen Sie diesen Schritten:

1. Starten Sie Visual Basic und laden oder erstellen Sie ein Projekt.

2. Gehen Sie zu jener Form, von der aus Sie die Hilfedatei aufrufen wollen. Plazieren Sie auf dieser Form eine Schaltfläche und setzen Sie deren Caption-Eigenschaft auf 'Hilfe'. Diese Schaltfläche wird später vom Benutzer verwendet werden können, um die Online-Hilfe aufzurufen. Alternativ dazu kann bei einer schon bestehenden Menüleiste ein Menüeintrag hinzugefügt werden, der die gleiche Funktion erfüllen soll, z.B. ein Hauptmenü namens 'Hilfe' und ein Menüeintrag darunter mit dem Titel 'Suchen in der Hilfe...'.

3. Setzen Sie anschließend auf die gleiche Form ein Standarddialog-Steuerelement. Gehen Sie zu dessen Eigenschaften, und Tragen Sie bei der Eigenschaft HelpFile den Namen und die vollständige Verzeichnisangabe (incl. Laufwerk) der Hilfedatei ein, die soeben erstellt worden ist. Wenn Sie keine eigene Hilfedatei erstellt haben, so können Sie auch den Pfad zur Visual Basic-Hilfedatei angeben.

4. Tragen Sie im Click-Ereignis der Schaltfläche folgenden Code ein:

   Sub cmdHelp_Click ()
     Const HELP_CONTENTS = &H3         ' Siehe Konstantenliste weiter unten
   
     CMDialog1.HelpCommand = HELP_CONTENTS
     CMDialog1.Action = 6
   End Sub
   

   Die erste Zeile definiert eine Konstante namens HELP_CONTENTS und setzt deren Wert auf '&H3'. Der benötigte Wert für diese Konstante und andere Hilfe-Konstanten können in der Liste weiter unten gefunden werden. Die nächste Programmzeile legt fest, daß die Hauptseite der Hilfedatei angezeigt werden soll, wenn diese aufgerufen wird. Und die letzte Zeile, die den Eintrag Action = 6 hat, legt die Art des Standarddialogfeldes fest. Die Zahl 6 bezieht sich auf Online-Hilfedateien (entspricht der ShowHelp-Methode).

Public Const HELP_CONTEXT = &H1           ' Zeigt Hilfe für ein bestimmtes Thema an.
Public Const HELP_QUIT = &H2              ' Benachrichtigt die Hilfeanwendung, daß die angegebene Hilfedatei nicht mehr verwendet wird.
Public Const HELP_INDEX = &H3             ' Zeigt den Index der angegebenen Hilfedatei an.
Public Const HELP_CONTENTS = &H3          ' Zeigt das Inhaltsthema in der aktuellen Hilfedatei an.
Public Const HELP_HELPONHELP = &H4        ' Zeigt Hilfe zum Arbeiten mit der Hilfeanwendung selbst an.
Public Const HELP_SETINDEX = &H5          ' Legt den aktuellen Index für eine Hilfe mit mehreren Indizes fest.
Public Const HELP_SETCONTENTS = &H5       ' Kennzeichnet ein bestimmtes Thema als Inhaltsthema.
Public Const HELP_CONTEXTPOPUP = &H8      ' Zeigt ein Thema an, das durch eine Kontextkennung identifiziert wird.
Public Const HELP_FORCEFILE = &H9         ' Erstellt eine Hilfedatei, die Text in nur einer Schriftart anzeigt.
Public Const HELP_KEY = &H101             ' Zeigt Hilfe für ein bestimmtes Schlüsselwort an.
Public Const HELP_COMMAND = &H102         ' Zeigt Hilfe für einen bestimmten Befehl an.
Public Const HELP_PARTIALKEY = &H105      ' Ruft das Suchmodul in der Windows-Hilfe auf.

Übung 14

Hauptseite