Cette fonction permet de mettre à jour les documentations utilisateurs stockées dans la base de données du dossier courant, sous la forme de paragraphes normalisés, auxquels peuvent être adjoints des fichiers complémentaires tels que des images, des schémas.

Chaque documentation est définie par un type et un code qui la rattache au progiciel documenté. Selon le type de documentation, le code diffère. Une annexe détaille les types de documentations possibles et la façon dont le code est défini.

Pré-requis

SEEREFERTTO Reportez-vous à la documentation de Mise en oeuvre

Gestion de l'écran

Chaque fiche correspond à un paragraphe de la documentation. La clé d'une fiche est constituée du code langue, du type de documentation et du code, ainsi que d'un niveau et d'un sous-niveau qui permettent d'organiser des tables des matière intermédiaires dans la documentation.

La liste de gauche contient 4 volets qui sont les suivants :

  • La liste normale et les derniers lus sont les listes habituelles
  • La liste hiérarchisée permet de visualiser les documentations liées au type de documentation courante et à la langue courante. Cette hiérarchie fait apparaître quand on la déplie pour une documentation donnée, d'abord les niveaux de documentation (qui correspondent à la table des matières située en tête de document), puis les sous-niveaux attachés à chaque documentation (sous-tables des matières).
  • La liste nommée Documentation courante permet de faire apparaître l'ensemble des paragraphes de la documentation correspondant à la fiche courante.

Ecran de saisie

Chaque paragraphe de documentation est saisi dans l'unique onglet de la fonction. On ny trouve à la fois des éléments de clé (langue, type, code, et imbrication des paragraphe), des informations définissant le style et la façon dont le paragraphe est généré, ainsi que le texte du paragraphe, s'il est nécessaire.

La saisie d'un paragraphe se fait via un éditeur HTML, dont l'utilisation est détaillée dans une documentation annexe.

Boutons spécifiques

Génération

Donne accès à la génération de la documention.

La génération permet de réaliser 2 fonctions :

  • La génération ADOCUMENT qui a pour but de créer ou mettre à jour les paragraphes de la documentation courante en fonction de la description des différents objets X3 concernés.
  • La génération finale HTML qui a pour but de créer un fichier d'extension htm, dans le répertoire défini par le paramètre DIRDOC.

SEEREFERTTO Pour plus d'information, se référer à la documentation sur l'action de génération.