HTML-Hilfetypen

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Aufrufen von HTML-Hilfe aus Anwendungen

Unter Windows können für Benutzeranwendungen mehrere Hilfeformate verwendet werden:

CHM – HTMLHelp

HTMLHelp ist das Microsoft-HTML-Hilfeformat (Microsoft Compiled HTML Help). HTMLHelp ist ein proprietäres Online-Hilfeformat unter 32-Bit-Windows. HTMLHelp wurde als Nachfolger des Microsoft-WinHelp-Formats in Windows 98 eingeführt und wird auch in Windows 7 unterstützt. HTMLHelp ist das am weitesten verbreitete Windows-Hilfeformat.

HTMLHelp-Hilfedateien werden als Binärdateien mit der Erweiterung CHM ausgeliefert. Eine CHM-Datei enthält eine Reihe von HTML-Dateien, ein Inhaltsverzeichnis mit Hyperlinks und einen Index.

Viewer für CHM-Hilfedateien werden mit dem Betriebssystem Windows ausgeliefert. Die Funktion HTMLHelp stellt die API des Hilfe-Viewers der CHM-Hilfedateien bereit.

Die VCL von RAD Studio enthält die Unit Vcl.HtmlHelpViewer, die die Delphi- und C++-Wrapper für die HTMLHelp-Funktions-API implementiert. Zur Verwendung von Hilfedateien im CHM-Format in VCL-Anwendungen müssen Sie die Unit Vcl.HtmlHelpViewer in die uses-Klausel des Hauptformulars der VCL-Anwendung aufnehmen. Für C++ müssen Sie die Header-Datei Vcl.HtmlHelpViewer.hpp einbeziehen. (Weitere Informationen finden Sie in den HTMLHelp-Themen in MSDN.)

Hierbei handelt es sich um das von RAD Studio verwendete Hilfesystem. Siehe Hilfe zur Hilfe - CHM.

HXS – HTML Help 2.0 Microsoft-Hilfe

Das Format HTML Help 2.0 wird von Visual Studio 2002 bis 2008 verwendet.
HTML Help 2.0-Dateien haben die Erweiterung HXS. Compilierte HXS-Hilfedateien enthalten HTML-Quelldateien.

Jede HXS-Hilfedateisammlung muss registriert werden (in der Windows-Registrierung), bevor sie angezeigt werden kann. Diese Registrierung kann von Ihrer Anwendung entweder mit dem speziell programmierten Installationsprogramm oder mit einem Registrierungstool eines Fremdherstellers durchgeführt werden.

HXS-Hilfedateien können im Hilfe-Viewer dexplore.exe von Microsoft oder mit Viewern von Fremdherstellern angezeigt werden. Viewer für HXS-Dateien werden nicht mit dem Windows-Betriebssystem ausgeliefert.

Die API von dexplore.exe ist nicht offiziell dokumentiert, und RAD Studio stellt keine Unit zur Kapselung der dexplore.exe-API bereit.

Das Microsoft Help 2-Format wurde in erster Linie für Visual Studio-Hilfeintegratoren entwickelt. Microsoft empfiehlt die Verwendung von HXS-Hilfedateien in allgemeinen Anwendungen nicht.

MSHC – Microsoft Help 3

MSHC Help ist auch unter den Namen Microsoft Help 3 oder Microsoft Help Viewer 1.x bekannt. Dieses Format ist der Nachfolger von Microsoft Help 2.

Das Format der Themendateien ist XHTML 1.x (kompatibel mit HTML). Eine Hilfedatei hat die Dateierweiterung MSHC (Microsoft-Hilfe-Container) und ist eine Standard-Zip-Datei mit den Themendateien. Eine MSHC-Hilfedatei enthält keine proprietäre Dateien, nur Themendateien. Verschiedene Themenattribute, einschließlich von Inhaltsverzeichnis (TOC), Index und Schlüsselwörtern, werden über Standard-HTML-Meta-Tags definiert.

MSHC-Hilfedateien können mit jedem beliebigen Webbrowser angezeigt werden.

Ein Hilfe-Compiler ist nicht erforderlich.

Das MSHC-Hilfeformat verfügt über das Potenzial, das nächste allgemeine (Unicode-basierte) Hilfesystem für Windows zu werden.

RAD Studio stellt für die MSHC-Hilfe keine Unterstützung bereit.

MSHC-Hilfedateien können aus RAD Studio-Anwendungen mit der Funktion ShellExecute geöffnet werden.

Zur Verwendung von ShellExecute in Anwendungen müssen Sie die Unit ShellAPI in die uses-Klausel des Hauptformulars der Anwendung aufnehmen. Eine Beschreibung von ShellExecute finden Sie in der MSDN-Hilfe. Die RTL von RAD Studio deklariert ShellExecute in der Datei "source\rtl\win\ShellAPI.pas".

HLP – WinHelp (veraltet)

Ab Windows Vista wird das HLP-Hilfeformat von Microsoft nicht mehr unterstützt. Daher ist auch die Verwendung der HLP-Hilfe und der Unit WinHelpViewer veraltet.

Die Microsoft-WinHelp ist ein proprietäres Format für Online-Hilfedateien unter 16-Bit- und 32-Bit-Windows ab der Plattform Windows 3.0 bis zu Windows XP. Die Hilfedateien im WinHelp-Format haben die Erweiterung HLP. Das WinHelp-Format basiert auf RTF-Dokumenten (Rich Text Format).

HLP-Hilfedateien können im Hilfebrowser winhelp.exe oder winhlp32.exe von Microsoft angezeigt werden. Die Funktion WinHelp stellt die API des Hilfe-Viewers von HLP-Hilfedateien bereit.

Die VCL von RAD Studio enthält die Unit WinHelpViewer, die die Delphi- und C++-Wrapper für die WinHelp-Funktions-API implementiert. Zur Verwendung von Hilfedateien im HLP-Format in VCL-Anwendungen müssen Sie die Unit WinHelpViewer in die uses-Klausel des Hauptformulars der VCL-Anwendung aufnehmen. Sie können den WinHelp-Viewer von der folgenden Microsoft-Website herunterladen: http://www.microsoft.com/downloads/details.aspx?familyid=6ebcfad9-d3f5-4365-8070-334cd175d4bb

Andere HTML-Hilfeformate

Es gibt einige andere HTML-Hilfeformate, die gebräuchlichsten sind in der folgenden Liste aufgeführt:

  • HTML Help – Eine Reihe untereinander verlinkter HTM/HTML-Dateien.
Diese Dateien können in jedem beliebigen Webbrowser angezeigt werden.
RAD Studio stellt für die HTML Help keine Unterstützung bereit.
HTML-Hilfethemen können aus RAD Studio-Anwendungen mit der Funktion ShellExecute geöffnet werden.
  • WebHelp – Eine Sammlung einzelner (HTML-)Dateien, die weder komprimiert noch compiliert sind. WebHelp eignet sich zum Veröffentlichen auf einem Web- oder Intranetserver. WebHelp kann auch als lokal installierte Hilfe bereitgestellt werden.
WebHelp-Dateien können in jedem beliebigen Webbrowser angezeigt werden.
RAD Studio stellt für die HTML Help keine Unterstützung bereit.
HTML-Hilfethemen können aus RAD Studio-Anwendungen mit der Funktion ShellExecute geöffnet werden.

Siehe auch