DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / Editeurs / Editeur d'aide
  • 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
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget IOSApple WatchMac CatalystUniversal Windows 10 App
Autres
Procédures stockées
Présentation
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 (aide au format HTML, HTML Help ou PDF), un compilateur spécifique est utilisé. Ces compilateurs sont fournis avec WINDEV, WEBDEV et WINDEV Mobile.
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 (CHM, PDF ou pages HTML).
  • à chaque modification du système d'aide (modification d'une page, d'un mot-clé, etc.).
Après la compilation, le fichier d'aide généré peut être testé.
Attention : Avant de compiler l'aide, vérifiez que les compilateurs d'aide livrés avec WINDEV, WEBDEV ou WINDEV Mobile sont bien référencés dans les options de l'éditeur d'aide.
Comment le faire ?

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 :
  1. Affichez les caractéristiques du système d'aide : sous le volet "Modification", dans le groupe "Système d'aide", cliquez sur "Description".
  2. 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 choisi lors de la création du système d'aide.
Pour choisir le format d'aide à générer, il est nécessaire de définir les options de compilation :
  1. Sous le volet "Modification", dans le groupe "Général", cliquez sur "Options".
  2. Sélectionnez le type d'aide à générer et indiquez si nécessaire les options de génération.
    Pour plus de détails, consultez Options de compilation.
WEBDEV - Code Serveur Pour les sites WEBDEV ou les applications WINDEV Mobile, il est conseillé d'utiliser une aide au format PDF.

Compiler un fichier d'aide

Pour compiler un fichier d'aide :
  1. Sous le volet "Modification", dans le groupe "Général", cliquez sur "Compiler".
    La compilation se lance.
  2. 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 "Tester".

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.
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 03/05/2023

Signaler une erreur ou faire une suggestion | Aide en ligne locale