Erstellung von Help-ID-Map-Dateien

Um Ihre Anwendung mit kontextsensitiver Hilfe zu verknüpfen, benötigt der Entwickler eine Brücke zwischen den Oberflächenelementen (Schaltflächen, Fenstern) und den Abschnitten der CHM-Datei. Diese Brücke wird mithilfe numerischer IDs (Help Context ID) und textbasierter Aliase geschaffen, die jedem Hilfeabschnitt zugewiesen werden.

Dr.Explain weist diese IDs nicht nur automatisch zu, sondern generiert auch Map-Dateien – fertige Dateien mit Definitionen, die der Entwickler direkt in den Quellcode des Projekts einbinden kann.

Unterstützte Formate für Map-Dateien:

• .h;
• .vb;
• .inc.

Dies automatisiert den Integrationsprozess: Sie erstellen die Dokumentation, Dr.Explain erzeugt die Datei für den Entwickler, und der Benutzer erhält eine einwandfrei funktionierende kontextsensitive Hilfe per F1.

Was ist eine kontextsensitive Hilfedatei?

Diese Datei ordnet die Seiten Ihres Handbuchs den Oberflächenelementen Ihres Programms zu. Jedes Steuerelement hat einen eigenen Code oder Namen. Dieselben Werte sind in den Eigenschaften der Abschnitte in der Dokumentation angegeben. Auf diese Weise kann das Programm mithilfe der Funktionen der Microsoft HtmlHelp-API die Hilfedatei genau auf der Seite öffnen, die mit einem bestimmten Element seiner grafischen Oberfläche verknüpft ist.

Beispiel: Wenn ein Benutzer im Hauptfenster der Anwendung die kontextsensitive Hilfe aufruft, sieht er das CHM-Handbuch, das genau auf der Seite geöffnet wird, die dieses Fenster erklärt.

Wie erstelle ich eine Map-Datei für Help Context IDs in Dr.Explain?

Eine Map-Datei können Sie über das Hauptmenü beim Export ins CHM-Format erstellen:

Oder indem Sie das Symbol 'CHM erstellen' in der Symbolleiste auswählen oder die Tastenkombination Alt+Umschalt+M drücken:

Beispiele für mit Dr.Explain erstellte Benutzerdokumentationen

Nachfolgend finden Sie einige Screenshots von Benutzerhandbüchern, nicht nur im CHM-Format, sondern auch in anderen Formaten:

Welche Vorteile bieten sich Ihnen mit Dr.Explain?

• Zeitersparnis für Entwickler. Sie müssen nicht hunderte IDs manuell im Code erstellen und verwalten. Dr.Explain erledigt das für Sie mit einem einzigen Klick.
• Garantierte Integrität der Verknüpfungen. Die IDs in der Map-Datei stimmen exakt mit den den Hilfeabschnitten zugewiesenen IDs überein.
• Unterstützung gängiger Entwicklungsumgebungen.
• Transparenz für das Team. Der Entwickler erhält eine verständliche .h/.vb/.inc-Datei, während der technische Redakteur unabhängig am Dokumentationsprojekt arbeitet.
• Automatisierter Prozess. Die Zuweisung der IDs und die Generierung der Map-Datei erfolgen direkt in der Dr.Explain-Oberfläche.

Für wen ist Dr.Explain geeignet?

• Entwicklern von Windows-Anwendungen, die eine standardmäßige kontextsensitive Hilfe (F1) benötigen und es leid sind, IDs manuell mit Hilfethemen zu verknüpfen.
• Technischen Redakteuren, die mit einem Entwicklungsteam zusammenarbeiten. Sie erstellen die Inhalte, und das Tool zur Generierung von Map-Dateien ist die 'Brücke' zum Code, die der Entwickler nutzen kann.
• Teams, die komplexe Software mit Hunderten von Fenstern und Dialogen entwickeln. Die Automatisierung der ID-Vergabe und Map-Datei-Erstellung spart viel Zeit.
• Allen, die möchten, dass die Dokumentation nicht nur eine Datei, sondern ein Teil des Produkts ist. Eine richtig integrierte Hilfe steigert die Qualität und Benutzerfreundlichkeit der Software.

Nutzer über die Erstellung von Map-Dateien in Dr.Explain

'Nach der Erstellung einer CHM-Datei können wir diese problemlos in unsere .NET-Anwendungen einbinden.'

Alex Muir, Geschäftsführer der Firma Database Software Solutions Ltd

Häufig gestellte Fragen (FAQ)

Siehe auch

 
• Integration der Hilfedatei in die Anwendung
• Automatische Zuweisung von Help-IDs
• Kontextsensitive Hilfe