PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

  • Présentation
  • Documentation technique du projet
  • Type d'informations à imprimer
  • Contenu de la documentation technique
  • Couverture et préface de la documentation technique
  • Type d'édition de la documentation technique
  • Documentation technique de l'élément en cours
  • Contenu de la documentation technique
  • Type d'édition de la documentation technique
  • Zone d'impression
  • Spécifier les zones d'impression
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
Il est possible d'imprimer différentes documentations techniques détaillant l'ensemble des éléments (fenêtre, page, état, fichier de données, rubrique, composant, assemblage, perso-dossiers, ...) du projet. Ces documentations techniques peuvent être imprimées en déroulant l'icône Imprimer présente sous le volet "Accueil" dans le groupe "Général" :
  • l'option "Imprimer la documentation technique du projet" permet de lancer la fenêtre de configuration de l'impression de la documentation technique. Il est possible de choisir le type d'informations à imprimer pour le projet. La documentation technique peut contenir l'ensemble des caractéristiques du projet et de ses éléments.
  • l'option "Imprimer". La documentation technique est alors constituée uniquement des caractéristiques de l'élément en cours (fenêtre, état, requête, perso-dossier, projet, ...).
    Si l'option "Imprimer" est utilisé sur un élément simple (par exemple le code d'un élément), seul cet élément sera imprimé.
Remarques :
  • Si le format d'impression de la documentation technique doit être modifié (passage de A4 à A3), il est possible d'adapter les pages de la documentation au nouveau format. Pour plus de détails, consultez le paragraphe Zone d'impression.
  • L'impression de la documentation technique n'est pas disponible dans le logiciel "Etats et requêtes".
  • Dans les versions précédentes, la documentation technique avait pour nom "le dossier de programmation".
  • Versions 27 et supérieures
    Lors de l'impression d'un code WLangage depuis l'éditeur de code, une boîte de dialogue permet de :
    • choisir l'imprimante à utiliser.
    • choisir l'orientation du papier.
    • adapter ou non la taille des zones d'impression au format de l'imprimante.
    Nouveauté 27
    Lors de l'impression d'un code WLangage depuis l'éditeur de code, une boîte de dialogue permet de :
    • choisir l'imprimante à utiliser.
    • choisir l'orientation du papier.
    • adapter ou non la taille des zones d'impression au format de l'imprimante.
    Lors de l'impression d'un code WLangage depuis l'éditeur de code, une boîte de dialogue permet de :
    • choisir l'imprimante à utiliser.
    • choisir l'orientation du papier.
    • adapter ou non la taille des zones d'impression au format de l'imprimante.
Documentation technique du projet

Type d'informations à imprimer

Plusieurs types de documentation technique sont proposés :
Types d'informations
  • Synthétique : Contient les informations de base sur les éléments du projet.
  • Code : Contient l'ensemble des traitements de tous les objets du projet ainsi que les procédures.
  • Complet : Contient toutes les informations du projet. Ce type de documentation technique peut être très volumineux.
  • Personnalisé : Correspond à une sélection des informations à imprimer.

Contenu de la documentation technique

La documentation technique de type complet du projet peut être constituée de plusieurs parties :
  • Description du projet (éléments présents dans le projet, code du projet, ...).
  • Description des composants internes du projet.
  • Description de l'analyse (graphe de l'analyse, dictionnaire des données, ...).
  • Description des fenêtres et / ou des pages (image des fenêtres, liste des champs présents dans chaque fenêtre, ...).
  • Description des modèles de fenêtres ou de pages
  • Description des états (image des états, liste des champs présents dans chaque état, ...).
  • Description des modèles d'états.
  • Description des requêtes (image des requêtes, code SQL correspondant, ...).
  • Description des classes (code des classes, ...).
  • Description des modèles UML (graphe du diagramme UML, liste des relations du diagramme, ...).
  • Description des modélisations souples (graphe, liste des applications, liste des composants, ...).
  • Description des collections de procédures (code, messages multilingues, perso-notes, ...).
  • Description des tests automatiques (code, synthèse des résultats).
  • Description des règles métier (description, fichiers attachés, liens, ...).
Lors de l'impression de la documentation technique de type synthétique, seules les informations de base concernant le projet, les fenêtres et ou les pages, les modèles et les états sont imprimées.
Lors de l'impression d'une documentation technique de type personnalisé, pour chaque partie, il est possible de choisir les informations imprimées (bouton "Editer").
Choix des informations imprimées dans la documentation technique

Par exemple, pour les requêtes, il est possible d'imprimer :
  • la représentation graphique des requêtes,
  • les informations générales des requêtes (nom logique et physique des requêtes, type des requêtes, analyse associée aux requêtes, ...),
  • les informations spécifiques aux résultats des requêtes (rubriques résultat, paramètres des requêtes, critères de tri, ...),
  • les informations sur les caractéristiques des requêtes (conditions de sélection, groupements, ...),
  • le code SQL correspondant aux requêtes.
  • les perso-notes.
  • les règles métier.
Quelque soit le type de documentation technique, il est également possible de sélectionner les différents éléments du projet à prendre en compte dans la documentation.
Eléments du projet à imprimer
Le bouton "Modifier" permet de sélectionner par exemple une ou plusieurs fenêtres.
Choix des éléments à imprimer
Seules les informations concernant les fenêtres sélectionnées apparaîtront dans la documentation.
Remarque : Si le projet en cours est un projet commun, contenant des fenêtres WINDEV, des fenêtres Mobile et des pages WEBDEV, il est possible d'imprimer les renseignements concernant tous les éléments du projet, quel que soit le produit avec lequel l'impression est réalisée.
Attention : Si des représentations graphiques (analyse, diagrammes UML, ...) doivent être imprimées, il est nécessaire de configurer les zones d'impression. Pour plus de détails sur les zones d'impression, consultez le paragraphe Zones d'impression.

Couverture et préface de la documentation technique

Il est possible de définir une couverture et une préface pour la documentation technique.
Couverture et préface de la documentation technique
  • La page de couverture peut être configurée via le bouton Bouton de configuration. Il est possible de définir :
    • le type de couverture :
      Type de couverture
    • les informations affichées :
      Informations de la couverture
  • La préface peut être saisie via le bouton Préface.

Type d'édition de la documentation technique

La documentation technique peut être imprimée sur l'imprimante sélectionnée. Lors de l'impression, la documentation technique est affichée dans le visualisateur de rapports. Il est alors possible de :
  • lancer l'impression,
  • exporter la documentation technique au format PDF (via le volet "Exporter").
Documentation technique de l'élément en cours

Contenu de la documentation technique

Le contenu de cette documentation technique est personnalisable : seules les informations sélectionnées seront détaillées.
Documentation technique d'une fenêtre
Documentation technique d'une fenêtre
Par exemple, si l'élément en cours est une fenêtre, il est possible d'imprimer une ou plusieurs de ces informations :
  • les informations générales de la fenêtre (nom logique et physique de la fenêtre, titre de la fenêtre, ...),
  • l'image de la fenêtre,
  • les informations sur les champs présents dans la fenêtre (nom et libellé des champs, caractéristiques des champs, ...),
  • les informations sur les menus de la fenêtre (nom des différentes options, raccourcis clavier des options, ...),
  • le code de la fenêtre,
  • le code des champs présents dans la fenêtre,
  • les procédures de la fenêtre,
  • les messages multilingues de la fenêtre.
  • ...
Remarque : Si l'élément en cours est une fenêtre de code, l'option "Imprimer" permet uniquement d'imprimer les différents codes affichés dans cette fenêtre.

Type d'édition de la documentation technique

La documentation technique peut être imprimée sur l'imprimante sélectionnée. Lors de l'impression, la documentation technique est affichée dans le visualisateur de rapports. Il est alors possible de :
  • lancer l'impression,
  • exporter la documentation technique au format PDF (via le volet "Exporter").
Zone d'impression

Spécifier les zones d'impression

Si des représentations graphiques (MLD, diagrammes UML, ...) doivent être imprimées, il est nécessaire de configurer les zones d'impression avant d'imprimer la documentation technique.
Pour spécifier les zones d'impression de la représentation graphique en cours :
  1. Sous le volet "Affichage", dans le groupe "Edition", cochez l'option "Zones d'impression". Des bordures représentant les zones imprimables dans la documentation technique apparaissent sous l'éditeur en cours.
  2. Réduisez l'affichage de la représentation graphique pour visualiser l'ensemble du graphe :
    • sous le volet "Affichage", modifiez la valeur du zoom.
    • utilisez Ctrl + Roulette de la souris.
  3. A l'aide de la souris :
    • déplacez les bordures à l'endroit désiré en maintenant le bouton de la souris enfoncé (la couleur du curseur de la souris est noire).
    • choisissez le nombre de pages sur lesquelles la représentation graphique doit être imprimée (le curseur de la souris se transforme en double-flèche Nord-Ouest / Sud-Est).
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire