Fournir l'aide pour vos composants
Remonter à Accessibilité des composants au moment de la conception
Vous pouvez créer vos propres fichiers d'aide CHM et les ajouter à RAD Studio. Dans cette rubrique, vous pouvez voir comment créer une aide pour les nouveaux fichiers bibliothèque.
Vous pouvez créer de l'aide afin que l'appui sur F1 ouvre le fichier approprié correspondant à la classe ou au membre sélectionné lors de l'appui sur F1.
Cette rubrique montre comment créer le fichier CHM et installer les fichiers d'aide dans RAD Studio. Vous pouvez également voir l'exemple qui illustre une structure possible pour le fichier d'aide CHM.
Sommaire
Installation des fichiers d'aide CHM
Lorsque vous compilez les fichiers, vous générez un fichier .chm. RAD Studio stocke les fichiers CHM dans les chemins suivants correspondant à votre langue :
- Anglais :
C:\Program Files (x86)\Embarcadero\Studio\23.0\Help\Doc - Allemand :
C:\Program Files (x86)\Embarcadero\Studio\23.0\Help\Doc\de - Français :
C:\Program Files (x86)\Embarcadero\Studio\23.0\Help\Doc\fr - Japonais :
C:\Program Files (x86)\Embarcadero\Studio\23.0\Help\Doc\ja
Vous n'êtes pas obligé d'utiliser les chemins ci-dessus. Vous pouvez copier vos fichiers d'aide CHM dans un dossier quelconque en vous assurant que les fichiers CHM des langues sont stockés dans les dossiers appropriés comme suit :
- Anglais :
MyDirectory - Allemand :
MyDirectory\de - Français :
MyDirectory\fr - Japonais :
MyDirectory\ja
Vous devez créer la nouvelle valeur dans l'éditeur du Registre.
- Accédez au chemin suivant :
HKEY_CURRENT_USER\Software\Embarcadero\BDS\23.0\Help\HtmlHelp1Files\
- Dans le volet de droite, cliquez avec le bouton droit et sélectionnez Nouveau > Valeur chaîne, puis renommez la nouvelle valeur avec un nom descriptif.
- Double-cliquez sur cette nouvelle entrée pour ajouter le chemin d'accès complet et le nom du fichier CHM à Value data. Par exemple, si vous utilisez le même chemin que RAD Studio pour stocker le CHM, vous devez ajouter ce qui suit dans Value data
%programfiles(x86)%\Embarcadero\Studio\23.0\Help\Doc\NomDeVotreCHM.chm, où NomDeVotreCHM.chm est le .chm que vous avez précédemment compilé et copié dans un répertoire comme expliqué ci-dessus. Indiquez seulement le chemin vers la version anglaise du CHM, même si vous n'ajoutez pas l'aide en langue anglaise. Vous devez absolument ajouter le nom de fichier .chm correct ; RAD Studio recherche automatiquement le CHM dans les différents dossiers de langues de l'aide mentionnés ci-dessus, en fonction de la langue. Si vous ajoutez l'aide dans plusieurs langues, vérifiez que les fichiers avec le même contenu traduit ont le même nom de fichier .chm.- Remarque : Les chemins utilisant des macros ne sont pas pris en charge, seules les variables d'environnement sont autorisées.
Vous devez ajouter une nouvelle valeur de registre pour chaque fichier .chm.
Exemple d'aide CHM
Cet exemple illustre un CHM possible. L'exemple utilise un nouveau composant, appelé TClockLabel et une nouvelle propriété Format développée pour ce composant. Le nouveau composant a été développé dans une nouvelle unité appelée ClockLabel.pas.
L'exemple utilise la page Welcome.htm comme première page par défaut.
N'oubliez pas que le nom inclus entre les balises .html <Title></Title> ainsi que le champ Keyword de l'entrée Index doivent être entièrement qualifiés, comme illustré dans le tableau ci-dessous. Vous pouvez configurer le reste à votre guise.
Le tableau ci-dessous affiche un exemple d'aide CHM à quatre niveaux avec le texte requis entre les balises .html <Title></Title> et le texte du champ Keyword des entrées Index qui sont tous deux entièrement qualifiés :
| Elément | Signification | Entre les balises .html <Title></Title> et le champ Keyword de l'entrée Index
|
Nom .htm recommandé |
|---|---|---|---|
| Welcome | La page par défaut | Welcome | Welcome.htm |
| ClockLabel | L'unité ClockLabel.pas | ClockLabel | ClockLabel.htm |
| TClockLabel | La classe TClockLabel développée à l'intérieur de l'unité ClockLabel | ClockLabel.TClockLabel | ClockLabel.TClockLabel.htm |
| Format | La propriété Format de la classe TClockLabel | ClockLabel.TClockLabel.Format | ClockLabel.TClockLabel.Format.htm |
Le tableau ci-dessus illustre seulement un exemple possible, puisque vous pouvez par exemple ajouter des niveaux supplémentaires afin de regrouper les méthodes/propriétés.
Vous pouvez étendre l'EDI pour que le menu Aide > Aide tierce affiche une entrée pour votre produit et fournisse un menu d'icônes pour ouvrir vos fichiers CHM. La rubrique Extension de l'EDI (Tools API) explique les étapes requises pour étendre l'EDI, et Ajouter une icône au menu principal de l'EDI montre comment étendre le menu principal.
Pour consulter du code exemple qui montre comment ajouter votre aide au menu Aide > Aide tierce, voir :
- Exemple de code Third-Party Help Menu Item (Delphi)
- Exemple de code Third-Party Help Menu Item (C++)