Extraction documentation
Cette fonction permet d'extraire l'ensemble des paragraphes d'une documentation sous la forme d'un fichier XML.
3 choix d'extraction sont possibles :
- Extraction par langue : Ce choix permet d’extraire l’ensemble d’une ou de plusieurs langues. Les en-tête et le contenu des docs sont dans la langue cible d’extraction. Une option pour ce choix permet la sélection les documentations «Validées», «non validées», «Toutes». Ce choix permet d’extraire toute une langue pour comptage de mots par exemple.
- Extraction pour traduction : Ce choix se substitue complètement au plan de travail. Il permet de générer des documentation pour traduction via Trados ou autre. Les en-tête sont dans la langue cible d’extraction et le contenu des documentations sont 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 valides à traduire d’une langue donnée.
- Extraction pour (re)traduction : Ce choix permet d’extraire une documentation déjà traduite donc qui n’apparaît pas dans le plan de travail mais qui nécessite une (re)traduction car des modifications de contenues ont été faite sans modifier la date de validité. Les en-tête sont dans la langue cible d’extraction et le contenu des documentations sont 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 validité. Cette option permet ainsi de retraduire des documentations via Trados.
Pour extraire afin d'effectuer la traduction avec des progiciels à mêmes 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éé, 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
Codes activité
Les codes activités suivants (classés par type) peuvent avoir une influence sur le comportement de la fonction :
DIS :
Distributeurs
Paramètres généraux
Les paramètres généraux suivants ont une influence sur le comportement de la fonction :
Superviseur
DIRDOC (défini au niveau Utilisateur) : Répertoire doc finale
LANTRA (défini au niveau Utilisateur) : Langue destination traduction
Gestion de l'écran
Ecran de saisie
Présentation
On saisit dans l'écran les critères de sélection pour définir ce qui doit être extrait, en sachant que peut être extraite :
- la documentation sur fonctions ou objet fonctionnelle 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 extraits sous forme de fichiers séparés).
- tout fichier lié qui est alors extrait tel quel.
Fermer
Champs
Les champs suivants sont présents dans cet onglet :
Bloc numéro 1
|
Détermination du choix d'extraction XML :
|
|
Indique le répertoire à partir duquel sera fait l'export de documentations, en sachant que les aides sur champs seront extraits dans le sous-répertoire FLD, et les fichiers liés dans le sous-répertoire FILE. |
|
Indique si le sous-répertoire par type de documentation sera utilisé pour être concaténé avec le répertoire principal à partir duquel sera fait l'export de documentations. Les aides sur champs liées seront extraits dans le sous répertoire par type puis FLD. Les fiés liés seront extraits dans le sous répertoire par type puis FILE. |
|
|
Langue
|
Si cette case est cochée, toutes les langues sont prises en compte pour l'opération. |
|
Définit le code langue à traiter lorsqu'il est unique. |
|
|
|
|
Sélections
|
Si cette case est cochée, tous les types sont pris en compte pour l'opération. Sinon, il faudra saisir le type qui sera pris en compte. |
|
Définit le type de documentation à traiter (lorsqu'il est unique). |
|
|
|
Si cette case est cochée, tous les codes sont pris en compte pour l'opération (sinon, on ne prendra en compte que les codes correspondant aux bornes saisies). |
|
Permet de donner une borne de début sur le critère pour déterminer les données prises en compte par l'opération. |
|
Permet de donner une borne de fin sur le critère pour déterminer les données prises en compte par l'opération. |
|
|
|
|
|
|
|
|
|
|
|
|
Options
|
Si cette case est cochée, on traite également les fichiers liés aux documentations. Ces fichiers sont en général des images. |
|
Si cette case est cochée, on traite spécifiquement les aides sur champs relatives aux documentations sur fonction ou objet traitées par ailleurs. Pour savoir quelles sont les aides sur champ à traiter, on explore les écrans associés aux paragraphes de documentation correspondants. |
|
Si cette case est cochée, on traite également la documentation sur champs. |
|
Permet de borner le traitement de l'aide sur champ entre deux mots-clés. |
|
|
|
|
Fermer
Tables mises en oeuvre
Les tables suivantes sont mises en oeuvre par la fonction :
| Table |
Intitulé Table |
|---|---|
|
ADOCBLB [ADB] |
Documentation (Fichiers liés) |
|
ADOCCLB [ADH] |
Documentation (Textes) |
|
ADOCFLD [ADZ] |
|
|
ADOCUMENT [ADO] |
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).
- A l'intérieur de la balise PAR, une balise TIT pour donner le titre du paragraphe (s'il y en a un).
- A 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".