DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / Editeurs / Editeur d'aide
  • Présentation
  • Comment le faire ?
  • Créer une aide associée à votre application (ou à votre site)
  • Afficher les propriétés du système d'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
Les principales étapes de la création d'un fichier d'aide (HTML, CHM ou PDF) sont les suivantes :
WEBDEV - Code Serveur Pour les sites WEBDEV ou les applications WINDEV Mobile, il est conseillé d'utiliser une aide au format PDF.
Comment le faire ?

Créer une aide associée à votre application (ou à votre site)

Pour créer une aide associée à votre application (ou à votre site) :
  1. Ouvrez votre projet sous WINDEV, WEBDEV ou WINDEV Mobile.
  2. Cliquez sur parmi les boutons d'accès rapide.
    • Dans la fenêtre qui s'affiche, cliquez sur "Architecture" puis sur "Aide".
    • L'assistant de création d'un système d'aide se lance automatiquement.
  3. Passez à l'étape suivante de l'assistant et choisissez le type de génération du système d'aide :
    • HTML : l'aide correspondra à un site statique avec un sommaire et une recherche full-text.
    • CHM : l'aide sera au format Microsoft HTML Help 1.3.
    • PDF : l'aide correspondra à un document au format PDF avec sommaire et signets.
  4. Passez à l'étape suivante.
  5. Indiquez le nom du système d'aide. Passez à l'étape suivante de l'assistant.
  6. Sélectionnez les fenêtres de votre application pour lesquelles une page d'aide doit être générée.

    Lors d'une génération au format CHM, l'option "Générer automatiquement le bouton d'aide dans chaque fenêtre" permet de créer automatiquement un bouton d'aide dans chaque fenêtre sélectionnée. Ce bouton ouvrira automatiquement la page d'aide correspondante.
  7. Passez à l'étape suivante.
  8. Sélectionnez les états de votre application pour lesquels une page d'aide doit être générée. Passez à l'étape suivante de l'assistant.
  9. Validez. L'assistant crée l'ensemble des pages d'aide spécifiées et propose de générer l'aide au format indiqué.
  10. Enregistrez l'aide : un fichier WDH est créé dans votre projet.
Le système d'aide est créé et affiché sous l'éditeur d'aide. Chaque page d'aide peut ensuite être modifiée, supprimée, ... sous l'éditeur d'aide.
Liste des pages de l'aide.
Cette liste correspond à la table des matières du fichier d'aide généré.
Image de la fenêtre ou de l'état associé à la page d'aide.
Cette image est affichée dans une zone d'entête.
Cette image correspond à la fenêtre ou l'état associé à la page d'aide en édition. Cette image peut être déplacée par exemple dans la zone de corps de la page d'aide.
Titre de la page d'aide.
Ce titre est affiché dans une zone d'entête. Cette zone pourra avoir une couleur de fond spécifique.
Corps de la page d'aide.
Contient le texte, les images, les liens, ... de l'aide.
Dans les pages générées par défaut pour les fenêtres et les états de l'application, cette zone comprend l'image de la fenêtre ou de l'état et si nécessaire l'image de chaque plan.
Onglets permettant de passer du sommaire à l'index.
Remarque : Lorsque votre système d'aide est créé, pour ouvrir ce système d'aide sous l'éditeur, il suffit d'utiliser une des méthodes suivantes :
  • sous le volet "Accueil", dans le groupe "Général", déroulez "Ouvrir", sélectionnez "Ouvrir" puis le fichier d'aide correspondant (fichier WDH).
  • sélectionnez le dossier "Aides" dans le volet "Explorateur de projet" et double-cliquez sur le nom du système d'aide.

Afficher les propriétés du système d'aide

Les propriétés du système d'aide permettent de définir :
  • le nom logique du système d'aide,
  • la page par défaut affichée par l'aide,
  • les langues gérées par le système d'aide,
  • ...
Pour afficher les propriétés du système d'aide, sous le volet "Modification", dans le groupe "Système d'aide", cliquez sur "Description".
Pour plus de détails, consultez Propriétés du système d'aide.
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 23/05/2023

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