Tagungsband-Beitrag zur tekom-Jahrestagung 2015
IN44 – Tutorial für Experten, Themenbereich "Intelligent Information"

Einbetten von spezifischen XML-Strukturen in bestehende Dokumentstrukturen

Mit Industrie 4.0 müssen Informationen in spezifischem Kontext auswertbar werden. Deshalb wächst der Bedarf an Lösungen, die das Einbetten von spezialisierten Strukturinformationen in einem allgemeinen Kontext ermöglichen. Mit Adobe® FrameMaker® können diese Anforderungen umgesetzt werden. Analog zu eingebetteten Strukturen wie MathML für Formeln und SVG für Grafiken, können auch selbstdefinierte Strukturen eingebettet werden. Anwendungsgebiete könnten die Darstellung von PIN-Belegungen für Schaltkreise oder das Einbetten von Meldungstexten einer Anlagensteuerung sein.

Die Konzeption von Zugriffsmöglichkeiten auf Maschinen, Anlagen, Gebäudeeinrichtungen, Fahrzeuge usw. erzeugt auch den Bedarf, diesen Zugriff zu beschreiben. Außerdem werden Informationsstrukturen gezielt für Kommunikationstexte in Steuerungseinrichtungen konzipiert. Damit ist es möglich, die strukturierten Inhalte auch zur Beschreibung außerhalb des Systems zu nutzen.

Wirtschaftlicher Hintergrund zum Lösungsansatz

Mit XML strukturierte Daten sind sehr praktisch nutz- und übertragbar, jedoch funktionieren die Austausch- und Darstellungsprozesse nur dann, wenn die XML-Struktur immer den selben Regeln folgt. Abweichungen im Kontext können zwar meist leicht angepasst werden, jedoch der Einsatz völlig neuer Elementnamen und Attribute erfordert oft eine umfangreiche Anpassung der Gesamtstruktur und aller Transfer-Prozesse.

Im konkreten Kontext der technischen Dokumentation werden XML-basierte Redaktionssysteme eingesetzt, die mit fest definierten XML-Strukturen die Automatisierung komplexer Publikationsprozesse ermöglichen, die bei jeder Strukturänderung vom Editieren bis zur Ausgabe angepasst werden müssen.

Dem gegenüber steht der neue Bedarf, Informationen mit völlig neuen, sich potentiell häufig(er) ändernden Strukturen zu integrieren und mit zu verarbeiten. Werden diese Strukturen in Publikationsprozesse eingebaut, würde das häufige Anpassen an neue Strukturen einen ständigen Anpassungsstau nach sich ziehen. Das ist die Herausforderung, die es zu lösen gilt!

Die individuelle, firmenspezifische Layoutierung der XML-Daten benötigt eine Software-Lösung, die zusätzlich bei gleichbleibender XML-Struktur die Änderung des Layouts unkompliziert ermöglicht. Sehr gute Funktionen für diese Umsetzung bietet Adobe® FrameMaker® – ein Programm, das XML-Strukturen mit DTP-Funktionen darstellt, den publizierten Inhalt in verschiedenen Ausgabeformen exportieren kann und gleichzeitig XML-Editor ist.

Um die Zuordnung zu treffen, welche Information aus der XML-Struktur in welchem Kontext wie umgesetzt und formatiert werden soll, wird eine Applikation entwickelt, die im Programm diese Regeln implementiert. Auch diese Applikation muss bei Änderung der XML-Struktur grundlegend und bei Anpassung des Layouts im Basis-Template angepasst werden. Das bedeutet, dass auch eine Publikationslösung mit Adobe FrameMaker ständig angepasst werden muss, wenn man auf herkömmliche Weise neue Struktur-Komponenten ainbauen möchte.

Doch das Programm verfügt über eine geniale Funktionalität, die zur Trennung der Abhängigkeit von Publikationsstruktur und Spezialstruktur der Maschinen-internen Informationsbausteine dienen kann: Die Fähigkeit, den Textfluss einer anderen FrameMaker-Datei im Textfluss eines „Eltern“-Dokuments zu referenzieren.

Aufbau einer FrameMaker-XML-Applikation

Die Entwicklung einer FrameMaker-XML-Applikation erfordert einigen Entwicklungsaufwand, um alle benötigten Komponenten arrangieren zu können.

Die Komponenten einer FM+XML-Applikation

Sowohl für die Handbuchstruktur als auch den Einsatz der einzubettenden Struktur muss die Umsetzung konzipiert und entwickelt werden. Dabei entsteht der Bedarf, eine fertige Anwendung nicht ständig anpassen zu müssen, wenn eine eingebettete Struktur geändert wird. Genauso wesentlich ist es auch, die eingebettete Struktur durch eine andere Struktur ersetzen zu können, wenn beispielsweise die Texte in der Steuerung der einen Anlage in einer anderen Strukturdefinition abgelegt sind als die Texte einer Maschine.

Umsetzung in der XML-Struktur für die Publikation

Innerhalb einer Publikationsstruktur, die zur Strukturierung von Handbuch-Inhalten genutzt wird, wird ein Element definiert, das einen innerhalb der Handbuchstruktur völlig beliebigen Inhalt haben darf und über ein passendes Attrbut uns seinen Dateiname referenziert wird. In DTD-Syntax würde das so aussehen:

<!ELEMENT specialstruct ANY >
<!ATTLIST specialstruct
filename CDATA #REQUIRED >

Mit dieser Definition wird innerhalb der Handbuch-Struktur nicht überprüft, ob der Inhalt von <specialstruct> valide ist. Damit wird es möglich, den Inhalt auszutauschen und zu ändern, ohne die Handbuch-Struktur angreifen zu müssen.

Umsetzung im strukturierten FrameMaker

Soll nun sowohl der Handbuch-Inhalt als auch der Inhalt der <speciastruct>-Elemente layoutiert dargestellt werden, kann man auch in FrameMaker die Struktur vergleichbar aufbauen.

Zusammenfügen der verschiedenen Strukturen

Ein EDD (Element-Definitions-Dokument) ist eine FrameMaker-Datei mit einer ganz speziellen Struktur. Darin wird die Strukturdefinition aus DTD oder XML-Schema vollständig abgebildet und zusätzlich zu jedem Element Formatregeln angegeben.

Werden nun beide Strukturen ganz unabhängig voneinander als Applikation entwickelt, können die Inhalte von <specialstruct> genauso wie die Inhalte des Handbuchs in FrameMaker importiert, dargestellt, gepflegt und auch wieder werden. Sollen Inhalte der Spezialstruktur durch Standard-Texte ergänzt oder grafisch aufbereitet werden – um beispielsweise die Darstellung auf einem Display der Anlagensteuerung nachzubilden – kann mithilfe von XSLT-Transformationsprozessen die meist karge Struktur angereichert und so umgewandelt werden, dass die Darstellung ohne zusätzliche manuelle Anpassung sofort verwendbar ist.

Kombination der Bausteine mit verschiedenen Strukturen

Adobe® FrameMaker® verfügt über die Funktionalität, in einem FrameMaker-Dokument den Inhalt eines anderen FrameMaker-Dokuments zu referenzieren. Das ermöglicht einerseits modulares Arbeiten und Handbuch-Inhalte wiederzuverwenden als auchBausteine unterschiedlicher Struktur in einem Kapitel-Dokument nebeneinander – oder korrekter ineinander verschachtelt – nutzen zu können.

Fazit

Der Lösungsansatz erlaubt es Ihnen, effektiv und robust verschiedene XML-Strukturen zu kombinieren, Texte wiederzuverwenden und hat noch viele weitere Vorteile, die im Detail während des Tutorials präsentiert werden.

Für Rückfragen:

Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein! oder Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein!

Adobe Influencer Logo

Unser Forum ist umgezogen:

Sie finde es jetzt direkt auf 4xscripts.com/forum