- Présentation
- Comment le faire ?
- Définir la page par défaut
- Définir les options de compilation :
- Compiler un fichier d'aide
- Test de l'aide
Compiler et tester l'aide
Pour créer un fichier d'aide à partir des informations saisies sous l'éditeur d'aide, il est nécessaire de compiler l'aide. Pour chaque format d'aide (.chm ou .hlp), un compilateur spécifique est utilisé. Ces compilateurs sont fournis avec WINDEV. La compilation permet de créer le fichier d'aide final à partir de tous les éléments fournis : images, mots clés, pages d'aide, ... Une compilation doit être effectuée : - pour créer le fichier d'aide.
- à chaque modification du système d'aide (modification d'une page, d'un mot-clé, ...).
Après la compilation, le fichier d'aide peut être testé. Attention : Avant de compiler l'aide, vérifiez que les compilateurs d'aide livrés avec WINDEV sont bien référencés dans les options de l'éditeur d'aide. Définir la page par défaut Avant de compiler le système d'aide, il est nécessaire de définir la page par défaut. Cette page sera la première page d'aide affichée lors du lancement de l'aide. Pour définir la page d'aide par défaut du système d'aide : - Affichez les caractéristiques du système d'aide : sous le volet "Modification", dans le groupe "Système d'aide", cliquez sur "Description".
- Dans l'onglet "Général", sélectionnez la page par défaut.
Définir les options de compilation : Par défaut, l'aide est compilée au format CHM. Pour choisir le format d'aide à générer, il est nécessaire de définir les options de compilation : - Sous le volet "Modification", dans le groupe "Général", cliquez sur "Options".
- Sélectionnez le type d'aide à générer : chm ou hlp et indiquez les options de génération. Pour plus de détails, consultez Options de compilation.
Compiler un fichier d'aide Pour compiler un fichier d'aide : - Sous le volet "Modification", dans le groupe "Général", cliquez sur "Compiler". La compilation se lance.
- Lorsque la compilation est terminée :
- Si aucune erreur n'a été trouvée par le compilateur, le fichier d'aide se lance automatiquement.
- En cas d'erreur détectée par le compilateur, le compte-rendu de compilation apparaît. Ce compte-rendu présente :
- les avertissements : ces avertissements concernent par exemple des liens inexistants dans le fichier d'aide.
- les opérations effectuées par le compilateur, ainsi que les erreurs et les problèmes rencontrés. Le bouton "Imprimer" permet d'imprimer le compte-rendu.
Pour tester l'aide, utilisez le bouton "Voir l'aide". Test de l'aide Le test de l'aide peut être réalisé par une des méthodes suivantes : - directement lors de la compilation de l'aide (voir paragraphe précédent).
- sous le volet "Modification", dans le groupe "Général", cliquez sur "Tester". Cette option permet de lancer le dernier fichier d'aide créé. Si des modifications ont été réalisées depuis la dernière compilation, ces modifications ne sont pas prises en compte.
|
|
|
|