DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / Editeurs / Editeur d'aide
  • Présentation
  • Comment le faire ?
  • Créer une page d'aide vierge
  • Créer une page d'aide à partir d'un document existant
  • Supprimer une page d'aide
  • Modifier les pages d'aide
  • Parties d'une page d'aide
  • Dans une page d'aide, il est possible de :
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
Une aide est constituée de plusieurs pages. Les pages sont les éléments de base d'une aide. Quand l'utilisateur consulte l'aide, il lit le contenu d'une page d'aide.
Plusieurs types de pages d'aide peuvent être mises en place dans un fichier d'aide, voici les plus courants :
  • des pages d'aide contextuelle : le contenu de la page d'aide donne des indications sur l'utilisation d'une fenêtre spécifique. Ce type de page d'aide est par exemple lancé à partir de l'icône d'aide (bouton "?") présent sur la fenêtre.
  • des pages d'aide "Comment le faire" : ces pages d'aide décrivent pas à pas les différentes étapes pour réaliser une opération.
  • des pages d'aide "Conceptuelle" : ces pages d'aide présentent un concept, une idée, définissent les termes utilisés.
Les pages d'aides sont reliées entre elles par des liens. Les liens permettent aux utilisateurs de se déplacer et de parcourir le système d'aide.
Remarque : Pour générer automatiquement les pages d'aide correspondant aux différents éléments du projet (fenêtres et états), sous le volet "Modification", dans le groupe "Système d'aide", cliquez sur "Générer les pages d'aide du projet".
Comment le faire ?

Créer une page d'aide vierge

Pour créer une page d'aide vierge :
  • 1ère méthode :
    • Sélectionnez une page dans le sommaire.
    • Sous le volet "Modification", dans le groupe "Table des matières", déroulez "Nouveau" et sélectionnez "Nouvelle page vierge".
    • Une nouvelle page vierge est automatiquement créée et peut être modifiée.
  • 2ème méthode : Dans le menu contextuel du sommaire, sélectionnez l'option "Nouveau .. Nouvelle page vierge". Une nouvelle page vierge est automatiquement créée et peut être modifiée.
  • 3ème méthode :
    • Sous le volet "Modification", dans le groupe "Table des matières", déroulez "Nouveau" et sélectionnez "Nouvelle page".
    • Dans l'assistant qui se lance, sélectionnez l'option "Créer une page vierge".
    • Précisez les caractéristiques de la page et validez.
  • 4ème méthode : Dans le menu contextuel du sommaire, sélectionnez l'option "Nouveau .. Nouvelle page". Dans l'assistant qui se lance, sélectionnez l'option "Créer une page vierge". Précisez les caractéristiques de la page et validez.

Créer une page d'aide à partir d'un document existant

La création d'une page d'aide à partir d'un document existant est réalisée grâce à un assistant. Il suffit de sélectionner dans cet assistant :
  • le nom et le chemin du fichier à importer (fichier au format txt, htm ou RTF).
  • le nom de la page d'aide à créer.
Attention : Si le document importé contient plusieurs pages, toutes les pages seront importées dans une seule page d'aide.
Pour lancer l'assistant d'importation, utilisez une des méthodes suivantes :
  • sous le volet "Modification", dans le groupe "Table des matières", déroulez "Nouveau" et sélectionnez "Nouvelle page". Dans l'assistant qui se lance, sélectionnez l'option "Importer un document existant".
  • sélectionnez l'option "Nouveau .. Nouvelle page" dans le menu contextuel du sommaire. Dans l'assistant qui se lance, sélectionnez l'option "Importer un document existant".

Supprimer une page d'aide

Pour supprimer une page d'aide :
  1. Sélectionnez la page d'aide dans le sommaire.
  2. Sélectionnez l'option "Supprime la page" dans le menu contextuel du sommaire (ou utilisez la touche Suppr).
Modifier les pages d'aide

Parties d'une page d'aide

Une page d'aide est constituée de différentes parties :
Toutes ces parties peuvent être modifiées.

Dans une page d'aide, il est possible de :

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