Zur Hauptseite ... Zum Onlinearchiv ... Zum Abonnement ... Zum Newsletter ... Zu den Tools ... Zum Impressum ... Zum Login ...

Achtung: Dies ist nicht der vollständige Artikel, sondern nur ein paar Seiten davon. Wenn Sie hier nicht erfahren, was Sie wissen möchten, finden Sie am Ende Informationen darüber, wie Sie den ganzen Artikel lesen können.

Kompletten Artikel lesen?

Einfach für den Newsletter anmelden, dann lesen Sie schon in einer Minute den kompletten Artikel und erhalten die Beispieldatenbanken.

E-Mail:

Gedrucktes Heft

Diesen Beitrag finden Sie in Ausgabe 6/2002.

Diesen Artikel jetzt als PDF plus Beispieldatenbank herunterladen?

Wenn Sie sich jetzt für den Newsletter anmelden, erhalten Sie in Kürze eine E-Mail mit dem Artikel im PDF-Format plus Beispieldatenbank.

Hier anmelden:973542

E-Mail:

Anrede:

Vorname:

Nachname:

Online-Hilfe mit dem HTML Help Workshop

André Minhorst, Duisburg

Das Erstellen einer Online-Hilfe sollte eigentlich ein Klacks sein. Ein paar HTML-Seiten mit Word oder einem anderen Programm zusammenschreiben, in ein Verzeichnis speichern und fertig. Doch was, wenn die Hilfe so umfangreich wird, dass Sie dem Anwender vielleicht doch noch ein Inhaltsverzeichnis oder einen Index zur Verfügung stellen möchten? Der HTML Help Workshop hilft Ihnen hier weiter, wie der vorliegende Beitrag zeigt.

Die Online-Hilfe

Einer der - vor allem von Anfängern - am meisten missverstandenen Begriffe der Computerwelt ist wohl Online-Hilfe. Das resultiert vermutlich vor allem aus dem in die Irre führenden Wort Online. Einige Anwendungen bieten echte Online-Hilfen an, die einen Abruf von Hilfestellungen zu verschiedenen Themen über das Internet ermöglichen.

Der Begriff Online-Hilfe umfasst aber auch die allgegenwärtigen Anwendungen, die von den jeweiligen Programmen aus gestartet werden und Hilfe zu diesem Programm im HTML-Format anbieten.

In den folgenden Kapiteln erfahren Sie, wie Sie mit dem HTML Help Workshop eine professionelle Online-Hilfe für Ihre eigenen Anwendungen erstellen können.

Online-Hilfe mit dem HTML Help Workshop

Der HTML Help Workshop ist ein kostenloses Tool von Microsoft. Sie können es unter der folgenden Internetadresse herunterladen:

Fehler! Hyperlink-Referenz ungültig.

Dort finden Sie auch weitere Informationen zur Installation, zu den Systemanforderungen (Sie brauchen in jedem Fall den Internet Explorer, empfohlen ab Version 4) und zu eventuellen Sicherheitslücken.

Nach der Installation können Sie sich allerdings noch nicht direkt an die Arbeit mit dem HTML Help Workshop begeben - erst einmal sind einige Vorarbeiten zu erledigen.

Möglichkeiten des HTML Help Workshops

Der HTML Help Workshop bietet unter anderem die nachfolgend aufgeführten Funktionen zur Erstellung einer professionellen Online-Hilfe an:

  • Einbinden beliebig vieler HTML-Dokumente, die untereinander verknüpft sein können
  • Erstellung von Inhaltsverzeichnissen
  • Verschiedene Möglichkeiten zum Erstellen eines Indexes
  • Definieren kontextabhängiger Hilfethemen, die von anderen Anwendungen aus aufgerufen werden können
  • Automatisches Erstellen einer Volltextsuche
  • Verwalten von Lesezeichen
  • Abb. 1: Der HTML Help Workshop

    Strukturierung der Online-Hilfe

    Machen Sie sich zunächst ein paar Gedanken, wie Ihre Anwendung aufgebaut ist und wie dementsprechend die Online-Hilfe aussehen könnte. In der Regel können Sie die Online-Hilfe ähnlich wie die Struktur der eigentlichen Anwendung gestalten.

    Erstellen eines neuen Projektes

    Nach der Theorie folgt die Praxis: Starten Sie nun den HTML Help Workshop und legen Sie mit dem Menübefehl File/New und anschließender Auswahl des Eintrages Project ein neues Projekt an.

    Die Anwendung startet automatisch den Assistenten zum Anlegen eines neuen Projektes und fragt in den folgenden Schritten einige Informationen ab - z. B. den Namen der zu erstellenden Projektdatei und deren Speicherort. Die Projektdatei wird anschließend unter dem angegebenen Namen mit der Endung .hhp gespeichert.

    Der HTML Help Workshop sieht nun etwa wie in Abb. 1 aus. Der linke Bereich des Fensters enthält unter [Options] die bisher festgelegten Eigenschaften.

    Einstellen der Optionen

    Mit der Schaltfläche Change Project Options können Sie einige Eigenschaften des Projektes einstellen. Hier können Sie z. B. den Text der Titelzeile, die beim Start anzuzeigende HTML-Datei, den Speichernamen der .chm-Datei und einige weitere Informationen festlegen.

    Einige davon werden Sie in den nachfolgenden Abschnitten noch näher kennen lernen.

    Erstellen der Texte

    Nun schaffen Sie die Voraussetzung, um die Online-Hilfe mit Inhalten zu füllen. Mit einem HTML-Editor Ihrer Wahl können Sie nun zwei oder mehr Beispielseiten erstellen, in denen Sie beliebige Texte usw. unterbringen.

    Speichern Sie diese am besten in dem gleichen Verzeichnis, in dem Sie die Projektdatei gespeichert haben.

    Einbinden von HTML-Dokumenten in die Online-Hilfe

    Das Hinzufügen der HTML-Dokumente erfolgt durch einen Mausklick auf die Schaltfläche Add/Remove Topic Files im linken Bereich des HTML Help Workshops.

    Sie sehen nun ein Fenster, das bisher noch keine Topic Files enthält. Nach einem Mausklick auf die Schaltfläche Add... erscheint ein Dialog zur Auswahl der gewünschten Datei. Wählen Sie hier die gewünschte(n) Datei(en) aus. Nach dem Schließen des Fensters mit dem Titel Topic Files erscheinen die eingebundenen Dateien namentlich im linken Teil des Anwendungsfensters unter [Files].

    Kompilieren der
    Online-Hilfe

    Wenn Sie auf diese Weise zwei oder mehr HTML-Dateien eingebunden haben, dürfen Sie einen Blick auf das Zwischenergebnis werfen. Dazu kompilieren Sie die Online-Hilfe zunächst mit der Schaltfläche Compile HTML File.

    Nachdem Sie per Dialog die gewünschte Projektdatei ausgewählt haben, erscheint im rechten Bereich des Anwendungsfensters ein weiteres Fenster mit dem Inhalt der Log-Datei.

    Hier finden Sie eine Auflistung der durchgeführten Aktionen sowie der dabei verwendeten Dateien.

    Ansehen der Online-Hilfe

    Nach der Erstellung können Sie sich die Online-Hilfe nun mit einem Mausklick auf die Schaltfläche View Compiled File ansehen.

    Das Ergebnis ist ernüchternd: kein Index, kein Inhaltsverzeichnis - das Fenster zeigt lediglich eine der HTML-Dateien an (in der Regel die erste in der Liste) und ein Wechsel zu der anderen Seite ist nicht möglich.

    Inhaltsverzeichnis und Index

    Zur ergonomischen Gestaltung der Online-Hilfe gibt es drei Möglichkeiten:

  • Sie verknüpfen die Seiten mit Hyperlinks untereinander.
  • Sie erstellen ein Inhaltsverzeichnis zur hierarchischen Anzeige der Hilfetexte.
  • Sie erstellen einen Index zum Auffinden wichtiger Schlagwörter.
  • Selbstverständlich ist eine Kombination aller drei Möglichkeiten die beste Lösung, sofern die Komplexität der Hilfe das verlangt.

    Abb. 2: Anlegen eines neuen Inhaltsverzeichnisses

    Da Sie zur Erstellung der Online-Hilfe über rudimentäre HTML-Kenntnisse verfügen sollten, enthält der vorliegende Beitrag keine Informationen über das Erstellen von HTML-Dateien und die Verwendung von Hyperlinks zur Verknüpfung unterschiedlicher HTML-Seiten.

    Eine Beschreibung der anderen beiden Möglichkeiten finden Sie in den folgenden Kapiteln.

    Anlegen eines
    Inhaltsverzeichnisses

    Damit die Online-Hilfe benutzbar wird, legen Sie nun ein Inhaltsverzeichnis an. Neben der Registerseite Projects finden Sie in der Anwendung noch zwei weitere Registerseiten: Contents und Index. Wechseln Sie zunächst auf die Registerseite Contents.

    Da Sie noch kein Inhaltsverzeichnis angegeben haben, können Sie nun wählen, ob Sie eine neue Inhaltsverzeichnis-Datei erstellen oder eine vorhandene Datei verwenden möchten (s. Abb. 2). Wählen Sie hier die erste Option und geben Sie im folgenden Dialog den gewünschten Dateinamen und Speicherort an.

    Anschließend erfolgt der Wechsel zum Registerblatt Contents. Hier finden Sie einige Schaltflächen, die dem Hinzufügen, Entfernen und Verschieben der einzelnen Einträge dienen.

    Es gibt zwei unterschiedliche Eintragsarten:
    Überschriften (Headings) und Seiten (Pages).

    Durch einen Mausklick auf die Schaltfläche Insert a heading können Sie dem Inhaltsverzeichnis eine Überschrift hinzufügen. Mit der Schaltfläche Insert a page erledigen Sie das Gleiche mit einer Seite.

    Der Unterschied ist, dass Sie einer Überschrift weitere Überschriften und Seiten unterordnen können. Außerdem erfordern Seiten die Angabe einer HTML-Seite, die beim Mausklick des Anwenders auf den jeweiligen Eintrag angezeigt werden soll. Bei einer Überschrift ist diese Möglichkeit optional.

    Abb. 3: Eigenschaften eines neuen Eintrags

    Abb. 4: Überschriften und Themen des Inhaltsverzeichnisses

    Sie können theoretisch einfach erst einmal alle HTML-Seiten, die Sie aufnehmen möchten, als Seite in das Inhaltsverzeichnis einstellen und die gewünschten Überschriften hinzufügen.

    Beim Klick auf eine der beiden Schaltflächen Insert a page und Insert a heading erscheint jeweils der Dialog aus Abb. 3. Unter Entry title: geben Sie den anzuzeigenden Text an. Mit der Schaltfläche Add öffnen Sie einen Dialog, mit dem Sie eine der eingebundenen HTML-Dateien an den jeweiligen Eintrag binden.

    Auf der Registerseite Advanced finden Sie noch drei interessante Optionen: Mit Mark as new entry können Sie den aktuellen Eintrag als neu deklarieren. Er erhält dann ein anderes Icon, z. B. eines mit einem Sternchen.

    Mit der Option Change entry to a page können Sie bestehende Überschriften in Seiten und Seiten in Überschriften umwandeln, ohne die bereits eingegebenen Eigenschaften ändern zu müssen.

    Die Option Image index bietet schließlich unterschiedliche Symbole zur Auswahl an. Falls Sie eine dieser Eigenschaften später ändern möchten, können Sie den Dialog mit der Schaltfläche Edit selection erneut öffnen.

    Nach dem Anlegen der Einträge können Sie diese mit den Pfeil-Schaltflächen sortieren und deren Hierarchie festlegen.

    Um beispielsweise eine Überschrift einer anderen unterzuordnen, markieren Sie einfach die unterzuordnende Überschrift und klicken auf die Schaltfläche mit dem Pfeil nach rechts.

    Abb. 4 zeigt, wie die Zusammenstellung und Konfiguration der gewünschten Überschriften und Seiten aussehen könnte. Hier sehen Sie neben einigen Überschriften und Seiten einen Eintrag, der mit einem roten Stern markiert ist. Dabei handelt es sich um einen als neu markierten Eintrag.

    Abb. 5: Beispiel eines Inhaltsverzeichnisses

    Abb. 6: Dialog zur Eingabe von Schlüsselwörtern

    Wenn Sie die gewünschten Einträge für das Inhaltsverzeichnis vorgenommen haben, können Sie die Online-Hilfe noch einmal kompilieren und sich das Ergebnis ansehen (s. Abb. 5). Unter Umständen zeigt die Online-Hilfe nun willkürlich eine Seite an oder klappt nicht gewünschte Bereiche des Inhaltsverzeichnisses auf. Um festzulegen, welche Seite beim Starten der Online-Hilfe angezeigt wird, öffnen Sie auf der Registerseite Project den Dialog Options und wählen dort im Kombinationsfeld Default File die gewünschte Datei aus.

    Anlegen eines Index

    Um dem Anwender weiteren Komfort zu bieten, legen Sie nun einen Index an. Wie bereits bei der Erstellung des Inhaltsverzeichnisses wechseln Sie zunächst auf das entsprechende Registerblatt. Da Sie noch keine Indexdatei angelegt haben, wählen Sie im nun erscheinenden Dialog den Eintrag Create a new index file aus. Um alle Dateien des Projektes zusammenzuhalten, speichern Sie die Indexdatei im gleichen Verzeichnis wie die Projektdatei.

    Das Hinzufügen der Stichwörter einer Seite zum Index kann auf zwei Arten erfolgen. Entweder Sie legen jedes Schlüsselwort einzeln an und wählen anschließend die HTML-Dateien aus, denen das Schlüsselwort zugewiesen werden soll, oder Sie gehen seitenweise vor und legen in jeder HTML-Datei die gewünschten Schlüsselwörter in einem bestimmten Verzeichnis an. Die Schlüsselwörter werden dann beim Kompilieren automatisch aus den Dateien ausgelesen.

    Sie haben das Ende des frei verfügbaren Teils des Artikels erreicht. Lesen Sie weiter, um zu erfahren, wie Sie den vollständigen Artikel lesen und auf viele hundert weitere Artikel zugreifen können.

    Sind Sie Abonnent?Jetzt einloggen ...
     

    Kompletten Artikel lesen?

    Einfach für den Newsletter anmelden, dann lesen Sie schon in einer Minute den kompletten Artikel und erhalten die Beispieldatenbanken.

    E-Mail:

    Diesen Artikel jetzt als PDF plus Beispieldatenbank herunterladen?

    Wenn Sie sich jetzt für den Newsletter anmelden, erhalten Sie in Kürze eine E-Mail mit dem Artikel im PDF-Format plus Beispieldatenbank.

    Hier anmelden:

    E-Mail:

    Anrede:

    Vorname:

    Nachname:

    Verwandte Beiträge:

    HTML-Editor-Steuerelement

    Daten visualisieren mit HTML

    © 2003-2015 André Minhorst Alle Rechte vorbehalten.