HTML Help Workshop: Erstellen Sie benutzerfreundliche Hilfedateien für Ihre Anwendungen

Was ist HTML Help Workshop?

Als Entwickler stehst du vor der Aufgabe, deinen Benutzern umfassende und leicht zugängliche Hilfedokumentation für deine Anwendungen bereitzustellen. Hier kommt HTML Help Workshop ins Spiel, ein kostenloses Tool von Microsoft, mit dem du benutzerfreundliche Hilfedateien im HTML-Format erstellen kannst.

Was ist HTML Help Workshop?

HTML Help Workshop ist ein Authoring-Tool für Hilfesysteme, das dir Folgendes ermöglicht:

• Erstellen von Hilfedateien mit strukturiertem Inhalt, Bildern und Links
• Anpassen des Aussehens und der Navigation deiner Hilfedateien
• Hinzufügen von Index- und Suchfunktionen für eine einfache Navigation
• Einfaches Veröffentlichen und Bereitstellen deiner Hilfedateien online oder lokal

Vorteile der Verwendung von HTML Help Workshop

HTML Help Workshop bietet zahlreiche Vorteile:

• Benutzerfreundliches Interface: Die intuitive Benutzeroberfläche erleichtert es selbst Anfängern, Hilfedateien ohne HTML-Kenntnisse zu erstellen.
• Umfassende Hilfefunktionen: Du kannst Abschnitte, Themen, Index und Suchfunktionen einfügen, um eine umfassende und leicht navigierbare Hilfedokumentation zu erstellen.
• Individuelle Anpassung: Passe das Erscheinungsbild deiner Hilfedateien mit benutzerdefinierten Stilen und Logos an, um sie mit deiner Anwendung zu integrieren.
• Integration mit Visual Studio: HTML Help Workshop ist in Microsoft Visual Studio integriert, sodass du Hilfedateien direkt aus deiner Entwicklungsumgebung erstellen kannst.
• Kostenlos und plattformübergreifend: HTML Help Workshop ist ein kostenloses Tool von Microsoft, das mit verschiedenen Windows-Versionen und Webbrowsern kompatibel ist.

Vorteile der Verwendung von HTML Help Workshop

HTML Help Workshop bietet eine Reihe von Vorteilen, die dich beim Erstellen benutzerfreundlicher Hilfedateien für deine Anwendungen unterstützen:

Erstellen professionell aussehender Hilfedateien

Mit HTML Help Workshop kannst du Hilfedateien erstellen, die professionell aussehen und mit deiner Anwendung übereinstimmen. Du kannst mithilfe einer Vielzahl von Stilvorlagen, Layouts und Schriftarten das Erscheinungsbild deiner Hilfedatei anpassen. Dies sorgt für ein einheitliches und ansprechendes Benutzererlebnis.

Einfache Erstellung und Wartung

HTML Help Workshop vereinfacht den Erstellungsprozess für Hilfedateien. Du kannst Inhalte direkt im HTML-Editor bearbeiten, sodass du keine komplexen Programmiersprachen erlernen musst. Die intuitive Benutzeroberfläche erleichtert das Hinzufügen, Bearbeiten und Verwalten von Inhalten.

Umfangreiche Anpassungsmöglichkeiten

HTML Help Workshop bietet dir die Flexibilität, deine Hilfedateien an die spezifischen Anforderungen deiner Anwendung anzupassen. Du kannst benutzerdefinierte Abschnitte, Themen, Registerkarten und Inhaltsverzeichnisse erstellen, um die Navigation für deine Benutzer zu vereinfachen.

Integration mit Microsoft Visual Studio

HTML Help Workshop ist eng in Microsoft Visual Studio integriert, sodass du Hilfedateien direkt aus deiner Entwicklungsumgebung heraus erstellen und verwalten kannst. Diese Integration spart Zeit und Aufwand, da du nicht zwischen verschiedenen Tools wechseln musst.

Kompatibilität mit gängigen Betriebssystemen

Hilfedateien, die mit HTML Help Workshop erstellt wurden, sind mit den meisten gängigen Betriebssystemen wie Windows, macOS und Linux kompatibel. Dies gewährleistet, dass deine Benutzer unabhängig von ihrem System auf die Hilfedatei zugreifen können.

Umfangreiche Hilfedokumentation

HTML Help Workshop verfügt über eine umfassende Hilfedokumentation, die dich bei jedem Schritt des Erstellungsprozesses unterstützt. Diese Dokumentation enthält Tutorials, Anleitungen und Best Practices, die dir helfen, professionelle und benutzerfreundliche Hilfedateien zu erstellen.

Installieren und Verwenden von HTML Help Workshop

Um HTML Help Workshop nutzen zu können, musst du es zunächst auf deinem Computer installieren.

Installation von HTML Help Workshop

1. Navigiere zur Microsoft Download-Center-Website: https://www.microsoft.com/de-de/download/details.aspx?id=20635
2. Lade die ausführbare Datei für HTML Help Workshop 1.4 herunter.
3. Doppelklicke auf die heruntergeladene Datei, um den Installationsassistenten zu starten.
4. Befolge die Anweisungen auf dem Bildschirm, um die Installation abzuschließen.

Verwenden von HTML Help Workshop

Nach der Installation kannst du HTML Help Workshop über das Startmenü öffnen.

Erstellen einer neuen Hilfedatei

1. Klicke im Hauptmenü auf "Datei" > "Neu".
2. Gib im Dialogfeld einen Namen und einen Speicherort für die neue Hilfedatei an.
3. Wähle die gewünschte Sprache aus.
4. Klicke auf "OK", um die Erstellung der neuen Hilfedatei zu starten.

Hinzufügen von Inhalt zur Hilfedatei

1. Klicke im Hauptmenü auf "Bearbeiten" > "Thema einfügen".
2. Gib im Dialogfeld einen Titel und eine Überschrift für das Thema ein.
3. Füge den Textinhalt für das Thema in das Textfeld ein.
4. Klicke auf "OK", um das Thema zur Hilfedatei hinzuzufügen.

Formatieren von Text und Hinzufügen von Bildern

1. Verwende die Formatierungssymbolleiste, um den Text zu formatieren.
2. Klicke auf "Einfügen" > "Bild", um Bilder in das Thema einzufügen.
3. Passe die Größe und Position der Bilder nach Bedarf an.

Erstellen einer neuen Hilfedatei

Um eine neue Hilfedatei im HTML Help Workshop zu erstellen, folge diesen Schritten:

Neues Projekt anlegen:

• Öffne den HTML Help Workshop.
• Klicke auf "Datei" > "Neu".
• Wähle aus der Liste der Vorlagen die gewünschte Vorlage aus (z. B. "Leere Hilfedatei").

Allgemeine Einstellungen konfigurieren:

• Hilfetitel: Gib den Titel der Hilfedatei ein.
• Dateiname: Wähle den Dateinamen und den Speicherort für die Hilfedatei.
• Sprache: Wähle die Sprache aus, in der die Hilfedatei verfasst werden soll.

Quellenordner einrichten:

• Quellverzeichnis: Gib den Pfad zum Ordner an, in dem die Quelldateien für die Hilfedatei gespeichert werden sollen.

Indexoptionen festlegen:

• Indexdateien generieren: Aktiviere dieses Kontrollkästchen, um Indexdateien für die Hilfedatei zu erstellen.
• Stoppwörterliste: Füge hier eine Liste von Wörtern hinzu, die nicht in den Index aufgenommen werden sollen.

Andere Optionen konfigurieren:

• Hilfesystem: Wähle das Hilfesystem aus, das du verwenden möchtest (z. B. HTML Help 1.0).
• Navigationsleiste: Passe die Einstellungen für die Navigationsleiste an (z. B. Größe, Position).

Projekt speichern:

• Klicke auf "Datei" > "Speichern", um das neue Projekt zu speichern.
• Das neue Projekt wird im HTML Help Workshop-Editor geöffnet.

Hinzufügen von Inhalt zur Hilfedatei

Sobald du eine neue Hilfedatei erstellt hast, kannst du damit beginnen, ihr Inhalt hinzuzufügen. Um dies zu tun, klicke in der Symbolleiste auf die Schaltfläche "Neue Seite" oder drücke STRG+N. Es öffnet sich ein neuer Tab im Hilfedatei-Editor.

Text hinzufügen

Du kannst Text zu deiner Hilfedatei hinzufügen, indem du einfach in den Editor schreibst. Du kannst verschiedene Schriftarten, Größen und Farben verwenden, um deinen Text zu formatieren. Verwende die Formatierungsoptionen in der Symbolleiste oder im Menü "Format", um Text fett, kursiv oder unterstrichen zu machen, Überschriften zu erstellen oder Listen hinzuzufügen.

Bilder hinzufügen

Um ein Bild zu deiner Hilfedatei hinzuzufügen, klicke auf die Schaltfläche "Bild" in der Symbolleiste. Wähle das Bild aus, das du hinzufügen möchtest, und klicke auf "Öffnen". Das Bild wird auf der aktuellen Seite deiner Hilfedatei eingefügt.

Du kannst die Größe und Position des Bildes ändern, indem du auf das Bild klickst und die Ziehpunkte an den Ecken oder Seiten verwendest. Du kannst auch eine Beschriftung unter dem Bild hinzufügen, indem du auf das Bild doppelklickst und in das Feld "Beschriftung" schreibst.

Hyperlinks hinzufügen

Du kannst Hyperlinks zu anderen Hilfeseiten oder externen Websites hinzufügen, indem du den Text auswählst, den du verlinken möchtest, und auf die Schaltfläche "Hyperlink" in der Symbolleiste klickst.

Gib im Dialogfeld "Hyperlink einfügen" die URL des Ziels ein und klicke auf "OK". Der ausgewählte Text wird nun mit dem Ziel verlinkt.

Inhaltsverzeichnis generieren

Wenn du deiner Hilfedatei mehrere Seiten hinzufügst, kannst du ein Inhaltsverzeichnis generieren, um die Navigation zu erleichtern. Klicke auf die Schaltfläche "Inhaltsverzeichnis" in der Symbolleiste, um ein Inhaltsverzeichnis zu erstellen.

Das Inhaltsverzeichnis wird automatisch basierend auf den Überschriftenebenen in deiner Hilfedatei generiert. Du kannst das Aussehen des Inhaltsverzeichnisses anpassen, indem du die Optionen im Dialogfeld "Inhaltsverzeichnis-Einstellungen" verwendest.

Formatieren von Text und Hinzufügen von Bildern

Sobald du den Inhalt deiner Hilfedatei strukturiert hast, kannst du mit der Formatierung des Textes und dem Hinzufügen von Bildern beginnen, um sie für den Benutzer attraktiver und einfacher zu lesen zu machen.

Formatierung von Text

HTML Help Workshop bietet dir eine Vielzahl von Optionen zur Textformatierung:

• Fett, Kursiv und Unterstrichen: Du kannst diese Formate mit den Tags <b>, <i> und <u> anwenden.
• Schriftgröße und -farbe: Verwende die Tags font size und font color, um die Größe und Farbe deines Textes anzupassen. Die Werte können wie folgt angegeben werden: font size="3" für eine Schriftgröße von 3 oder font color="#FF0000" für rote Schriftfarbe.
• Ausrichtung: Richte deinen Text mit den Tags align="left", align="center" oder align="right" aus.
• Listen: Erstelle ungeordnete Listen mit dem ul-Tag und geordnete Listen mit dem ol-Tag.

Hinzufügen von Bildern

Bilder können deinen Hilfedateien eine visuelle Ansprechende verleihen und wichtige Informationen veranschaulichen.

• Bilder einfügen: Um ein Bild hinzuzufügen, verwende das img-Tag. Du musst die Bildquelle angeben, z. B. img src="bild.jpg".
• Bildgröße anpassen: Du kannst die Größe deines Bildes mit den Attributen width und height anpassen.
• Alt-Text: Gib einen Alternativtext für das Bild mit dem Attribut alt an. Dieser Text wird angezeigt, wenn das Bild nicht geladen werden kann oder für Benutzer mit Sehbehinderungen.

Tipps für effektives Formatieren und Hinzufügen von Bildern:

• Verwende Überschriften und Zwischenüberschriften, um deine Informationen zu strukturieren und die Navigation zu erleichtern.
• Formatiere Text sparsam und vermeide es, zu viele verschiedene Formatierungen zu verwenden.
• Wähle Bilder, die relevant und informativ sind.
• Optimiere Bilder für die Webansicht, um die Ladezeiten zu verkürzen.

Strukturieren der Hilfedatei mit Abschnitten und Themen

Eine gut strukturierte Hilfedatei erleichtert deinen Nutzern die Navigation und das Auffinden der erforderlichen Informationen. In HTML Help Workshop kannst du deine Hilfedatei mit Abschnitten und Themen organisieren, um sie benutzerfreundlich zu gestalten.

Was sind Abschnitte?

Abschnitte dienen als übergeordnete Kategorien, die zusammengehörige Themen gruppieren. Sie können Abschnitte verwenden, um deine Hilfedatei in logische Blöcke zu unterteilen, z. B. "Erste Schritte", "Fehlerbehebung" oder "Referenz".

Erstellen von Abschnitten

• Gehe im HTML Help Workshop-Editor zum Menü "Ansicht" und wähle "Projekt-Explorer".
• Klicke mit der rechten Maustaste in den Projekt-Explorer und wähle "Neuer Abschnitt".
• Gib einen aussagekräftigen Namen für den Abschnitt ein und klicke auf "OK".

Was sind Themen?

Themen sind die einzelnen Hilfeseiten, die Informationen zu bestimmten Themen enthalten. Sie können Themen verwenden, um spezifische Aufgaben, Konzepte oder Fehlerbehebungsverfahren zu beschreiben.

Erstellen von Themen

• Klicke mit der rechten Maustaste auf einen Abschnitt im Projekt-Explorer und wähle "Neues Thema".
• Gib einen beschreibenden Titel für das Thema ein und klicke auf "OK".
• Der HTML-Editor wird geöffnet, in dem du den Inhalt des Themas erstellen kannst.

Verknüpfen von Themen

• Um Themen zu verknüpfen, füge einen Link in das Thema ein.
• Verwende den HTML-Code <a href="topic.htm">Linktext</a>, wobei "topic.htm" der Dateiname des verknüpften Themas ist.

Tipp: Verwenden der Strukturansicht

• HTML Help Workshop bietet eine Strukturansicht, in der du die Hierarchie deiner Abschnitte und Themen visualisieren kannst.
• Du kannst die Strukturansicht verwenden, um die Organisation deiner Hilfedatei zu überprüfen und Themen zu verschieben oder umzubenennen.

Hinzufügen von Index und Suchfunktion

Um die Benutzerfreundlichkeit deiner Hilfedatei zu verbessern, kannst du einen Index und eine Suchfunktion hinzufügen.

Index erstellen

Ein Index ist eine alphabetische Liste von Schlüsselwörtern und Verweisen auf die entsprechenden Abschnitte in der Hilfedatei. Um einen Index zu erstellen, verwende die Index-Schaltfläche in der Symbolleiste von HTML Help Workshop:

• Klicke auf Index > Neu.
• Gib einen Namen für den Index ein.
• Füge Schlüsselwörter und Verweiszielseiten hinzu.
• Klicke auf OK, um den Index zu speichern.

Suchfunktion hinzufügen

Eine Suchfunktion ermöglicht es Benutzern, nach bestimmten Begriffen in der Hilfedatei zu suchen. Um eine Suchfunktion hinzuzufügen:

• Klicke auf Suchen > Einstellungen.
• Aktiviere das Kontrollkästchen Suchfunktion aktivieren.
• Gib an, in welchen Bereichen der Hilfedatei Inhalte durchsucht werden sollen.
• Klicke auf OK, um die Einstellungen zu speichern.

Tipps für die Verbesserung der Suchfunktion

• Verwende Synonyme und verwandte Begriffe, um die Suchergebnisse zu verbessern.
• Verwende eine Rechtschreibprüfung, um sicherzustellen, dass die Schlüsselwörter korrekt geschrieben sind.
• Strukturiere die Hilfedatei mit eindeutigen Abschnitts- und Themenüberschriften, um die Relevanz der Suchergebnisse zu erhöhen.
• Überprüfe die Suchergebnisse regelmäßig und passe sie bei Bedarf an.

Erstellen und Bereitstellen der Hilfedatei

Nachdem du deine Hilfedatei erstellt hast, ist es an der Zeit, sie zu erstellen und für deine Benutzer bereitzustellen.

Erstellen der Hilfedatei

Um deine Hilfedatei zu erstellen, öffne den HTML Help Workshop und wähle "Datei" > "Kompilieren". Im Dialogfeld "Kompilieren" kannst du die folgenden Optionen einstellen:

• Ausgabeverzeichnis: Wähle den Speicherort, an dem du die kompilierte Hilfedatei speichern möchtest.
• Ausgabeformat: Wähle das Format, in dem die Hilfedatei kompiliert werden soll. HTML Help (CHM) ist das Standardformat.
• Hilfedateiname: Gib den Namen der kompilierten Hilfedatei an.

Klicke auf "Kompilieren", um den Erstellungsprozess zu starten.

Bereitstellen der Hilfedatei

Sobald deine Hilfedatei erstellt wurde, kannst du sie für deine Benutzer bereitstellen. Es gibt verschiedene Möglichkeiten, dies zu tun:

• Integration in deine Anwendung: Du kannst die CHM-Datei in deine Anwendung integrieren, sodass Benutzer direkt über die Anwendung auf die Hilfe zugreifen können.
• Verteilung mit deinem Installationsprogramm: Du kannst die CHM-Datei in das Installationsprogramm deiner Anwendung aufnehmen, sodass sie automatisch installiert wird.
• Bereitstellung auf deiner Website: Du kannst die CHM-Datei auch auf deiner Website zum Download zur Verfügung stellen.
• Verwendung eines Hilfeservers: Du kannst einen Hilfeserver verwenden, um deine Hilfedateien online bereitzustellen und so Benutzern den Zugriff von überall zu ermöglichen.

Überlegungen zur Bereitstellung

Bei der Bereitstellung deiner Hilfedatei solltest du die folgenden Punkte beachten:

• Kompatibilität: Stelle sicher, dass die Hilfedatei mit den Betriebssystemen kompatibel ist, die deine Benutzer verwenden.
• Größe: Achte darauf, dass die Hilfedatei nicht zu groß ist, da dies die Ladezeiten beeinträchtigen kann.
• Sicherheit: Stelle sicher, dass die Hilfedatei sicher ist und keine schädlichen Inhalte enthält.
• Unterstützung: Biete deinen Benutzern Unterstützung bei der Verwendung der Hilfedatei an, z. B. durch Bereitstellung einer FAQ oder eines Forums.

Fehlerbehebung bei HTML Help Workshop

Während der Verwendung von HTML Help Workshop kannst du auf verschiedene Fehler stoßen. Hier sind einige gängige Probleme und ihre Lösungen:

Dateipfadfehler

Problem: Du erhältst eine Fehlermeldung wie "Datei nicht gefunden" oder "Zugriff verweigert".

Lösung: Überprüfe, ob der Dateipfad zur Hilfedatei oder den Quellressourcen korrekt ist. Stelle außerdem sicher, dass du die erforderlichen Berechtigungen zum Zugriff auf die Dateien hast.

Markup- oder Skriptfehler

Problem: Du erhältst eine Fehlermeldung wie "Syntaxfehler" oder "Ungültiges Markup".

Lösung: Überprüfe den HTML- oder Skriptcode in der Hilfedatei sorgfältig auf Fehler. Achte auf fehlende Klammern, falsch geschriebene Tags und andere Syntaxprobleme.

Kompilierungsfehler

Problem: Das Kompilieren der Hilfedatei schlägt fehl.

Lösung: Stelle sicher, dass alle erforderlichen Komponenten installiert sind, wie z. B. der Microsoft HTML Help Compiler. In der Fehlermeldung können spezifische Details zum Kompilierungsfehler enthalten sein.

Anzeigeprobleme

Problem: Die Hilfedatei wird nicht wie erwartet angezeigt oder formatiert.

Lösung: Überprüfe die CSS-Stile in der Hilfedatei. Möglicherweise musst du bestimmte Stile anpassen, um das gewünschte Erscheinungsbild zu erzielen. Überprüfe außerdem die verwendeten Bilder und andere Ressourcen, um sicherzustellen, dass sie korrekt geladen werden.

Indexierungsfehler

Problem: Die Such- oder Indexfunktion der Hilfedatei funktioniert nicht richtig.

Lösung: Stelle sicher, dass der Index korrekt erstellt wurde und alle notwendigen Dateien indiziert wurden. Verwende das Menü "Extras" > "Index generieren" in HTML Help Workshop, um einen neuen Index zu erstellen.

Weitere Ressourcen

Du kannst auch in den folgenden Ressourcen nach Hilfe suchen:

• HTML Help Workshop-Dokumentation
• Microsoft Support-Foren
• HTML Help Workshop-Community-Foren