Home Previous Zeitschrift 1999/03 Next Index

  Inhalt: 

Geschichte 

Definition 

Eigenschaften 

Erstellung 

Licht ... 

... und Schatten 

Fazit 

Weitere Infos 

Der Autor

Elektronische Dokumente mit HTML-Help 

HTML - die Sprache des Internet hält spätestens seit Windows 98 auch vermehrt Einzug in Online-Hilfen. Verbesserte Ergonomie, einfache Erstellung, strukturierte Quelldaten - gute Gründe sprechen für dieses Format. Der folgende Artikel gibt einen Überblick über Einsatz, Eigenschaften und Erstellung von Informationssystemen auf Basis von HTML Help.
 
 


Einsatzmöglichkeiten

Es muß nicht immer nur Online-Hilfe sein. 
Redet man von einem HELP-Format, so denken wir zunächst an Software und Online-Hilfe (F1-Taste usw.). Doch schauen wir einmal über diesen Tellerrand hinaus. Es lohnt sich. Die HELP-Formate, und allen voran HTML-Help unterstützen elektronische Dokumentation hervorragend - was spricht also gegen einen Einsatz bei anderen Dokumenten, zum Beispiel: 
  • Qualitätshandbücher
  • Pflichtenhefte
  • Nachschlagewerke (z.B. Normen, Richtlinien usw.)
  • Ersatzteillisten, Reparaturanleitungen
 
Zum Seitenanfang 
 

Geschichte

Bereits 1996 spezifizierte Microsoft ein neues Format für Online - Hilfen auf Basis von HTML-Dateien.  Doch erst die Einführungen von Windows 98 und Internet Explorer 4 läuten langsam aber sicher die Ablösung der bisherigen Windows-Help-Formate ein. Diese Entwicklung wird zusätzlich unterstützt durch die rasante Entwicklung des Internet und der damit verbundenen Verbreitung von HTML. Ab Windows 98 wird Microsoft alle Online-Hilfen in HTML Help ausliefern.  

 


Zum Seitenanfang 
 

Definition 

HTML Help basiert auf einzelnen HTML-Dateien, die mit Hilfe eines Compilers in eine einzige Datei mit der Endung .chm komprimiert werden. Der Compiler erweitert darüber hinaus die Funktionalität um 
  • die Möglichkeit des kontextsensitiven Aufrufs
  • zusätzliche Navigationsmöglichkeiten
Durch ihren logisch strukturierten Aufbau sind HTML-Dateien hervorragend als Informationsquellen geeignet. Mit speziellen Werkzeugen lassen sich Inhaltsverzeichnis und Index erstellen. Hier kommt zum Beispiel der frei erhältliche Microsoft HTML Help Workshop zum Einsatz. 
 

Zum Seitenanfang 
 

Die wichtigsten Eigenschaften 

Die folgende Aufzählung gibt einen Überblick über die wichtigsten Eigenschaften eines HTML Help basierenden Informationssystems: 
  • Hierarchisches Inhaltsverzeichnis mit individuell wählbaren Ebenen
  • Schlüsselwortsuche (Index)
  • Volltextsuche, auch mit boolschen Verknüpfungen (and / or)
  • Assoziative Verknüpfungen von Inhalten
  • Typisierung von Inhalten und selektiver Zugriff auf diese Informationstypen
  • Popup-Fenster (nur Text)
  • Multimedia-Integration
  • Links in Internet oder Intranet
  • Kontextbezug bei Software-Dokumentation
  • Kompilierung in eine Datei mit gleichzeitiger Komprimierung

  •  
 
Beispiel aus einem Hilfesystem für betriebswirtschaftliche Software 
 
 
Zum Seitenanfang 
 

Erstellung von HTML Help

Die Realisierung eines Help-Projektes spielt sich prinzipiell in 3 Phasen ab: 
  1. Erfassung der Inhalte und Auszeichnung in HTML
  2. Erstellung von Navigationshilfen
    (Inhaltsverzeichnis, Index usw.)
  3. Kompilierung in eine CHM-Datei

  4. (CHM = Dateiendung für HTML Help)
 
Phasen im Erstellungsprozeß einer HTML Help 
 

1. Erfassung der Inhalte 
WinHelp-Systeme setzen eine oder mehrere Quelldateien im RTF-Format voraus. Ähnlich sieht es bei HTML Help aus - nur daß hierbei einzelne HTML-Dateien zum Einsatz kommen. Und zwar eine Datei für jede Seite bzw. Ebene im Inhaltsverzeichnis. Woher diese Dateien stammen, das heißt mit welchem Werkzeug sie erstellt wurden, ist dabei unerheblich. 

Wiederum analog zum WinHelp-Projekt wird nun eine Projektdatei angelegt, die zunächst einfach eine Auflistung aller im System verwendeten HTML-Dateien enthält. 
Ab nun könnte das ganze Informationssystem bereits in eine CHM-Datei kompiliert werden. Dies ist in der Praxis jedoch selten sinnvoll. 

2. Erstellung von Navigationshilfen 
Jetzt werden Inhaltsverzeichnis und Index erstellt. Im HTML Help Workshop geschieht dies durch manuelle Zuordnung der HTML-Dateien zu den entsprechenden Einträgen. 

 
Zuordnung der HTML-Dateien zu Einträgen im Inhaltsverzeichnis  
 

Doch HTML Help geht noch weiter: Durch Schlüsselwort - Einträge direkt  in die HTML-Dateien erstellt der Compiler nicht nur einen Index, sondern auch dynamisch erzeugte Links zu verwandten Seiten (Siehe auch ...). 

Vor der Kompilierung in eine Help-Datei erfolgt bei Software - Dokumentationen noch die Einbindung der Zuordnungslisten für kontextsensitive Aufrufe und die Verknüpfung zu den jeweiligen HTML-Dateien. Diese Schnittstelle zwischen Anwendungsprogramm und Online-Hilfe erfolgt durch Header-Dateien im C-Format. 

3. Kompilierung und Test 
Ist alles definiert, erfolgt die Kompilierung und gleichzeitig eine Komprimierung in die HTML Helpdatei projekt.chm. Dabei prüft das Programm die Integrität der Angaben und gibt im Fehlerfalle eine entsprechende Meldung aus. 
 


 
Zum Seitenanfang 
 

Einige HTML Help Highlights

Während die Bereitstellung eines Inhaltsverzeichnisses, eines Index oder einer Volltextsuche heute als Standard für elektronische Dokumente angesehen wird, stellt HTML Help einige echte Highlights zur Verfügung. 

So läßt sich das Inhaltsverzeichnis individuell darstellen, Ebenen lassen sich gezielt öffnen um einen Blick auf deren Inhalte freizugeben. Dabei können Kapitel und Seiten mit individuellen Symbolen gekennzeichnet werden, um so eine schnelle Orientierung nach Inhalten zu ermöglichen (z.B. Handlungsanweisungen, Erklärungen, Überblick usw.). 

Die Typisierung von Informationen ermöglicht die zielgruppengerechte Auswahl von Inhalten. Dabei ordnet der Autor die Inhalte verschiedenen Informationstypen zu. Der Anwender wiederum kann Filter auf diese Informationstypen definieren. Beispiel: 
Der Autor definiert einführende und weiterführende Themen (Informationstypen). Der Leser (z.B. Anfänger) filtert alle weiterführenden Themen einfach aus. 

Und was sind assoziative Verknüpfungen? 
Oftmals beziehen sich auf den aktuell angezeigten Inhalt weitere Themen und Seiten. HTML Help erlaubt die Definition solcher Verknüpfungen nicht nur durch fest codierte Links, sondern auch durch dynamisch erzeugte, die sich auf Schlüsselwörter in den HTML-Dateien stützen. 
 
 


Zum Seitenanfang 
 

Wo Licht ist, ist auch Schatten 

Echte Nachteile gegenüber bestehenden Help-Formaten gibt es wenig. Dennoch sollen auch einige Problemfelder nicht verschwiegen werden, aus denen vor allem in der Migrations- und Einführungsphase nicht unerhebliche Aufwände resultieren können: 
  • Konvertierungsprobleme aus WinHelp
  • Layoutprobleme
  • Abhängigkeit von Microsoft-Entwicklung

  • (aber wer ist das heute in der PC-Technik nicht)
Die Erstellung und Verwaltung von HTML-Dateien sollte heute kaum mehr Probleme machen. Allenfalls die hohe Anzahl der internen Links könnte zu einem sehr hohen Pflegeaufwand führen. Hier empfehlen sich entsprechend spezialisierte Publishing-Systeme wie  z.B. SchemaText. 

 


Zum Seitenanfang 
 

Fazit

HTML Help stellt hervorragende Funktionen für Dokumentationen auf elektronischen Medien bereit. Dabei kommt das herstellerneutrale Datenformat HTML als Informationsquelle zum Einsatz. 
Das kostenfreie Toolkit Microsoft HTML Help Workshop erlaubt eine einfache Erstellung, allerdings mit etwas höherem manuellem Aufwand. Andererseits sind damit wirklich individuelle Strukturierungen möglich. 
Spezielle Help-Autorensysteme (meist auf Word basierend) automatisieren zwar viele Arbeiten, stellen aber oft nur einen Kompromiß zwischen Papier und elektronischem Medium dar. Durch die Verwendung von HTML lassen sich überdies auch bereits bestehende Dokumente leicht einbinden und kombinieren. 
 

Zum Seitenanfang 
 

Weitere Infos zum Thema

Microsoft stellt den HTML Help Workshop kostenlos zum Download im Internet bereit: 
http://www.microsoft.com/workshop/author/htmlhelp 

Eine ausführliche Erklärung zum Einsatz des Workshop bietet das Buch: 

  • Das offizielle Microsoft HTML HELP Autoren-Kit von Steve Wexler, erschienen bei MicrosoftPress,

  • ISBN 3-86063-448-8. 
Ein Beispiel für HTML Help stellt die Online-Hilfe zu Windows 98 dar. 
 
 
Zum Seitenanfang 
 

Der Autor

Jörg Ferlein arbeitet als selbständiger Dienstleister in den Bereichen technische Dokumentation und EDV-Schulungen. 
Seit Januar 1999 erstellt er u.a. die HTML-Strukturen für die Online-Zeitschrift Technische Dokumentation. 

Jörg Ferlein 
Ringstr. 69 
73666 Baltmannsweiler 
Tel. (07153) 4 86 83 
E-Mail: ferlein@online.de 
 

 



© ADOLPH Verlag GmbH - Letztes Update 03.05.2004