HLP-Hilfedateien


Viele Entwickler schreiben, so wie ich, in erster Linie einfach nur ihre Programme und betrachten die Angelegenheit damit als erledigt. Spätestens wenn sich die Frage nach einer Veröffentlichung stellt, wird auch das Thema einer Dokumentation interessant. Nun könnte man natürlich eine Textdatei beilegen, die die grundlegenden Funktionen der Software erklärt. Aber weitaus professioneller wirkt eine Hilfedatei.

Hilfedateien im HLP-Format sind seit Windows 3.x bekannt, auch wenn sie sich seit Windows 95 ein wenig verändert haben. Das Schöne dabei ist, dass Delphi diese Hilfedateien direkt unterstützt, so dass aus programmiertechnischer Sicht nichts weiter benötigt wird.


Auf redaktioneller Ebene benötigen wir ein Schreibprogramm, das RTF-Dateien erzeugen kann. Außerdem sollte es in der Lage sein, unsichtbaren Text darzustellen (das hört sich paradox an, hat aber durchaus einen ernsthaften Hintergrund). Des Weiteren sollten einfache und doppelte Unterstreichungen, Fußnoten usw. kein Problem darstellen.
Die Grafiken dieses Tutorials basieren auf Microsoft Word XP. Aber das zugrunde liegende Prinzip funktioniert natürlich auch mit anderen Programmen, die die genannten Anforderungen erfüllen.

Es gibt auch kommerzielle Software sowie Freeware, die die Erstellung von HLP-Dateien erleichtert. Ich muss ehrlicherweise zugeben, dass ich mich mit diesen Produkten nicht auskenne. Wer dieses Tutorial dahingehend ergänzen möchte, kann mir gern schreiben.

Für unsere Zwecke benötigen wir zu guter Letzt noch den kostenlosen Helpworkshop von Microsoft, der sowohl bei Delphi als auch beim Visual Studio 6 mitgeliefert wird.

Tipp

Für Anfänger, die wirklich in die HLP-Materie einsteigen wollen, gibt es ein sehr gutes Tutorial, die 99 Steps to WinHelp von Hans-Jürgen Philippi. Aber auch für Fortgeschrittene findet sich hier der ein oder andere nützliche Tipp. Allerdings fehlt in meinen Augen das Inhaltsverzeichnis. Zwar sind die 99 Steps eine Art A-Z-Tutorial, bei dem man "gezwungen" wird, sich vom Anfang bis zum Ende durchzuarbeiten. Wenn man aber die Tipps ausprobiert hat und vielleicht einen Fehler korrigieren muss, den man erst im Probelauf bemerkt hat, dann steht man vor dem Problem, erst bis zum entsprechenden Thema blättern zu müssen ... wenn man kein Lesezeichen angelegt hat.
Es wäre daher wünschenswert, dass Hans-Jürgen Philippi seinem Werk eine kleine Aktualisierung spendiert. Ein Inhaltsverzeichnis ließe sich ja auch als Download auf der letzten Hilfeseite anbieten. So würde sich an der Ausrichtung des Dokumentes für Anfänger für Anfänger nichts ändern.

Achtung!

Das mitgelieferte Beispielprogramm funktioniert unter Windows Vista nicht mehr, weil Microsoft die Unterstützung für das HLP-Format offiziell einstellt. Wenn Sie Ihre Programme mit einer Hilfe ausstatten wollen, dann sollten Sie auf das CHM-Format ausweichen, oder Sie machen sich mit der Vista-eigenen Hilfe vertraut.