Cross-mediale Dokumente mit Help&Manual 9

21.12.2024

Mit Help&Manual 9 lassen sich Dokumente in unterschiedliche Endformate (z.B. HTML oder PDF) exportieren. Dies wird durch Vorlagen ermöglicht, in denen das finale Aussehen der Dateien festgelegt ist.

Help&Manual bietet eine Reihe unterschiedlicher Exportformate an, von denen im Alltag einer Technischen Redaktion vor allem das PDF- und das HTML-Format benötigt wird.

Grundsätzlich ergibt sich das Aussehen des Endformats aus den folgenden beiden Einstellungen:

• Formatvorlagen: Design von Absätzen, Zeichen und Tabellen
• Vorlagendateien: Allgemeine Struktur und Layout von Seiten (HTML oder PDF)

Formatvorlagen können in Help&Manual direkt im Dokument angelegt oder auch in eine separate Datei ausgelagert werden.

Sie finden die verfügbaren Formatvorlagen für Absätze in folgendem Aufklappmenü:

Sie können die Einstellungen der Formatvorlagen bearbeiten, wenn Sie auf die Schaltfläche „Formate“ in der Registerkarte „Einfügen“ klicken.

Beim Export eines Dokuments können Sie das gewünschte Endformat festlegen. Hier stehen Ihnen z. B. die HTML und PDF als Optionen zur Verfügung.

Beim PDF-Format hat die Vorlagendatei die Erweiterung „mnl“. In diesen Dateien werden die folgenden Einstellungen definiert:

• Satzspiegel
• Titelseiten
• Rückseite
• Struktur des Inhaltsverzeichnisses

Sie können diese Dateien mit dem sog. Print Manual Designer bearbeiten. Dabei handelt es sich um ein separates Tool. Sie finden es im Installationsverzeichnis des Programms Help&Manual.

Vorlagen für HTML-Dateien haben die Erweiterung „hmskin“.

Sie können diese Dateien direkt mit dem Redaktionssystem öffnen (Doppelklick).

HTML-Vorlagen funktionieren wie folgt: Es gibt voreingestellte HTML-Codes (Templates), die beim Export kopiert werden. Die Templates enthalten Platzhalter, die mit den Inhalten aus Ihrem Dokument gefüllt werden.

Sie erreichen die Templates nach dem Öffnen der HMSKIN-Datei unter:

Konfiguration -> Exporteinstellungen -> WebHelp

Beim Export eines Dokuments ins HTML-Format wird jedes Topic des Repositorys in eine HTML-Datei umgewandet. Der Dateiname der XML und der exportierten HTML sind identisch. Alle Dateien werden in einen Ausgabeordner kopiert.

Vielleicht werden Sie sich bei den HTML-Dateien ein anderes Aussehen wünschen. Ich persönlich würde die Vorlagen niemals verwenden. Es gibt mehrere Gründe. Ein plausibler ist das Corporate Design. Bei den anderen Gründen müsste ich hier zu viel meckern.

Es besteht auch die Möglichkeit, HTML-Dateien über Stapelverarbeitungsprogramme nachträglich zu modifizieren. Dies würde die fehleranfällige Bearbeiung von Templates ersparen. Bei der Generierung des HTML-Outputs werden Codes erzeugt, die in keiner einsehbaren Vorlage enthalten sind. Aus diesem Grund ist eine nachträgliche Bearbeitung oft sowieso erforderlich.

Falls Ihr Unternehmen Online-Hilfen benötigt, gibt es eine Softwareabteilung, die Sie bei dieser Frage unterstützen kann.