Hilfe für Ihre Komponenten bereitstellen
Nach oben zu Komponenten zur Entwurfszeit verfügbar machen - Index
Sie können eigene CHM-Hilfedateien erstellen und sie RAD Studio hinzufügen. In diesem Thema wird gezeigt, wie Sie Hilfe für neue Bibliotheksdateien erstellen.
Sie können die Hilfe so erstellen, dass beim Drücken von F1 die entsprechende Datei für die Klasse oder den Member geöffnet wird, auf der bzw. auf dem sich der Cursor gerade befindet.
In diesem Thema wird gezeigt, wie die CHM-Datei erstellt wird und die Hilfedateien in RAD Studio installiert werden. Außerdem wird anhand eines Beispiels eine mögliche Struktur der CHM-Hilfedatei dargestellt.
Inhaltsverzeichnis
Installieren der CHM-Hilfedateien
Beim Compilieren der Dateien wird eine CHM-Datei erzeugt. RAD Studio speichert die CHM-Dateien je nach Sprache in den folgenden Pfaden:
- Englisch:
C:\Program Files (x86)\Embarcadero\Studio\22.0\Help\Doc - Deutsch:
C:\Program Files (x86)\Embarcadero\Studio\22.0\Help\Doc\de - Französisch:
C:\Program Files (x86)\Embarcadero\Studio\22.0\Help\Doc\fr - Japanisch:
C:\Program Files (x86)\Embarcadero\Studio\22.0\Help\Doc\ja
Sie müssen die oben angegebenen Pfade nicht verwenden, Sie können Ihre CHM-Hilfedateien in einen beliebigen Ordner speichern. Sie müssen nur sicherstellen, dass die CHM-Sprachdateien in dem richtigen Sprachordner wie folgt gespeichert werden:
- Englisch:
MyDirectory - Deutsch:
MyDirectory\de - Französisch:
MyDirectory\fr - Japanisch:
MyDirectory\ja
Sie müssen den neuen Wert im Registrierungs-Editor erstellen.
- Öffnen Sie den folgenden Pfad:
HKEY_CURRENT_USER\Software\Embarcadero\BDS\22.0\Help\HtmlHelp1Files\
- Klicken Sie im rechten Bereich mit der rechten Maustaste, und wählen Sie Neu > Zeichenfolge; geben Sie dann dem neuen Wert einen beschreibenden Namen.
- Doppelklicken Sie auf diesen neuen Eintrag, um den vollständigen Pfad und den CHM-Dateinamen dem Feld Wert hinzuzufügen. Wenn Sie beispielsweise denselben Pfad RAD Studio zum Speichern der CHM-Datei verwenden, müssen Sie Folgendes in das Feld Wert eingeben:
%programfiles(x86)%\Embarcadero\Studio\22.0\Help\Doc\NameIhrerCHM.chm. NameIhrerCHM ist die CHM-Datei, die Sie zuvor compiliert und in dieses Verzeichnis kopiert haben (wie oben erklärt). Geben Sie nur den Pfad zu der englischen Version der CHM-Datei an, auch wenn Sie keine Hilfe in englischer Sprache hinzufügen. Achten Sie darauf den richten Namen der CHM-Datei anzugeben; RAD Studio sucht automatisch die CHM-Datei entsprechend der jeweiligen Sprache in den verschiedenen, oben aufgeführten Help-Sprachordnern. Wenn Sie Hilfe in mehreren Sprachen hinzufügen, müssen die Dateien mit demselben übersetzten Inhalt den gleiche CHM-Dateinamen haben.- Hinweis: Pfade mit Makros werden nicht unterstützt; es sind nur Umgebungsvariablen zulässig.
Sie müssen für jede CHM-Datei einen neuen Registrierungseintrag hinzufügen.
Beispiel einer CHM-Hilfe
Dieses Beispiel zeigt eine mögliche CHM-Hilfe. In diesem Beispiel wird die neue Komponente TClockLabel und die neu entwickelte Eigenschaft Format für diese Komponente verwendet. Die neue Komponente wurde in der neuen Unit ClockLabel.pas entwickelt.
In dem Beispiel wird die Seite Welcome.htm standardmäßig als erste Seite verwendet.
Denken Sie daran, dass der Name zwischen den HTML-Tags <Title></Title> sowie das Feld Keyword des Indexeintrags voll qualifiziert sein müssen (siehe die folgende Tabelle). Den Rest können Sie gemäß Ihren Erfordernissen konfigurieren.
Die folgende Tabelle enthält ein Beispiel einer CHM-Hilfe mit vier Ebenen mit dem erforderlichen Text zwischen den HTML-Tags <Title></Title> und dem Text des Feldes "Keyword" der Indexeinträge, beide voll qualifiziert:
| Element | Repräsentiert | HTML-Tags zwischen <Title></Title> & Keyword-Feld des Indexeintrags
|
Empfohlener HTM-Name |
|---|---|---|---|
| Welcome | Die Standardseite | Welcome | Welcome.htm |
| ClockLabel | Die Unit ClockLabel.pas | ClockLabel | ClockLabel.htm |
| TClockLabel | Die in der Unit ClockLabel entwickelte Klasse TClockLabel | ClockLabel.TClockLabel | ClockLabel.TClockLabel.htm |
| Format | Die Eigenschaft Format der Klasse TClockLabel | ClockLabel.TClockLabel.Format | ClockLabel.TClockLabel.Format.htm |
In der obigen Tabelle wird nur ein mögliches Beispiel dargestellt, Sie können beispielsweise weitere Ebenen hinzufügen, um die Methoden/Eigenschaften zu gruppieren.
Zugriff auf Ihre CHM-Dateien im Menü Hilfe der IDE ermöglichen
Sie können die IDE erweitern, sodass im Menü Hilfe > Hilfe von Drittherstellern ein Eintrag für Ihr Produkt und Menüeinträge zum Öffnen Ihrer CHM-Dateien angezeigt werden. Erweitern der IDE mit der Tools-API erläutert die erforderlichen Schritte zum Erweitern der IDE und Hinzufügen eines Eintrags zum Hauptmenü der IDE zeigt wie das Hauptmenü erweitert wird.
Zum Beispiel der Code, der zeigt, wie Ihre Hilfe dem Menü Hilfe > Hilfe von Drittherstellern hinzugefügt wird, siehe:
- Third-Party Help Menu Item (Delphi) (Codebeispiel)
- Third-Party Help Menu Item (C++) (Codebeispiel)