Import documentation
Cette fonction permet d'intégrer l'ensemble des paragraphes d'une documentation précédemment extraits sous la forme d'un fichier XML. L'objectif premier est de permettre la réintégration après traduction d'une telle documentation avec des progiciels à mêmes de traduire des fichiers XML.
L'intégration se fait par défaut depuis un répertoire xml créé, s'il n'existe pas, dans le répertoire de documentation défini par le paramètre DIRDOC.
Les fichiers auront été préalablement extrait par la fonction plan de travail documentation ou d'extraction de documentation.
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 le répertoire où se trouvent les documentations à intégrer, ainsi que quelques options. A partir de là, les fichiers présents dans le répertoire sont lus et intégrés.
Fermer
Champs
Les champs suivants sont présents dans cet onglet :
Bloc numéro 1
|
Indique le répertoire à partir duquel sera fait l'import de documentations, en sachant que les aides sur champs seront repris dans le sous-répertoire FLD correspondant, et les fichiers liés dans le sous-répertoire FILE, pour peu qu'ils contiennent le code langue choisi dans leur nom. |
|
Si la langue est renseignée, un contrôle sera fait pour vérifier que la langue définie dans les fichiers trouvés est bien la même. |
|
Si cette case est cochée, on traite également la documentation sur champs. |
|
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. |
Bloc numéro 2
|
Autorise l'import de nouveaux paragraphes |
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".