Skip to main content
Cours de localisation de logiciels 5

2. Eléments

7.2.2 Documentation - Formats de fichiers d'aide

Formats de fichiers d'aide

Pour l'aide en ligne, le secteur des logiciels utilise différents types de formats de fichiers. Les formats les plus répandus sont :

Depuis que Microsoft a commercialisé Windows 3.1, les fichiers d'aide tels que WinHelp 3 (pour les systèmes d'exploitation Windows 3.1 et Windows NT 3.x) et WinHelp 4 (pour les systèmes d'exploitation Windows 9x etWindows NT 4) se sont développés.

Les fichiers d'aide Windows (HLP) se composent généralement de différents fichiers, par exemple : des fichiers HPJCNTRTF et BMP/SHG (ou d'autres types de fichiers graphiques). Pour créer un fichier HLP, un compilateur (comme le compilateur d'aide de Microsoft) utilise un fichier HPJ pour compiler un ou plusieurs fichiers RTF et des fichiers d'images (BMP ou SHG) et générer un fichier HLP.

  • HPJ (Help Project) : ce format de fichiers textes contient des informations essentielles pour le compilateur d'aide de Microsoft qui permet de rassembler tous les fichiers d'aide dans un seul et unique fichier. Les fichiers HPJ peuvent être traités avec des éditeurs de texte. Toutefois, il est préférable d'utiliser des outils de localisation pour adapter les fichiers d'aide traduits. Les fichiers HPJ se composent des sections suivantes :
    • Options : pour la compression, le protocole d'erreurs, la langue, le copyright, la table des matières, l'index, la table des illustrations, etc.
    • Fichiers : une liste de tous les fichiers devant être intégrés à l'aide en ligne.
    • Plan : dans cette section, les sujets d'aide sont associés à un identificateur de contexte pour une aide sensible au contexte
    • Fenêtres : cette partie contient des informations sur la taille, la couleur, le titre et la position des fenêtres dans lesquelles l'aide s'affiche
    • Config : cette section contient des macros permettant par exemple de créer des boutons supplémentaires

Pour la localisation des fichiers d'aide Windows, en particulier des fichiers HPJ, il est important de savoir que l'on traduit en général : le titre de l'aide, les informations sur le copyright, le titre des fenêtres et la désignation des boutons contenue dans les macros.

  • CNT (Contents file) : ce type de format de fichiers est utilisé par le compilateur d'aide de Microsoft pour créer une table des matières qui sera utilisée par les fichiers d'aide. Les fichiers CNT sont des fichiers textes qui contiennent les titres de chaque sujet d'aide. A chaque fois que les utilisateurs utilisent l'aide, la table des matières est générée à partir d'un fichier CNT. Pour la localisation des fichiers CNT, les traducteurs/localisateurs doivent tenir compte : a) du titre de l'aide et de la structure de la table des matières ; b) du texte se trouvant avant le signe égal (par ex, "2 Creating a new document=WRIPAD_CREATE_DOCUMENT"). Dans un fichier .cnt, chaque ligne commence par un numéro de niveau, lequel est suivi du signe égal qui sépare le texte à traduire (à la gauche du signe égal) des codes qui correspondent aux identificateurs des sujets d'aide (à la droite du signe égal).
  • RTF (Rich Text Format) : ce fichier contient le texte de l'aide. Il peut être traité à l'aide d'un simple éditeur de traitement de texte ou d'un système de mémoire de traduction. Dans un fichier RTF on trouve des éléments à traduire tels que : le corps de texte (texte masqué pour les identificateurs de contexte, codes correspondant aux symboles et graphiques, texte souligné un fois pour les pop-up et souligné deux fois pour les liens), les notes de bas de page, certaines commençant par "$" (pour les titres et les sujets d'aide) et d'autres par "K" (pour l'index et l'index des mots-clés).
  • Fichiers BMP/SHG : la plupart des graphiques dans les fichiers d'aides sont des fichiers bitmap ayant l'extension BMP ou SHG. Les graphiques sont insérés lors de la compilation des fichiers.
  • Le fichier HLP résultant de la compilation constitue le fichier d'aide final.

(Adapté de Esselink, 2000 et Whale 2000b)

La principale différence entre les fichiers d'aide Microsoft WinHelp et les fichiers HTML est que les fichiers sources utilisés pour créer les fichiers d'aide en ligne ne sont pas les mêmes. Les fichiers WinHelp sont créés à partir de fichiers Rich Text Format (*.rtf) et les fichiers d'aide HTML à partir de fichiers HTML et de fichiers graphiques tels que *.jpg et/ou *.gif.

Les fichiers d'aide compilés basés sur HTML (CHM) se composent généralement de plusieurs fichiers différents, comme : les fichiers HTMLHHCHHK et les fichiers d'images (GIF ou JPG). Le compilateur d'aide (tel que le compilateur de Microsoft HTML Help Workshop) utilise un fichier HHP contenant tous les paramètres de l'aide pour compiler un ou plusieurs fichiers HTML et des fichiers d'images et générer un fichier CHM.

  • Fichiers HTML : les fichiers HTML utilisés dans les projets d'aide sont traités comme les fichiers HTML à l'aide d'un système de MT ou d'un éditeur HTML. Puisque qu'on trouve dans les fichiers HTML des balises contenant du texte brut et des informations sur la mise en page, les balises doivent être protégées et le texte doit être traduit.
  • Fichiers HHP : on trouve dans ces fichiers contenant exclusivement du texte tous les paramètres utilisés pour compiler le fichier d'aide HTML. Ils peuvent être traités à l'aide d'un éditeur de texte. Ces fichiers contiennent des éléments à traduire tels que : le titre du fichier d'aide HTML qui s'affiche dans la barre de titre, le titre des fenêtres, le nom des boutons, le texte des fenêtres pop-up, etc.
  • Fichiers HHC : ces fichiers (ou fichiers de plan de site) contiennent la table des matières des fichiers d'aide HTML. Pour localiser ces fichiers, on peut utiliser un éditeur de texte ou un éditeur HTML.
  • Fichiers HHK : ces fichiers remplacent les mots-clés et les notes de bas de page des fichiers RTF utilisés dans les projets WinHelp. Ils contiennent les mots-clés de la liste de recherche inclue dans les fichiers d'aide HTML. Les fichiers HHK peuvent être traduits dans un éditeur de texte ou dans un système de mémoire de traduction.

Les formats HTML et HTML Help sont en passe de devenir les formats de fichiers les plus utilisés pour les projets d'aide.

(Adapté de Esselink, 2000)

Les fichiers Lisez-moi sont en général des fichiers textes (*.txt) ne contenant pas d'informations sur la mise en page. Ils se trouvent généralement sur le disque d'installation du logiciel. Ces fichiers contiennent des informations qui n'étaient probablement pas disponibles au moment où les manuels ont été créés ou imprimés (modifications, ajout d'informations, etc.). Les fichiers Lisez-moi peuvent être traités avec un éditeur de texte comme Notepad ou avec Microsoft Word dans le cas des fichiers *.doc.