Plan de travail documentation
Cette fonction permet de visualiser l'avancement d'une traduction. Les paramètres LANTRA et LANREF permettent de pré-renseigner la langue de traduction et la langue de référence.
Elle permet aussi d'extraire des documentations ou des aides sur champs afin d'effectuer la traduction avec des progiciels à mêmes de traduire des fichiers XML. 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.
Pré-requis
Reportez-vous à la documentation de Mise en oeuvre
Gestion de l'écran
Cette fonction permet de visualiser l'avancement d'une traduction dans une langue de traduction par comparaison avec une langue de référence.
Elle permet aussi d'extraire au format XML, les documentations et aides sur champs qui sont à traduire.
La fonction est constituée de trois onglets :
- le premier présente l'avancement de la traduction, il est chargé en utilisant le bouton
- le deuxième permet de faire une recherche des documentations dont la traduction n'est pas à jour en utilisant le bouton . La recherche peut être restreinte par type, code ou plage de codes. Ensuite, il est possible de traiter les documentations unitairement par clic droit ou pour plusieurs.
- le troisième permet de faire une recherche des aides sur champs dont la traduction n'est pas à jour en renseignant les critères et en utilisant le bouton . La recherche peut être restreinte par code ou plage de codes. Ensuite, il est possible de traiter les aides sur champs unitairement par clic droit ou pour plusieurs.
En-tête
Présentation
Permet d'indiquer la langue cible de traduction et la langue de référence.
Champs
Les champs suivants sont présents dans cet onglet :
| Définit la langue de traduction |
|
|
| Définit la langue d'origine du texte à traduire. |
Onglet Avancement
Présente ce qui est traduit et ce qu'il reste à traduire pour les documentations et les aides sur champs de façon globale et détaillée par type de documentation.
Il est à noter que seules les documentations entièrement validées dans la langue de référence sont potentiellement à traduire. La date de validité d'une documentation traduite doit être égale à celle de la langue de référence sinon elle est donc à traduire.
Pour les aides sur champs, la date de création de l'aide doit être égale à la date de dernière modification dans la langue de référence sinon l'aide est à traduire.
C'est le mécanisme d'extraction/import de documentation qui gère le passage de la langue de référence à la langue de traduction pour les dates indiquées précédemment.
Champs
Les champs suivants sont présents dans cet onglet :
Tableau Répartition
| Présente le nombre de documentations et d'aides sur champs traduites et qu'il reste à traduire. |
|
|
|
|
| Présente le nombre de documentations et d'aides sur champs traduites et qu'il reste à traduire. |
|
|
|
|
Récapitulatif
| Présente le nombre de documentations entièrement validées et le nombre total de documentations pour la langue de référence et la langue de traduction. |
|
|
|
|
|
|
| Présente le nombre total d'aides sur champs pour la langue de référence et la langue de traduction. |
|
|
|
|
|
|
Tableau Détail par type
| Le tableau présente par type de documentation :
|
|
|
|
|
|
|
|
|
|
|
Icône Actions
Documentations non validées
Présente la liste des documentations non validées
Documentations traduites
Onglet Documentations
Présentation
Après avoir rechercher les documentations à traduire voulues à l'aide des critères, il est possible de traiter :
- une seule documentation par clic droit,
- toutes ou une partie des documentations en sélectionnant les lignes voulues avant de déclencher l'action par le bouton de bas d'écran .
Pour plus d'explications sur l'action Traiter, voir l'annexe Processus de traduction d'une documentation.
Champs
Les champs suivants sont présents dans cet onglet :
Critères
| Permet d'indiquer comme critère de recherche un type de documentation ou tous. |
|
|
| Permet d'indiquer comme critère de recherche un module ou tous. |
|
|
|
|
|
|
|
|
|
| Permet d'indiquer comme critère de recherche une plage de code en utilisant les bornes de début et de fin ou tous les codes. |
|
|
|
|
Tableau Recherche
| Permet de définir si la ligne doit être traitée lorsque que le traitement est lancé par le bouton de bas d'écran. |
| Ce champ définit le type de la documentation. Chaque type est associé à un type d'éléments documentés (documentation fonctionnelle, décrivant une fiche du dictionnaire ou des valeurs de paramétrage, décrivant la structure du dictionnaire, diverses). Lorsqu'un type de documentation correspond à un code objet, une entrée Documentationest automatiquement créée dans la barre de menus de l'objet en question. On peut alors documenter les fiches saisies dans l'objet en question. C'est pourquoi l'aide fonctionnelle est codée AFC (code de l'objet Fonctions), l'aide sur paramètres généraux est codée ADP (code de l'objet Paramètres)... Les règles pour nommer les documentations sont définies dans une documentation annexe. |
| Ce champ définit le code de la documentation. Il correspond en principe au code de la fiche (fonction, paramètre...) que l'on documente. Les règles pour nommer les documentations sont définies dans une documentation annexe. |
| Ce champ est le titre du paragraphe. S'il est vide, un titre par défaut est attribué en fonction du type de paragraphe (aussi bien en création qu'en modification). Dans le cas des paragraphes divers ne figurant pas dans les tables des matières (de type MIN), le fait de renseigner le titre avec le seul caractère " ! "désactive l'insertion d'un titre. |
| Indique la date de validation ou de dernière modification retrouvée sur l'objet pour la langue de référence. |
| Indique la date de validation ou de dernière modification retrouvée sur l'objet pour la langue de traduction choisie. |
| Indique si l'objet existe déjà pour la langue de traduction choisie. |
|
|
|
|
|
|
Icône Actions
Oui à tout le reste
Lorsqu'on a un tableau de saisie de choix multiples avec un choix de réponse Oui / Nonsur chaque ligne, cette fonction permet de répondre Oui à toutes les lignes à partir de la ligne courante.
Non à tout le reste
Lorsqu'on a un tableau de saisie de choix multiples avec un choix de réponse Oui / Nonsur chaque ligne, cette fonction permet de répondre Non à toutes les lignes à partir de la ligne courante.
Traiter la documentation
Lance le traitement pour la ligne courante du tableau. Ceci permet d'obtenir le fichier XML qui sera utilisé 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.
Pour plus d'explications sur l'action Traiter, voir l'annexe Processus de traduction d'une documentation.
Onglet Aides sur champs
Présentation
Après avoir rechercher les aides sur champs à traduire voulues à l'aide des critères, il est possible de traiter :
- une seule aide par clic droit,
- toutes ou une partie des aides en sélectionnant les lignes voulues avant de déclencher l'action par le bouton de bas d'écran .
Pour plus d'explications sur l'action Traiter, voir l'annexe Processus de traduction d'une documentation.
Champs
Les champs suivants sont présents dans cet onglet :
Critères
| Permet d'indiquer comme critère de recherche un module ou tous. |
|
|
|
|
|
|
|
|
|
| Permet d'indiquer comme critère de recherche une plage de code en utilisant les bornes de début et de fin ou tous les codes. |
|
|
|
|
Tableau Recherche
| Permet de définir si la ligne doit être traitée lorsque que le traitement est lancé par le bouton de bas d'écran. |
| Indique le mot-clé donc la référence de l'aide sur champ |
| Indique la date de validation ou de dernière modification retrouvée sur l'objet pour la langue de référence. |
| Indique la date de validation ou de dernière modification retrouvée sur l'objet pour la langue de traduction choisie. |
| Indique si l'objet existe déjà pour la langue de traduction choisie. |
|
|
|
|
Icône Actions
Oui à tout le reste
Lorsqu'on a un tableau de saisie de choix multiples avec un choix de réponse Oui / Nonsur chaque ligne, cette fonction permet de répondre Oui à toutes les lignes à partir de la ligne courante.
Non à tout le reste
Lorsqu'on a un tableau de saisie de choix multiples avec un choix de réponse Oui / Nonsur chaque ligne, cette fonction permet de répondre Non à toutes les lignes à partir de la ligne courante.
Traiter l'aide sur champ
Lance le traitement pour la ligne courante du tableau. Ceci permet d'obtenir le fichier XML qui sera utilisé 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 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.
Boutons spécifiques
Ce bouton, également accessible par le raccourci , permet de rafraîchir l'affichage du premier onglet. |
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. |
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. |
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. |
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.