2. Komponenten
7.2.2 Dokumentation - Online-Hilfe-Dateiformate
Hilfe-Dateiformate
In der Softwareindustrie werden unterschiedliche Dateiformattypen zur Online-Hilfe verwendet. Ein paar der Geläufigsten sind:
Seit der Markteinführung von Windows 3.1 durch Microsoft wurden Hilfedateien wie WinHelp 3 (für Windows 3.1- und Windows NT 3.x-Betriebssysteme) und WinHelp 4 (für Windows 9x- und Windows NT 4-Betriebssysteme) entwickelt. Die Windows-Hilfedateien (HLP) setzen sich gewöhnlich aus mehreren unterschiedlichen Dateien zusammen, wie beispielsweise: HPJ, CNT, RTF und BMP/SHG (oder andere Grafikdateien). Zur Erstellung einer HLP-Datei wird von einem Compiler (Microsoft Help Compiler) eine HPJ-Datei herangezogen, um eine oder mehrere RTF-Dateien und Bilddateien (BMP oder SHG) zu kompilieren.
- HPJ (Hilfeprojekt): Dies ist ein Textdateiformat mit grundlegenen Informationen für den Microsoft-Hilfe-Compiler, der zur Zusammenfügung der einzelnen Hilfedateien verwendet wird. HPJ-Dateien können mit Text-Editoren bearbeitet werden. Es ist jedoch zu empfehlen, Lokalisierungstools zur Anpassung der übersetzten Hilfedateien zu verwenden. HPJ-Dateien bestehen aus den folgenden Teilen:
- Optionen: zum Zippen, Fehlerprotokoll, Sprache, Urheberrechte, Inhaltsverzeichnis, Index, Bildtabellen, usw.
- Dateien: eine Liste aller Dateien, die in die Hilfe eingefügt werden sollen
- Karte: In diesem Teil werden die Hilfethemen mit einer Kontext-ID für die Kontext-sensitive Hilfe versehen.
- Fenster: Dieser Teil enthält Informationen über Größe, Farbe, Namen und Position der Fenster, in denen Hilfe-Texte angezeigt werden.
- Config: Dieser Teil enthält Makros ? z.B. zur Erstellung zusätzlicher Schaltflächen
Bei der Lokalisierung von Windows-Hilfedateien und im Besonderen HPJ-Dateien ist es wichtig zu wissen, dass die zu übersetzenden Elemente im Allgemeinen folgende sind: der Hilfename, die Informationen zu Urheberrechten, die Fensternamen und die in Makros enthaltenen Schaltflächenkennzeichnungen
- CNT (Inhaltsdateien): Diese Art Dateiformat benutzt der Microsoft-Hilfe-Compiler zur Erstellung des Inhaltsverzeichnisses, das für die Hilfedateien verwendet wird. Es handelt sich dabei um ein Textdateiformat mit den Namen aller einzelnen Hilfethemen. Bei jedem Zugriff auf die Hilfe wird das Inhaltsverzeichnis basierend auf der CNT-Datei erstellt. Bei der Lokalisierung von CNT-Dateien sollten Übersetzer/Lokalisierer folgendes beachten: a) Hilfenamen und Struktur des Inhaltsverzeichnisses und b) Text vor dem Gleichheitszeichen (z.B. "2 Creating a new document=WRIPAD_CREATE_DOCUMENT"). Bei einer .cnt-Datei beginnt jede Zeile mit einer Levelnummer gefolgt von einem Gleichheitszeichen, welches den zu übersetzenden Text (links vom Gleichheitszeichen) von den Kodierungen trennt, die Hilfethemen-IDs darstellen (rechts vom Gleichheitszeichen).
- RTF (Rich Text Format): Diese Datei enthält den eigentlichen Hilfetext und kann mit einem gewöhnlichen Textverarbeitungsprogramm oder Translation-Memory-System editiert werden. Einige zu übersetzende Elemente einer RTF-Datei sind: der Fließtext (ausgeblendeter Text für Kontext-IDs, Kodierungen für die Darstellung von Symbolen und Grafiken), einfach unterstrichener Text für Pop-ups und doppelt unterstrichener Text für Links), Fußnoten ? einige beginnen mit "$" (für die Namen der Hilfethemen) und andere mit "K" (für den Index und den Stichwortindex)
- BMP/SHG-Dateien: Die häufigsten Grafiken in Hilfedateien sind Bitmap-Dateien mit der Endung BMP oder SHG. Grafiken werden während der Kompilierung der Dateien eingefügt.
- Die durch die Kompilierung entstehende HLP-Datei stellt die endgültige Hilfedatei dar.
(nach Esselink, 2000 und Whale 2000b)
Der Hauptunterschied zwischen Microsoft's- WinHelp- und HTML-Hilfe-Dateien besteht in den zur Erstellung der Online-Hilfe-Dateien verwendeten Quelldateien. WinHelp-Dateien werden aus Rich Text Format (*.rtf) -Dateien und HTML-Hilfe-Dateien aus HTML und Grafikdateien wie *.jpg und/oder *.gif erstellt. HTML-basierte kompilierte Hilfe-Dateien (CHM) bestehen im Allgemeinen aus mehreren verschiedenen Dateien wie z.B.: HTML, HHC, HHK und Bilddateien (GIF oder JPG). Eine HHP-Datei mit allen Hilfe-Einstellungen wird von einem Hilfe-Compiler (bspw. Micrososft's HTML Help Workshop-Compiler) benutzt um eine oder mehrere HTML- und Bilddateien zu kompilieren, um eine CHM-Datei zu erstellen.
- HTML-Dateien: Die in Hilfe-Projekten verwendeten HTML-Dateien werden wie gewöhnliche HTML-Dateien mit Hilfe eines TM-Systems oder eines HTML-Editors bearbeitet. Da HTML-Dateien Tags mit Formatierungsinformationen und Volltext enthalten, sollten die Tags geschützt und der Text übersetzt werden.
- HHP-Dateien: Diese reinen Textdateien enthalten alle zur Kompilierung der HTML-Hilfe-Datei verwendeten Einstellungen. Sie können mit Hilfe das Text-Editors bearbeitet werden. In diesen Dateien enthaltene zu übersetzende Elemente sind beispielsweise: der Name der HTML-Hilfe-Datei, der in der Namensleiste der Hilfe-Datei angezeigt wird, Fensternamen, Schaltflächennamen, Text in Pop-ups, usw.
- HHC-Dateien: Diese auch als Sitemap-Dateien bezeichneten Dateien enthalten das Inhaltsverzeichnis für HTML-Hilfe-Dateien. Zur Lokalisierung dieser Dateien kann ein Text- oder HTML-Editor verwendet werden.
- HHK-Dateien: Diese Dateien ersetzen die Stichworte und Fußnoten der in WinHelp-Projekten verwendeten RTF-Dateien. Sie enthalten die Stichwortsucheliste der HTML-Hilfe-Dateien. HHK-Dateien können mit einem Text-Editor oder Translation-Memory-Systemen übersetzt werden.
Man nimmt an, dass HTML- und HTML-Hilfe-Formate künftig die meistverbreiteten Dateiformate für Hilfeprojekte sein werden.
(nach Esselink, 2000)
Readme-Dateien sind gewöhnlich Textdateien (*.txt) ohne Formatierungsinformationen, die normalerweise mit dem Anwendungs-Setup geliefert werden. Diese Dateien enthalten Informationen, die wahrscheinlich bei Verfassen oder Druck der Handbücher noch nicht zur verfügung standen, wie Korrekturen, Ergänzungen, usw. Readme-Dateien können mit Text-Editoren wie Notepad oder mit Microsoft Word bearbeitet werden, wenn sie als *.doc vorliegen.