Help File Creation in AutoCAD OEM

Summary

Cette vidéo de formation explique comment créer un système d'aide intégré pour une application basée sur AutoCAD OEM. Elle détaille le processus pour générer une aide contextuelle pour les commandes natives et personnalisées, en utilisant des fichiers HTML et le HTML Help Workshop. Le formateur montre comment organiser les fichiers, configurer les modules et compiler un fichier CHM. Il aborde également la personnalisation des commandes locales, le test des commandes avec F1, et l'intégration de l'aide dans l'interface ruban. Enfin, des alternatives via les API ObjectARX et le code géré sont présentées pour rediriger dynamiquement les sujets d'aide.

Takeaways

• 😀 La création d'une aide contextuelle pour les commandes natives d'AutoCAD OEM nécessite une consultation du manuel des développeurs OEM.
• 😀 Le processus de création de fichiers d'aide a toujours été complexe, mais il est possible de le réussir en suivant les instructions du manuel des développeurs.
• 😀 La documentation des commandes et des fonctionnalités d'AutoCAD OEM est fournie au format HTML et ne peut pas être redistribuée avec votre produit.
• 😀 Pour intégrer du contenu personnalisé, vous devez utiliser le même format que celui des fichiers HTML existants, avec un redirectionnement vers le fichier de commande approprié.
• 😀 Les fichiers HTML doivent être nommés correctement pour garantir la compatibilité avec les outils d'AutoCAD et le comportement automatisé des commandes.
• 😀 Si vous avez un nom de commande localisé, vous pouvez rediriger vers un fichier d'aide localisé, mais le nom de fichier principal doit rester le même.
• 😀 La création d'un projet d'aide HTML se fait en utilisant le fichier HHP, et il est essentiel de respecter certains paramètres pour éviter des erreurs de compilation.
• 😀 Le fichier compilé (CHM) doit être ajouté au projet via le Make Wizard d'AutoCAD OEM pour que l'aide soit intégrée correctement dans l'application.
• 😀 La fonction F1 permet de tester l'aide contextuelle pour les commandes natives et personnalisées, et elle doit être configurée pour que l'aide apparaisse correctement.
• 😀 Il est également possible de créer des fichiers d'aide spécifiques pour l'interface utilisateur du ruban, ou de dupliquer les fichiers d'aide existants pour faciliter le processus de création.
• 😀 Une autre méthode pour rediriger les utilisateurs vers une aide personnalisée consiste à utiliser les API ARX d'AutoCAD, qui permettent de spécifier un fichier d'aide et un sujet pour chaque commande.

Q & A

Qu'est-ce qu'un système d'aide intégré pour une application basée sur AutoCAD OEM ?

Un système d'aide intégré pour une application AutoCAD OEM permet d'offrir une assistance contextuelle à l'utilisateur pour les commandes natives d'AutoCAD, ainsi que pour les commandes personnalisées d'une application OEM. Cela améliore l'expérience utilisateur en fournissant une aide directement accessible via la commande F1.

Où trouver le matériel utilisé dans cette vidéo d'exercice de formation ?

Le matériel utilisé dans cette vidéo est disponible sur la Tech Soft 3D Developer Zone sous forme d'archive téléchargeable.

Qu'est-ce qui est décrit dans le manuel des développeurs OEM concernant la création d'une aide contextuelle ?

Le manuel des développeurs OEM décrit le processus de création d'une aide contextuelle pour les commandes natives d'AutoCAD. Cependant, les instructions dans le manuel ne sont pas toujours entièrement exactes, bien qu'il soit possible d'obtenir le résultat souhaité en suivant les étapes proposées.

Comment accéder à la documentation des commandes natives dans AutoCAD OEM ?

La documentation des commandes natives d'AutoCAD OEM est fournie sous forme de fichiers HTML. Ces fichiers sont automatiquement générés avec un identifiant GUID unique pour chaque commande.

Que faut-il faire pour intégrer du contenu personnalisé dans l'aide d'AutoCAD OEM ?

Pour intégrer du contenu personnalisé, vous devez créer des fichiers HTML similaires à ceux fournis avec la plateforme OEM, puis les copier dans le même répertoire que les fichiers HTML natifs. Vous devrez également configurer votre module personnalisé dans l'outil de configuration Make Wizard.

Qu'est-ce que l'outil HTML Help Workshop et comment est-il utilisé dans ce processus ?

HTML Help Workshop est un outil utilisé pour compiler les fichiers d'aide HTML en un fichier d'aide CHM. Dans ce processus, il est utilisé pour assembler les fichiers d'aide personnalisés et les intégrer dans le système d'aide d'AutoCAD OEM.

Pourquoi faut-il utiliser un fichier HHP pour créer un projet d'aide ?

Le fichier HHP est nécessaire pour créer un projet d'aide HTML en utilisant HTML Help Workshop. Il contient les références aux fichiers HTML et définit la structure du projet d'aide. Ce fichier est compilé pour produire un fichier CHM final.

Que se passe-t-il lorsqu'une commande est lancée avec la touche F1 dans AutoCAD OEM ?

Lorsque la touche F1 est pressée, l'aide contextuelle s'affiche pour la commande active. Si la commande est une commande native, l'aide correspondante sera affichée, tandis que pour une commande personnalisée, l'aide liée à celle-ci sera également montrée.

Comment tester l'intégration de l'aide pour une commande personnalisée ?

Pour tester l'intégration de l'aide pour une commande personnalisée, il suffit d'exécuter la commande depuis la ligne de commande d'AutoCAD, puis d'appuyer sur F1. L'aide contextuelle associée à la commande personnalisée devrait alors apparaître.

Quelles sont les options disponibles si l'on veut créer une aide spécifique pour l'interface utilisateur Ribbon ?

Il est possible de créer un fichier d'aide spécifique pour l'interface utilisateur Ribbon ou de réutiliser le fichier d'aide existant en créant une copie et en l'ajoutant au projet dans le Make Wizard, en vérifiant que seule l'option de copie des fichiers est activée lors de la compilation.