Den Überblick behalten

Im redaktionellen Alltag existieren eine Reihe von Anforderungen, in Dokumenten Zusatzinformationen zu hinterlegen. Diese haben die Aufgabe, Auskunft über den Redaktionsprozess zu liefern. Besonders dann, wenn ein Handbuch modular aufgebaut wird, ist es hilfreich, in den Modul-Dokumenten die Historie, eine Versionsnummer, einen Bearbeitungsstatus und auch die Gültigkeit der Inhalte für konkrete Varianten mitzuliefern.

Werden XML-basierte FrameMaker-Dokumente erstellt, dann hat es sich bewährt, die Zusatzinformationen im Dokument am obersten Element der XML-Struktur in Attributen zu verankern. Dort sind sie leicht lesbar und geschützt vor versehentlichen Änderungen. Doch auch dann, wenn mit nativen FrameMaker-Dokumenten gearbeitet wird, muss es eine Lösung geben, um Meta-Informationen in einem Dokument zu hinterlegen.

Meta-Informationen in Variablen?

Für die Kennzeichnung nativer FrameMaker-Dokumente wird häufig die Nutzung von benutzerdefinierten Variablen empfohlen. Sie sind dafür geeignet, ihren Inhalt im Text oder in Kopf- oder auch Fußzeilen anzuzeigen.

Variablendefinitionen gehören im Programm funktional zu den Formatkatalogen. Mithilfe der Kataloge werden Formatdefinitionen im Dokument hinterlegt, die leicht durch den Import von Formaten ausgetauscht werden können. Damit sind spezielle benutzerdefinierte Variablendefinitionen potenziell gefährdet, durch Import anderer Definitionen überschrieben zu werden. Sollen diese wichtigen Informationen sicher vor Veränderung sein, empfiehlt es sich, sie nicht mit Variablen zu erfassen.

Abb. 1: In diesem Dialogfeld lassen sich die Bereiche für die Formatimporte einstellen.
SCREEN Adobe/Ute Mitschke

Datei-Eigenschaften verwenden?

In den Datei-Eigenschaften können in jedem FrameMaker-Dokument Meta-Informationen hinterlegt werden, die auch beim Speichern in ein PDF übergeben werden. Standardmäßig sind darin bereits Felder für den Bearbeiter (Autor), für einen näher beschreibenden Titel, Schlüsselwörter oder auch Copyright enthalten. Werden Dokumente in einem Buch eingefügt und das Buch als PDF gesichert, dann werden in das PDF die Datei-Informationen der Buchdatei übertragen. Die Datei-Informationen der Buchkomponenten werden dadurch nicht verändert, werden jedoch auch nicht in das PDF übernommen.

Abb. 2: Hier kann der Autor die Datei-Informationen eingeben.
SCREEN Adobe/Ute Mitschke

Datei-Informationen eignen sich nur auf den ersten Blick, um Meta-Informationen im Dokument zu verankern. Denn beim Import anderer Formate und Dokumenteigenschaften werden die ursprünglichen einfach überschrieben. Die Lösung ist also nicht sicher und daher ungeeignet.

Betrachtet man den Aufbau von FrameMaker-Dokumenten, können Informationen auf der Arbeitsseite, auf einer Vorgabeseite, einer Referenzseite, in Variablendefinitionen oder in Datei-Informationen abgelegt werden. Doch bis auf die Inhalte der Arbeitsseiten werden alle anderen Plätze durch den Formatimport angreifbar. Bei jedem Start des Dialogfelds für den Import von Formaten sind alle Optionen aktiviert. Im Redaktionsalltag kann es daher leicht passieren, dass entscheidende Informationen einfach überschrieben werden, die Dokumente eindeutig zuordenbar und verfolgbar machen.

Im Haupttextfluss mitführen?

Im Normalfall möchte ein Autor, dass im Haupttextfluss eines Dokuments nur die eigentlichen Inhalte stehen. Dadurch werden bei der Publikation keine störenden Informationen über redaktionelle Aufgaben mit ausgegeben. Dennoch bietet sich der Inhalt der Arbeitsseite dafür an, da ihn ein Format­import nicht verändert.

Es ist möglich, auf den Arbeitsseiten einen weiteren Textrahmen mit zusätzlichem Textfluss anzulegen. Der Textrahmen kann zum Beispiel „Metadaten“ heißen. Damit werden die Informationen vom Haupttextfluss getrennt. Der Anfang des Haupttextflusses eines Dokuments scheint aber besonders dafür geeignet, dort Meta-Informationen anzugeben. Dazu legt der Redakteur entsprechende Absatzformate an. In den folgenden Abschnitten ist der Ablauf erklärt.

Die Modul-Beschreibung einfügen

Ein Absatzformat „META-Modul-Beschreibung“ wird auf den ersten Absatz im Textfluss zugewiesen, in dem der Inhalt des Moduls eindeutig beschrieben ist. Werden alle Moduldateien in einem FrameMaker-Buch verwaltet, kann die Beschreibung direkt im Buchfenster angezeigt werden.

Abb. 3: Im Buchfenster wird die Beschreibung anstelle des Dateinamens angezeigt
SCREEN Adobe/Ute Mitschke

Version, Status und Gültigkeit

Diesem Absatz folgen weitere für die Version, den Status und die Gültigkeitszuordnung zu Produkten und Varianten jeweils mit einem speziell definierten Format. Üblicherweise werden der Status und die Gültigkeitszuordnung mit festgelegten Begriffen angegeben. Um diese Begriffe nicht manuell eingeben zu müssen, können sie auf einer zusätzlichen Referenzseite in einem eigenen Textrahmen eingetragen werden. Aus dieser Quelle lassen sich die Begriffe als Querverweis in die Meta-Informationen einfügen.

Abb. 4. Im Textrahmen auf einer Referenzseite sind die Auswahlwerte hinterlegt.
SCREEN Adobe/Ute Mitschke

Soll der aktuelle Status während der Bearbeitung zum Beispiel in einem Wasserzeichen auf jeder Seite angezeigt werden, dann kann der Autor auf der Vorgabeseite einen Textrahmen einbauen. Darin fügt er einen Querverweis auf den Statusabsatz vom Haupttextfluss ein. Durch die eindeutige Zuordnung der Meta-Informationen in Absätze mit speziellen Absatzformaten können die Inhalte beliebig im Dokument referenziert werden.

Übersicht über alle Module

Soll in dem Buch, in dem alle Module verwaltet werden, eine Übersicht mit allen Meta-Informationen aller Module zusammengestellt werden, dann lässt sich darin eine Liste aus Absätzen zusammenstellen, analog einem Inhaltsverzeichnis. Die Liste führt der Reihe nach alle Informationen auf, wie sie im Buch auftreten.

Um diese Übersicht zu strukturieren, wird dem ersten Absatz mit Meta-Informationen eines Moduls eine Linie als Rahmen über dem Absatz zugewiesen – in unserem Beispiel ist das Format „META-Modul-BeschreibungEAL“. Die generierten Inhalte können wie bei einem Inhaltsverzeichnis auf der Referenzseite konfiguriert werden. Mit der Ergänzung des Bausteins <$file­name> vor <$paratext> wird zu jeder Information der Dateiname hinzugefügt. Damit ist die Zuordnung der Information zum Modul eindeutig.

Gründe für Bearbeitung wichtig

In einer zusätzlichen Tabelle des Moduls lässt sich die Bearbeitungshistorie vermerken. Es empfiehlt sich, nicht nur Datum und Bearbeiter einzutragen, sondern auch die Gründe für die Änderung des Moduls.

Wurde ein Modul durch Kopie eines weiterhin verwendeten Moduls erzeugt, dann sollten zusätzlich alle Informationen zum Ursprungsmodul mit aufgenommen werden: Dateiname, Version, Status jeweils zum Zeitpunkt der Kopie.

In Publikation verbergen

Um die Meta-Informationen bei der Publikation der Module auszublenden, werden die betreffenden Absätze als bedingter Text mit einem Bedingungsformat „META-Informationen“ gekennzeichnet. Dadurch kann bei der Publikation über das Buch das Ausblenden gesteuert werden. Auch bei der Bearbeitung der Module lassen sich auf Wunsch die Meta-Informationen ausblenden. In dem Fall muss der Redakteur darauf achten, dass er die Meta-Informationen, die in einer Marke am Beginn des Textflusses versteckt werden, nicht versehentlich löscht.

Nach XML übernehmen

Modularisierung ist ein geeignetes Instrument, um Inhalte wiederzuverwenden und zu aktualisieren. Gleichzeitig werden Übersetzungskosten gespart, da die Zahl an Varianten geringer ist. Damit die Fülle an Dateien und deren Bearbeitungszustand handhabbar bleiben, empfiehlt es sich, in jeder Modul­datei Meta-Informationen im Haupttextfluss zu hinterlegen. Wird eine Technische Dokumentation in FrameMaker-Dateien modularisiert, dann investiert die Technische Redaktion viel Zeit in die Erstellung. Da FrameMaker die Möglichkeit bietet, mit Hilfe von Konvertierungstabellen inhaltlich differenziert formatierte Texte in eine adäquate XML-Struktur zu übertragen, ist es sinnvoll, auch die Meta-Informationen direkt in die XML-Struktur einfließen zu lassen.