DITA-Blog-Publikation via iiRDS nach c-rex.net IDS

DITA als Datenquelle

Wir haben in den vorangegangen Beiträgen beschrieben, dass wir in unserer Redaktion auf DITA als Erstellformat setzen.

Jetzt beantworten wir die Frage, wie wir ausgehend von unseren mit Metadaten angereicherten Inhalten den c-rex.net-Blog befüttern.

Da wir auf DITA aufsetzen, bietet es sich an, das DITA Open Tool Kit für die Veröffentlichung zu nutzen. Wir konvertieren die Inhalte zunächst nach iiRDS und veröffentlichen sie anschließend auf c-rex.net IDS.

Zu diesem Zweck haben wir ein Set an Plugins entwickelt. Plugins, die uns ermöglichen, auf Knopfdruck zu publizieren.

DITA-OT Plugins

Die folgende Grafik zeigt die Plugins für das DITA Open Tool Kit, die in unserer Redaktionsumgebung genutzt werden.

Für den Usecase Content Delivery sind 3+1 Plugins relevant:

• com.c-rex.net.dita.dts

  Dieses Plugin stellt grundlegende Funktionalität zur Verfügung, um mit dem Cloud-Dienst c-rex.net DTS zu kommunizieren. Es stellt grundsätzliche Parameter für die Authentifizierung am System sowie für die Konvertierungen zur Verfügungen.

• com.c-rex.net.dita.packager

  Der Packager ist ein allgemein einsetzbares Plugin, das die Inhalte einer DITA-Map in ein ZIP-Paket verpackt, um den Content, wie in diesem Anwendungsfall notwendig, an c-rex.net DTS zur Konvertierung zu übermitteln.

• com.crex.net.dita.conversion

  Das Plugin stellt Parameter für die Konvertierung von DITA-Inhalten in andere Formate bereit. Das Plugin implementiert die beiden Transformationsszenarien DITA 2 iiRDS und DITA 2 c-rex.net IDS.

• com.crex.net.dita.td.content

  Hier handelt es sich um ein spezielles Plugin für die spezialisierten c-rex.net Topictypen und die Umsetzung spezieller Anforderungen.

  Darin setzen wir die spezifischen Metadaten in unseren Blogbeiträgen um, so dass diese bei der Konvertierung nach iiRDS durch c-rex.net DTS entsprechend erkannt und in das Format iiRDS überführt werden können.

  Dieses Plugin oder eine Abwandlung davon kann in unterschiedlichen Szenarien eingesetzt werden, um kundenspezifische Anforderungen an das zu generierende HTML oder das zu generierende Metadatenset entsprechend automatisiert anzupassen.

Das DITA-OT Conversion Plugin

Das DITA-OT Conversion Plugin stellt zwei Funktionen zur Verfügung:

• Fall 1: Generierung eines iiRDS Pakets für die Verwendung in anderen Szenarien

• Fall 2: Publikation der Inhalte via iiRDS auf c-rex.net IDS in verschiedenen Content-Delivery -Szenarien

Da wir unsere Blogbeiträge direkt veröffentlichen wollen, konzentrieren wir uns auf den zweiten Anwendungsfall, wobei der Unterschied lediglich darin besteht, ob das iiRDS zurück an den Client geliefert oder direkt veröffentlicht wird.

Konfiguration und Parameter

Um die Konvertierungsdienste von c-rex.net DTS und die Veröffentlichungsoptionen von c-rex.net IDS nutzen zu können, sind ein Benutzer-Account und entsprechende Berechtigungen erforderlich. Über die Eintragung der Zugangsdaten wird der Aufruf des Transformationszenarios im Plugin konfiguriert. Im folgenden Dialogfenster sehen Sie das notwendige Parameterset dafür.

Zur Ausführung des Transformationsszenario müssen folgende Parameter gesetzt werden.

• Über den conversionType.param wird das DTS-Szenario angegeben, mit dem DTS die Konvertierung durchführen soll. In diesem Fall soll die DITA-Map nach c-rex.net IDS publiziert werden, wozu das Szenario ditaot2crexIDS eingestellt wird.

• Über den organization.param wird die Organisation angegeben, unter der das iiRDS- Paket veröffentlicht werden soll.

  Über die Organisation könnten Zugriffsrechte auf Inhalte gesteuert werden.

• Über den dts.url.param wird der Endpunkt des DTS-Dienstes angegeben, über den die Konvertierung durchgeführt werden soll. Als Cloud-Dienst konzipiert sind naturgemäß mehrere Instanzen im Internet oder im Intranet verfügbar.

• Zum Schluss erfolgt über die drei identity-Parameter die Angabe von Benutzerdaten, wie Benutzername und Passwort, sowie den vom Authentifizierungsdienst benötigten Scope.

  All diese Informationen sind im jeweiligen Benutzerprofil nach der Registrierung am System verfügbar.

Nachdem der Zugang am System eingerichtet ist und diese Einstellung vorgenommen wurde, lässt sich jede DITA-Map im c-rex.net IDS Portal über einen einzigen Klick auf "Transformation ausführen" veröffentlichen.

Datenaufbereitung

Das DITA-OT-Plugin bereitet die Daten für die serverseitige Konvertierung auf. Dabei werden sämtliche DITA-Topics über die Funktionalität von DITA-OT wahlweise nach HTML5 oder XHTML5 transformiert.

Da sich unsere Plugins nahtlos in eine Umgebung mit DITA-OT integrieren lassen, hat dies den großen Vorteil, dass automatisch bisherige Erweiterungen für die Generierung von HTML-Inhalten direkt und ohne weitere Anpassungen genutzt werden können.

Das ist in unserer Blog-Umgebung der Fall und das wird sich auch in Ihrer Umgebung leicht realisieren lassen!

Schließlich verwenden wir diesen Mechanismus auch, indem wir unser eigenes spezifisches Plugin com.crex.net.dita.td.content für die Aufbereitung der HTML-Seiten nutzen.

Neben der HTML-Generierung werden automatisch Basis-Metadaten in der DITA-Map ergänzt und die Referenzen auf die DITA-Topics auf den neuen Dateinamen der HTML-Ausgabe umgestellt. Dieses Generat wird nun an c-rex.net DTS übergeben.c-rex.net DTS wiederum stellt die Informationen zu einem validen iiRDS-Paket zusammen und veröffentlicht sie automatisch.

Die an den Topic-Referenzen in der DITA-Map automatisch erweiterten Metadaten können über ein eigenes DITA-OT-Plugin wie dem com.crex.net.dita.td.content automatisiert ergänzt werden. Alternativ besteht auch die Möglichkeit, eine Konfiguration zu übergeben, die dem DTS-Dienst ermöglicht, ein Mapping eines speziellen Metadaten-Sets durchzuführen.

Transformation nach iiRDS

Durch das übergebene Mapping oder die bereits im Bereich metadata generierten iiRDS Metadaten erzeugt c-rex.net DTS ein valides iiRDS Paket. Dabei werden durch den Standard vorgegebene Bedingungen geprüft, nach Möglichkeit automatisch korrigiert und veröffentlicht. Eventuelle Probleme werden über einen ausführlichen Report zurückgeliefert.

Zusätzlich zum Report wird auch das iiRDS Paket zurückgeliefert. Dieses Paket kann über vorhandene Archivierungsmechnismen im Unternehmen archiviert werden.

Damit stellen wir sicher, dass vom System generierte Daten jederzeit und systemunabhängig zur Verfügung stehen.

Für Unternehmen, für die wir Projekte mit iiRDS realisieren, heißt das: Wir lösen Silos auf und geben unserenKundenKundinnenKunden und KundinnenKund:innen die Hoheit über ihre Daten zurück.

Veröffentlichung im Portal

Das fertige iiRDS Paket wird c-rex.net IDS über die Content API zur Veröffentlichung zur Verfügung gestellt.

Der Paketinhalt wird in das Repository der im Parameter angegebenen Organisation importiert. Der Inhalt steht damit binnen weniger Minuten oder gar Sekunden im Portal zur Nutzung zur Verfügung.

Fazit

Mit geringem Aufwand durch Integration unserer Plugins und einer minimal notwendigen Konfiguration stehen unsere mit DITA erstellten Inhalte binnen kürzester Zeit auf unserer Website zur Verfügung.

Schneller und mit weniger Aufwand schafft man es kaum, Inhalte auf Basis der Technologie Linked Data im Web bereitzustellen.

Und das Schöne ist, das funktioniert nicht nur für unseren Blog, der auf DITA basiert, sondern analog mit Ihren in Word, FrameMaker oder InDesign erstellten Dokumenten. Liefern Sie neben Ihren Dokumenten eine Konfiguration für das Mapping der Metadaten mit und c-rex.net DTS übernimmt den Rest.