Wie erstelle ich eine Hilfedatei im WinHelp Format
Auf dieser Seite möchte ich allen Neulingen, die sich mit dem Erstellen von HLP Dateien beschäftigen wollen, einen kurzen Überblick geben.
Spezielle Dinge wie z.B. das Erstellen Kontext sensitiver Hilfedateien wird hier nicht behandelt sondern ist bei den Tipps zu WinHelp zu finden.
Um Hilfedateien zu erstellen empfiehlt sich folgende Vorgehensweise:
Es wird ein Editor benötigt, der RTF Dateien erstellen kann und der die Möglichkeit bietet, Fußnoten einzufügen. Sinnvollerweise wird Word benutzt. Um das ganze zu Vereinfachen bietet sich die Nutzung von Dokumentenvorlagen (AddIns) an, die speziell für das Erstellen von HLP fähigen RTF Dateien programmiert wurden. Unter der Rubrik Download könnt ihr die kostenlose Dokumentenvorlage TS Help runterladen, die von mir programmiert wurde. Eine weitere Möglichkeit ist das Benutzen von Stand alone WYSIWYG Editoren.
Außerdem wird der Microsoft Help Workshop benötigt. Kostenlose Download Möglichkeit siehe unter Links.
Die weiteren Ausführungen beziehen sich nicht auf die Verwendung von TS Help, sondern auf das manuelle Erstellen der RTF Datei in Word 2000. Meine Ausführungen dürften auch für niedrigere und höhere Word Versionen zutreffen. Es können jedoch die Bezeichnungen einzelner Funktionen anders sein.
In Word wird nun die erste Themenseite erstellt. Wenn die Themenüberschrift später in der Hilfedatei in einer nicht scrollenden Region erscheinen soll, muss für die Themenüberschrift unter Format | Absatz Register Zeilen- und Seitenwechsel das Kästchen "Absätze nicht trennen" aktiviert werden. Nicht vergessen, dieses Kästchen für die nächste Zeile wieder zu deaktivieren. Um die Themenseite für den Help Workshop aufzubereiten müssen Fußnoten hinzugefügt werden. Die Einträge zu den einzelnen Fußnoten müssen im Fußnotenbereich direkt hinter der Fußnote vorgenommen werden.
| Fußnote | Beschreibung |
|---|---|
| # | Die Themenkennung oder Topic ID dient zur Identifizierung des entsprechenden Themas. Sie wird z.B. genutzt um Sprünge zu einem anderen Thema durchzuführen. Bei der Eingabe ist darauf zu achten, dass die Themenkennung keine Leerzeichen enthält. |
| $ | Der Thementitel erscheint in der Hilfedatei z.B. in den Dialog Boxen "Gefundene Themen", "Textmarke" und "Bisherige Themen“. |
| K | Das K - Schlüsselwort bzw. die K - Schlüsselwörter werden für Einträge in das Index Register angegeben. Sollen mehrere K - Schlüsselwörter vergeben werden, so müssen diese durch ein Semikolon getrennt werden. |
| A | Die A - Schlüsselwörter werden zusätzlich zu den K - Schlüsselwörtern vergeben. Im Gegensatz zu den K - Schlüsselwörtern erscheinen sie nicht im Index Register der Hilfedatei sondern werden für das A Link Makro benötigt. Sollen mehrere A - Schlüsselwörter vergeben werden, so müssen diese durch ein Semikolon getrennt werden. |
| + | Die Themenfolge oder Browse Sequenz ermöglicht es, innerhalb einer Folge von Themen hin und her zu blättern. Zu diesem Zweck muss jede Themenfolge einen eigenen Namen erhalten. Ferner kann festgelegt werden, an welcher Stelle innerhalb der entsprechenden Themenfolge das jeweilige Thema steht. Hierzu muss nach dem Namen der Themenfolge ein Doppelpunkt stehen und danach der entsprechende Rang des Themas. z.B. 005 |
| ! | Das Eingangsmakro wird bei jedem Aufruf des entsprechenden Themas ausgeführt. Sollen mehrere Makros ausgeführt werden, müssen diese durch Semikolons voneinander getrennt werden. Um Beschreibungen zu den möglichen Makros zu erhalten, könnt ihr meine deutsche Übersetzung der Makros im Downloadbereich finden. |
Wenn es sich bei dem Thema um ein Thema für einen What's this Popup Link handelt, sollte nur die # Fußnote vergeben werden.
Nach dem gleichen Schema werden nun die weiteren Themenseiten erstellt.
Es empfiehlt sich, die mit den Themen assoziierte Themenkennung in einer gesonderten Datei aufzuschreiben. Dies vermindert das Suchen von Themenkennungen z.B. beim Definieren von Links.
Sollen innerhalb eines Themas Links definiert werden, ist wie folgt vorzugehen:
Bei einem normalen Link wird für das entsprechende Wort das Format "Doppelt unterstrichen" ausgewählt (Format | Zeichen Listenfeld Unterstreichung). Hinter das Wort wird die Themenkennung des Themas eingegeben, zu dem gesprungen werden soll. Diese Themenkennung erhält das Format "Ausgeblendet" (Format | Zeichen). Soll das Thema zu dem gesprungen wird in einem anderen Fenstertyp dargestellt werden, so muss hinter die Themenkennung das Zeichen > eingetragen werden und danach der Name des Fenstertyps. Auch diese Eintragungen erhalten das Format "Ausgeblendet". Der eingetragene Fenstertyp muss im Help Workshop definiert werden.
Bei einem Popup Link wird für das entsprechende Wort das Format "Unterstrichen" ausgewählt. Hinter das Wort wird die Themenkennung des Themas eingegeben, zu dem gesprungen werden soll. Diese Themenkennung erhält das Format "Ausgeblendet".
Ist die Datei erstellt, muss sie im RTF Format gespeichert werden. Danach geht es im Help Workshop weiter.
File | New dann Help Project auswählen. Danach den Namen der Hilfedatei festlegen.
Options klicken dort im Register "General" unter "Default Topic" die Themenkennung des Topics eingeben, dass beim Öffnen der Hilfedatei als erstes dargestellt werden soll. Soll beim Öffnen eine Inhaltsdatei (*.cnt) angezeigt werden, sollte hier trotzdem ein Eintrag festgelegt werden. Dann unter "Help title" einen aussagekräftigen Titel eintragen der im Hilfefenster angezeigt werden soll, sofern nicht ein separates Fenster definiert wird (siehe weiter unten).
Nun in das Register "Files" wechseln. Dort unter Rich Text Format (RTF) files die mit Word erstellte RTF Datei auswählen. Unter "Contents file" wird, sofern vorhanden, die Inhaltsdatei (*.cnt) ausgewählt.
Sofern nicht die Standardanzeige erfolgen soll, unter "Windows" ggf. die Fenstertypen definieren. Zuerst einen Namen für das Fenster festlegen. Im Register "General" unter "Title bar text" den Namen eingeben, der in der Titelleiste des Fensters erscheinen soll.
Im Register "Position" könnt ihr per Auto sizer die Größe und Position des Fensters festlegen.
Im Register "Buttons" werden logischerweise die Buttons festgelegt, die das Fenster erhalten soll.
Im Register "Color" können die Farben der nicht scrollenden Region und der Themenseite des Fensters festgelegt werden.
Im Register "Makros" können Makros eingetragen werden, die immer dann ausgeführt werden, wenn dieser Fenstertyp geöffnet wird.
Wenn ihr in eurer Hilfedatei mit dem Befehl {bmc grafik.bmp} Bitmaps eingebaut habt, müsst ihr im Workshop unter "Bitmaps" den Pfad zu dem Ordner angeben, in dem sich die Bitmaps befinden.
Nun könnt ihr über "Save and Compile" eure Hilfedatei kompilieren.
Wollt ihr für eure Hilfedatei noch eine Inhaltsdatei erstellen, so könnt ihr dies jetzt erledigen.
Im Help Workshop File | New dann "Help Contents" auswählen.
Unter "Default filename" den Namen der Hilfedatei eintragen und unter "Default title" einen Titel, der in der Titelleiste der Inhaltsdatei erscheinen soll.
Nun "Add Above" und dann "Heading" aktivieren, wenn ihr einen übergeordneten Menüpunkt für mehrere Themen erstellen wollt. Nun dem Menüpunkt unter "Title" einen Namen geben.
Danach über "Add Below" die nachfolgenden Menüpunkte definieren. Hier "Topic" aktivieren. Unter "Title" den Namen des Themas eintragen. Unter "Topic ID" die Themenkennung des jeweiligen Themas eintragen. Unter "Window Type" könnt ihr dann noch festlegen, in welchem Fenstertyp das Thema geöffnet werden soll.
Der Help Workshop und die RTF Datei bieten natürlich wesentlich mehr Optionen und Möglichkeiten, als ich sie hier vorgestellt habe. Dieser Beitrag sollte absoluten Neulingen einfach nur mal einen schnellen Einstieg in die Thematik ermöglichen.
Ich würde jedem empfehlen einfach mal mit einer Testhilfedatei die verschiedensten Einstellungen des Workshops auszuprobieren. Hierdurch lernt man am besten. Keine Angst vor Fehlern! Der Help Workshop läuft absolut stabil und verzeiht einem wirklich alle Fehler. Solange ich mit dem Workshop arbeite, ist es mir nicht gelungen ihn zum Absturz zu bringen.
Eine weitere Möglichkeit um zu lernen ist, die Hilfedateien, die von Profis erstellt wurden, zu dekompilieren und dort einmal nachzuschauen welche Möglichkeiten sich eröffnen können. Bitte hierbei die Copyright Rechte beachten. Infos dazu siehe hier: Dekompilieren einer WinHelp Datei
Eine weitere Möglichkeit, sich etwas intensiver mit der Thematik zu beschäftigen ist das Tutorial "99 Steps to WinHelp" von Hans-Jürgen Philippi. Dieses Tutorial ist komplett in Deutsch abgefasst.
Eine weitere deutsche Abhandlung zur Thematik findet ihr bei Carsten Behrens.
