Plan de travail documentation

Boutons spécifiques

Actualiser avancement

Ce bouton, également accessible par le raccourci  , permet de rafraîchir l'affichage du premier onglet.

Détail par module

Présente dans un nouveau tableau ce qui est traduit et ce qu'il reste à traduire pour les documentations par module et par type de documentation.

Recherche des documentations

Ce bouton permet de charger le tableau de l'onglet Documentations. Il lance la recherche des documentations qui sont à traduire selon les critères saisis.

Recherche des aides sur champs

Ce bouton permet de charger le tableau de l'onglet Aides sur champs. Il lance la recherche des aides sur champs qui sont à traduire selon les critères saisis.

Traiter

Lance le traitement pour toutes les lignes sélectionnées sur les onglets Documentations et Aides sur champs. Ceci permet d'obtenir les fichiers XML qui seront utilisés pour effectuer la traduction. Il faudra indiquer un répertoire dans lequel seront extrait les fichiers XML. Par défaut, ce répertoire correspond au sous-répertoire xml du répertoire sélectionné pour stocker la documentation extraite au format HTML. Les fichiers des chapitres de documentations sont extraits directement dans le répertoire indiqué et les fichiers liés à une documentation sont situés dans le sous-répertoire FILE du répertoire xml d'extraction. Les fichiers de documentation sur champ sont situés dans le sous-répertoire FLD du répertoire xml d'extraction. Pour plus d'explications sur l'action Traiter, voir l'annexe Processus de traduction d'une documentation.

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

Reportez-vous à la documentation de Mise en oeuvre

Annexe : Processus de traduction d'une documentation

Préliminaires

A ce jour, seule la documentation sur fonction dispose d’une case à cocher Validée et d’une date de validation. On part du principe qu’une documentation ne doit être Validée que si elle est considérée comme terminée, et si les aides sur champs qu’elle intègre le sont aussi. Seules les documentations validées entièrement validées sont proposées en traduction.

Dans un flux continu de traduction, des modifications peuvent intervenir à un moment donné, et une re-traduction peut se révéler nécessaire. Dans ce cas, la documentation doit être revalidée à une nouvelle date et elle sera de nouveau proposée en traduction.

Dans la mesure où une documentation fonctionnelle intègre également des documentations d’aide sur champ, il faut traduire simultanément les documentations sur champs intégrées dans cette documentation fonctionnelle.

Action Traiter

Avant de pouvoir extraire une documentation ou une aide sur champ en vue d'une traduction, il est nécessaire que la structure de documentation existe dans la langue de traduction et correspondent au moins à celle de la documentation de référence.

L’action Traiter permet d’effectuer toutes les étapes nécessaires jusqu’à l’extraction.

•  Génération : cette opération va créer les paragraphes de la documentation pour la langue de traduction, en reprenant les titres des onglets, l’intitulé de la fonction, et en laissant les paragraphes explicatifs (à traduire) vides. Il est important que tous les textes de la fonction aient été au préalable traduits (concerne ATEXTE et APLSTD), sinon on ne récupèrera pas toute la terminologie traduite.
   
• Copie : La documentation dans la langue de référence, qui a été générée par le même processus que celui décrit ci-dessus, a, au cours de sa rédaction, subi des modifications. Tout d’abord, on a saisi des textes dans les paragraphes (mais ceci fait justement partie des éléments à traduire) ; mais on peut aussi avoir modifié la structure des paragraphes. Pour reporter ces modifications, il est nécessaire de lancer une fonction de copie de la documentation. Il est important de noter que les textes des paragraphes ne sont pas copiés ; seuls les pièces jointes, les paragraphes supplémentaires (sans leur texte), les modifications de paragraphes en INC, les titres des nouveaux paragraphes (MIS), leur affectation du code activité FAL sont transférés.

 Les aides sur champs sont créés et leurs caractéristiques sont copiés sur cette étape.

•  Extraction : Chaque documentation, aide sur champs est extraite dans un fichier XML qui pourra être traduit par un progiciel à même de traduire des fichiers XML. Il faudra indiquer un répertoire dans lequel seront extrait les fichiers XML. Par défaut, ce répertoire correspond au sous-répertoire xml du répertoire sélectionné pour stocker la documentation extraite au format HTML. Les fichiers des chapitres de documentations sont extraits directement dans le répertoire indiqué et les fichiers liés à une documentation sont situés dans le sous-répertoire FILE du répertoire xml d'extraction. Les fichiers de documentation sur champ sont situés dans le sous-répertoire FLD du répertoire xml d'extraction. 

 

Intégration des fichiers traduits

Après traduction des fichiers via un outil externe, c’est la fonction d’intégration de documentation qui permettra d’importer les fichiers et d’affecter les indicateurs et dates de validités qui permettront de constater la validité de la traduction.

Remarque importante

Toute documentation traduite par ce processus ne doit pas être revalidée à la main avec une date différente.

C'est à dire même si la documentation est retouchée, il ne faut pas lui affecter une date de validation différente de celle affectée par le processus export/import.

 Si un paragraphe est ajouté (par exemple: un paragraphe MIS propre à la langue de traduction) dans la documentation traduite, il faut revalider cette documentation traduite avec la date affectée par le processus de traduction.

Si une date de validité autre était affectée, le contrôle de validité de traduction par rapport à la langue de référence déterminerait toujours la traduction comme non valide et proposerait toujours la documentation pour traduction.

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.