Rubriques de la documentation

Le dossier documentation d’un projet peut contenir les rubriques suivantes :

  • Page de titre

  • Sommaire

  • Informations générales

  • Configuration

  • Types données dérivés

  • Type FB dérivés

  • Types EFB

  • Types EF

  • Variables et instances FB

  • Structure du projet

  • Projet fonctionnel

  • Communication

  • Programmes

  • Table d'animation

  • Ecran d'exploitation

  • Références croisées

  • Bas de page

NOTE : grâce aux options Edition > Inclure la rubrique et Edition > Exclure la rubrique, vous pouvez définir les rubriques à utiliser dans votre documentation.

Page de titre

Cette rubrique concerne l'impression de la page de titre.

Contenu de la rubrique :

  • Nom du projet

  • Nom du concepteur

  • Version du logiciel

  • Date de création

  • Date de la dernière modification

  • Automate cible

NOTE : dans la zone Page de titre de la boîte de dialogue Configuration de l'impression, vous pouvez indiquer le nom du projet et du concepteur. Toutes les autres données sont générées automatiquement.

Sommaire

La page Sommaire est réalisée automatiquement en fonction des rubriques sélectionnées.

Lorsqu’une rubrique est sélectionnée pour la documentation, son nombre de pages apparaît dans le sommaire. Si elle contient de la documentation mais n'est pas sélectionnée, la mention Pas de tâche d'impression apparaît en lieu et place du nombre de pages.

Le nombre total de pages est affiché à la fin du sommaire.

Informations générales

Cette rubrique concerne l'impression du contenu utilisateur saisi dans l'onglet Documentation > Informations générales du navigateur du projet.

Ces informations peuvent être des commentaires sur le projet, des liens hypertexte et/ou des bitmaps.

Configuration

Cette rubrique concerne l'impression de la configuration matérielle.

Contenu de la rubrique :

  • Topologie du bus

  • Paramètres du bus (sauf pour le bus X)

  • Configuration de l'automate et du rack

  • Paramétrage des modules d'entrées/sorties et des modules de communication

Types données dérivés

Cette rubrique concerne l'impression des types de données dérivés (DDT) du projet.

Contenu de la rubrique :

  • Nom de la structure de données et de ses éléments

  • Types de structure de données (par ex. structure, table) et types de données des éléments

  • Commentaires sur la structure de données

Type FB dérivés

Cette rubrique concerne l'impression des types FB dérivés (DFB) utilisés dans le projet.

Chaque DFB a une structure qui contient la section du DFB.

Contenu de la rubrique :

  • Rubrique Types FB dérivés

    • Table de tous les DFB utilisés dans le projet et de leurs propriétés (nom, version, date de création/modification)

  • Rubrique Nom DFB

    • Nom du type

    • Version

    • Brève description du mode de fonctionnement du DFB (si disponible)

    • Propriétés des entrées, sorties, entrées/sorties et variables publiques (nom, type de données, valeur initiale et commentaire)

  • Rubrique Sections

    • Nom de la section et du DFB

    • Commentaire sur la section

    • Type de protection

    • Module fonctionnel affecté

    • Nom de la condition pour l'appel conditionnel

    • Code de la section (sauf pour les DFB de diagnostic fournis par Schneider)

      Vous trouverez des détails sur la documentation de section dans la rubrique Programmes .

Types EFB

Cette rubrique concerne l'impression des types de bloc fonction élémentaire (EFB) utilisés dans le projet.

Contenu de la rubrique :

  • Table de tous les EFB utilisés dans le projet et de leurs propriétés (nom, version, date de création/modification)

  • Pour chaque type d'EFB :

    • Nom du type

    • Version

    • Brève description du mode de fonctionnement de l'EFB

    • Propriétés des entrées, sorties, entrées/sorties et variables publiques (nom, type de données, valeur initiale et commentaire)

Types FB

Cette rubrique concerne l'impression des types de bloc fonction (FB) utilisés dans le projet.

Contenu de la rubrique :

  • Table de tous les FB utilisés dans le projet et de leurs propriétés (nom, version, date de création/modification)

  • Pour chaque type de FB

    • Nom du type

    • Propriétés des entrées, sorties, entrées/sorties et variables publiques (nom, type de données, valeur initiale et commentaire)

Variables et instances FB

Cette rubrique concerne l'impression des objets suivants sous forme de tableau :

  • Types de données élémentaires (EDT)

  • Types de données dérivés (DDT)

  • Types de données dérivés d'E/S (IODDT)

  • Instances de fonctions élémentaires

  • Instances de blocs fonction élémentaires

  • Instances de blocs fonction dérivés

Contenu de la rubrique :

  • Nom symbolique (nom de variable ou nom d'instance de FB)

  • Constante (uniquement pour les variables)

  • Adresse (uniquement pour les variables)

  • Valeur initiale

  • Nombre de connexions

  • Fichier global (uniquement pour les types de données élémentaires et les instances de FB)

  • Attributs, par exemple, alias de, diagnostic, etc. (uniquement si définis)

NOTE : Dans la zone Variables et instances FB de la boîte de dialogue Configuration de l'impression, vous pouvez définir les attributs imprimés pour les variables et les instances de FB.

Structure du projet

Cette rubrique concerne l'impression de la structure du projet.

Contenu de la rubrique :

  • Liste des Program Units et/ou sections de programme :

    • Conditions de publication

    • Commentaires

    • Module

    • Type de langage

  • Arbre d’appel des macro-étapes et des sous-programmes

Selon la vue sélectionnée, la documentation s'affiche en mode Vue structurelle ou Vue fonctionnelle . En mode Vue fonctionnelle , la documentation des sections est triée selon le module fonctionnel affecté. La documentation des sections pour laquelle aucun module fonctionnel n'est affecté s'affiche dans son propre tableau.

Projet fonctionnel

Cette rubrique n'est disponible qu'en mode Vue fonctionnelle et sert à imprimer les sections affectées à un module fonctionnel.

Les sections non affectées à la documentation ne sont pas documentées dans la rubrique Programmes .

Communication

Cette rubrique concerne l'impression des paramètres de communication des réseaux.

Programmes

Cette rubrique concerne l'impression des éléments du programme.

Contenu de la rubrique :

  • Tâche MAST

    • Propriétés (par ex., configuration, durée de la tâche configurée, délai de chien de garde) de la tâche MAST.

    • Program Units de la tâche MAST (Interface & Variables , sections)

    • Sections de la tâche MAST

    • Section de sous-programmes de la tâche MAST

  • Tâche FAST

    • Propriétés (par ex., configuration, durée de la tâche configurée, délai de chien de garde) de la tâche FAST.

    • Program Units de la tâche FAST (Interface & Variables , sections)

    • Sections de la tâche FAST

    • Section de sous-programmes de la tâche FAST

  • Tâches AUX0 et AUX1, si disponibles

  • Evénements

    • Sections des tâches Evénements TIMER

    • Sections des tâches d'événement d'E/S

Le contenu de la documentation des sections dépend de leur langage de programmation.

Toutes les sections :

  • Nom des sections et des tâches affectées

  • Commentaire sur la section

  • Type de protection

  • Module fonctionnel affecté

  • Nom de la condition pour l'appel conditionnel

  • Code de section

Sections FBD :

  • Tables de composants avec l'attribut Exécuter après.

    Les blocs qui ont une référence Exécuter après à un autre module apparaissent dans une table qui indique le nom des instances et la position des modules référencés et référenceurs.

Sections LD :

  • Table des noms d'objet qui ne sont pas entièrement affichés.

    En raison de la largeur fixe des colonnes, il peut arriver que des noms de variable ou des types de module ne soient pas entièrement affichés. Ces noms incomplets figurent dans une table qui indique leur nom complet et leur(s) position(s).

  • La case à cocher Mode d'affichage mixte de la boîte de dialogue Configuration de l'impression vous permet de définir si la documentation dans la section LD doit être affichée en Mode saisie ou en Mode d'affichage mixte.

Sections SFC :

  • Tables des propriétés d'étape/action :

    • Nom d’étape

    • Position de l'objet d'étape

    • Temps de contrôle minimum et maximum

    • Temps de retard

    • Commentaire sur l'étape

    • Identificateur de la ou des actions

    • Libellé/variable de temps des identificateurs (si nécessaire)

    • Nom de l'action

  • Table des propriétés de transition :

    • Nom de la transition

    • Type de condition de la transition

    • Position de l'objet de transition

    • Commentaire

  • Table des propriétés de saut :

    • Nom de l'étape cible

    • Position de l'objet saut

    • Commentaire

Tables d'animation

Cette rubrique concerne l'impression des tables d'animation.

Contenu de la rubrique :

  • Nom de la table d’animation

  • Commentaire

  • Module fonctionnel

  • Nom de l'objet (par exemple, nom de variable, nom d'instance d'EFB/DFB/DDT, adresse)

  • Type

  • Commentaire

Ecran d'exploitation

Cette rubrique concerne l'impression des écrans d'exploitation.

Elle permet d’imprimer les propriétés des écrans d’exploitation, leurs représentations graphiques et les listes de messages associés à chaque écran.

Contenu de la rubrique :

  • Listes des messages

  • Ecran d'exploitation

    • Propriétés

    • Représentation graphique

    • Liste des variables animées

NOTE : dans la zone Ecrans d'exploitation de la boîte de dialogue Configuration de l'impression, vous pouvez définir l'étendue et l'affichage, ainsi que les variables et les instances de FB.

Références croisées

Cette rubrique concerne l'impression des références croisées de l'application et des DFB utilisés.

Chaque référence croisée peut contenir les tables suivantes :

  • Adresses

  • Variables et instances FB

  • Objets FB

  • Sous-programmes

Chaque table comprend les données suivantes :

  • Nom de l'objet

  • Emplacement de la référence (par ex., nom de la section, nom du module)

  • Position utilisée (par ex. ligne et colonne de la section, type de module)

Objets utilisateur

Cette rubrique concerne l'impression des propriétés des liens hypertexte et des répertoires utilisateur.

Contenu de la rubrique Liens hypertexte :

  • Nœuds contenant des liens hypertexte (par ex., station\tables animation)

  • Commentaire

  • Chemin cible

Contenu de la rubrique Répertoire utilisateur :

  • Nœuds contenant des liens hypertexte (par ex., station\tables animation)

  • Commentaire

Bas de page

Cette rubrique concerne l'impression du bas de page.

Contenu de la rubrique :

  • Bitmap (logo)

  • Auteur

  • Service

  • Automate cible

  • Titre de page

  • Deux champs libres

  • Date d’impression

  • Nombre de pages

NOTE : l'automate cible, le titre de page, la date d'impression et le nombre de pages sont générés automatiquement. Dans la zone Bas de page de la boîte de dialogue Configuration de l'impression, vous pouvez définir d'autres attributs.