Cette fonction permet d'extraire l'ensemble des paragraphes d'une documentation sous la forme d'un fichier XML.

Trois choix d'extraction sont possibles :

  • Extraction pour (re)traduction : ce choix permet d’extraire une documentation déjà traduite, c'est-à-dire qui n’apparaît pas dans le plan de travail, mais qui nécessite une (re)traduction car des modifications de contenus ont été faite sans modifier la date de validation. Les en-têtes sont dans la langue cible d’extraction et le contenu des documentations est dans la langue de référence. Les contrôles de cohérence entre Langue Cible/Référence sont faits mais pas les contrôles de validation. Cette option permet ainsi de retraduire des documentations via le logiciel de traduction ;
  • Extraction pour traduction : ce choix se substitue complètement au plan de travail. Il permet de générer des documentations pour traduction via n'importe quel logiciel de traduction. Les en-têtes sont dans la langue cible d’extraction et le contenu des documentations est dans la langue de référence. Les contrôles de cohérence entre Langue Cible-Référence sont faits ainsi que les contrôles de validité. Cette option permet d’extraire par exemple l’ensemble des documentations validées à traduire d’une langue donnée ;
  • Extraction par langue : ce choix permet d’extraire l’ensemble d’une ou de plusieurs langues. Les en-têtes et le contenu des documentations sont dans la langue cible d’extraction. Une option pour ce choix permet la sélection des documentations "Validées", "Non validées", "Toutes". Ce choix permet d’extraire toute une langue pour comptage de mots par exemple.

Pour extraire, afin d'effectuer la traduction avec des progiciels à même de traduire des fichiers XML, il faut utiliser la fonction plan de travail documentation.

L'extraction se fait par défaut dans un répertoire xml créé, et s'il n'existe pas, dans le répertoire de documentation défini par le paramètre DIRDOC.

Une fonction d'intégration de documentation permet de réaliser l'opération inverse.

Pré-requis

SEEREFERTTO Reportez-vous à la documentation de Mise en oeuvre

Gestion de l'écran

Ecran de saisie

Les critères de sélection sont saisis dans l'écran afin de définir ce qui doit être extrait, en sachant que peut être extraite :

  • la documentation sur fonction ou objet fonctionnel ou sur objet (définie par son type),
  • la documentation sur champ (qui peut être extraite séparément, ou de façon liée à la documentation fonctionnelle ; les aides sur champ incluses dans l'aide fonctionnelle étant alors extraites sous forme de fichiers séparés),
  • tout fichier lié qui est alors extrait tel quel.

Messages d'erreur

Il n'y a pas de message d'erreur autre que les messages d'erreur génériques.

Tables mises en oeuvre

SEEREFERTTO Reportez-vous à la documentation de Mise en oeuvre

Annexe : format des fichiers créés

Le format du fichier XML de documentation sur fonction ou objet, tel qu'on le retrouve dans le répertoire xml, est le suivant :

  • un en-tête normalisé xml,
  • une balise DOC avec les attributs TYPE, NAME (définissant le type et le code de la documentation),
  • à l'intérieur de la balise DOC, pour chaque paragraphe, une balise PAR avec les attributs LAN, LEV, SUBLEV, PAR, MSK, STY, VLDDAT, VLDFLG, ACT, et MOD (définissant dans l'ordre la langue, le niveau, le sous-niveau, le code du paragraphe, l'écran, le style, la date de validité, l'indicateur de validité, le code activité et le module),
  • à l'intérieur de la balise PAR, une balise TIT pour donner le titre du paragraphe (s'il y en a un),
  • à l'intérieur de la balise PAR, une balise HTML contenant le texte du paragraphe en XHTML.

Les fichiers de documentation sur champ sont situés dans le sous-répertoire FLD du répertoire xml d'extraction. Le format est le suivant :

  • un en-tête normalisé xml,
  • une balise FLD avec les attributs NAME, LAN, MOD, GEN, LNKHLP, LNKORD, CREDAT, UPDDAT (définissant le nom, la langue, le module, l'attribut générique de la documentation, l'aide liée, le lien, la date de création et la date de modification),
  • à l'intérieur de la balise FLD, une balise HTML contenant le texte du paragraphe en XHTML.

Les fichiers liés à une documentation sont situés dans le sous-répertoire FILE du répertoire xml d'extraction. Le nom du fichier est constitué de la façon suivante :

COD_LAN_TYP_LEV_SUBLEV_LIG_NOMFICHIER_LGCLE.EXT, où :

  • COD_LAN_TYP_LEV_SUBLEV_LIG est constitué à partir de la clé du fichier lié dans la table ADOCBLB (ceci pour garantir l'unicité du nom,
  • LGCLE contient la longueur de la clé précédente afin de pouvoir extraire correctement le code de la documentation,
  • NOMFICHIER et EXT correspondent au nom du fichier (nom et extension) s'il est indiqué dans ADOCBLB ou à un nom composé avec les caractères IMG, suivis du numéro de ligne sur 3 caractères (préfixé par des zéros si nécessaires), et suivi de l'extension .jpg.