iiRDS zum Anfassen

Text: Fabienne Lange Mariell Längle

Wie funktioniert iiRDS und wie kann eine Technische Redaktion den Austauschstandard richtig nutzen? Eine neue Anwendung erleichtert die ersten Schritte und Erfahrungen in der Praxis.

Inhaltsübersicht

Lesedauer: 05:40 Minuten

Im Herbst veröffentlicht die tekom das kostenlose iiRDS Open Toolkit. Wer sich für den Standard interessiert, kann damit schnell und einfach iiRDS-Metadaten klassifizieren und als iiRDS-Paket exportieren. Die Abkürzung iiRDS steht übrigens für „International Standard for intelligent information Request and Delivery“ und war bereits mehrmals Thema in dieser Zeitschrift, zuletzt in einem Schwerpunkt in Ausgabe 03/20.

Das Open Toolkit ist eine gute Möglichkeit, sich mit dem Standard vertraut zu machen und Erfahrungen zu sammeln. Denn seit seiner Veröffentlichung erfreut sich der Standard wachsender Bekanntheit. Nun ist es Zeit, ihn mit dem iiRDS Open Toolkit greifbar zu machen.

Entstehung des Tools

Zum iiRDS-Konsortium, das die Entwicklung des Standards vorantreibt, gehört die Arbeitsgruppe „Tools – Validation – Content“. Die Arbeitsgruppe hat das Ziel, durch die Bereitstellung eines kostenlosen Tools allen Interessierten die Erstellung erster eigener iiRDS-konformer Pakete zu ermöglichen.

Auf die Idee folgte eine Ausschreibung: Gesucht wurden Experten, die Konzeption und Entwicklung eines solchen Tools übernehmen können. Die Wahl fiel auf die Unternehmen ICMS GmbH (Lindau + Karlsruhe) und plusmeta GmbH (Karlsruhe). Dort entstand zunächst ein gemeinsames Konzept für das Tool, das die plusmeta GmbH umsetzte. Dabei wurden Bausteine der plusmeta-Plattform verwendet und weiterentwickelt.

Aufgaben des Tools

Über die iiRDS-Website (iirds.org) kann jede Person zur kostenfreien Anwendung gelangen. Dort können Inhalte schnell und einfach mit iiRDS-Metadaten ausgezeichnet werden. Anschließend ist ein iiRDS-konformer Export möglich. Um diese Aufgaben zu erfüllen, haben die Projektbeteiligten folgende Anforderungen definiert:

  • Gängige Formate aus dem Bereich der Technischen Dokumentation (PDF, Word, HTML, XML) sollen unterstützt werden.
  • Die Inhalte sollen schnell und valide über die Unterstützung einer intuitiven Software mit Metadaten ausgezeichnet werden können.
  • Die den Inhalten zugeordneten Metadaten sollen durch den Anwender geprüft und bei Bedarf auch wieder überarbeitet werden können.
  • Eigene Metadatenwerte können iiRDS-konform hinzugefügt und vergeben werden.
  • Alle Inhalte, samt Metadaten, sollen einfach per Mausklick als iiRDS-Paket exportiert werden können.

Die genannten Anforderungen sind in die Entwicklung des iiRDS Open Toolkit eingeflossen.

Funktionsweise des Tools

Das iiRDS Open Toolkit führt den Benutzer durch einen Workflow mit vier Arbeitsschritten. Damit von überall aus darauf zugegriffen werden kann, läuft das Tool vollständig im Browser. Es muss sich hierbei um einen modernen Browser wie Google Chrome oder Mozilla Firefox in aktueller Version handeln.

Das Open Toolkit ist so aufgebaut, dass die Dateien nicht den Computer des Benutzers verlassen. Zudem brauchen Benutzer keinen Account und können direkt loslegen. Das erlaubt eine hohe Datensicherheit. Gleichzeitig heißt das auch, dass das Tool keine alten Stände abspeichert und diese öffnen kann. Wird ein Workflow gestartet, muss er zu Ende geführt und das im letzten Schritt entstandene iiRDS-Paket heruntergeladen werden.

Es werden lediglich grundlegende Einstellungen lokal gespeichert. Darunter fallen die Sprache und die Anzeige der Seitenhilfe. Diese Einstellungen können über das Menü auf die Standardeinstellungen zurückgesetzt werden. Es findet kein Datenaustausch mit dem Server statt. Daher eignet sich das Open Toolkit auch für sensible Daten.

Für Experten ist eine Funktion vorhanden, mit der sie im Open Toolkit selbst erstellte Metadaten herunterladen und in einen neuen Workflow hochladen können. Zudem bietet das iiRDS Open Toolkit die Möglichkeit, komplette HTML-Pakete in Form von ZIP-Ordnern zu verarbeiten. Wie das funktioniert, wird im Abschnitt „So arbeiten Sie mit dem iiRDS Open Toolkit“ erläutert.

Nutzen des Tools

Nicht zu viel und nicht zu wenig – das iiRDS Open Toolkit ist die Lösung, um erste Erfahrungen und Erfolge mit iiRDS zu erzielen. Dazu tragen bekannte Technologien, eine intuitive Bedienung und viel Wissen im Backend des Tools bei.

So arbeiten Sie mit dem iiRDS Open Toolkit

So arbeiten Sie mit dem iiRDS Open Toolkit
Damit das iiRDS Open Toolkit möglichst intuitiv benutzt werden kann, werden vier einfache Schritte durchlaufen:

  1. Willkommen
  2. Inhalte hinzufügen
  3. Metadaten vergeben
  4. iiRDS-Paket generieren

Auf den meisten Seiten ist eine Seitenhilfe eingeblendet, die Neueinsteiger unterstützt. Kennt sich der Benutzer jedoch mit dem Open Toolkit aus, kann er die Seitenhilfe entfernen. Sie wird dann bei zukünftigen Workflows nicht mehr angezeigt, da diese Präferenz in den Einstellungen gespeichert wird.

1. Schritt: Willkommen
Um mit dem Workflow starten zu können, wird der Benutzer zunächst aufgefordert, die Nutzungsbedingungen und den Datenschutz zu akzeptieren. Erst dann erscheint in der rechten unteren Ecke ein Pfeil, mit dem der Workflow gestartet werden kann.

2. Schritt: Inhalte hinzufügen
Im zweiten Schritt kann der Benutzer seine Dateien hochladen, die er im iiRDS-Paket verpacken möchte. Möglich sind HTML-, PDF- und XML-Dateien sowie ZIP-Archive für HTML-Dateien (Abb. 01). Diese können einfach über Drag and Drop hinzugefügt werden. Andere Formate wie etwa Word-Dateien lassen sich ebenfalls hochladen, jedoch ist für diese Dateitypen keine Vorschau möglich.

Oberfläche des iiRDS Open Toolkits im Internetbrowser.

Abb. 01 Quelle iirds.org

3. Schritt: Metadaten vergeben
Dem Benutzer werden jetzt alle Objekte angezeigt, die er importiert hat. Durch einen Klick auf ein Objekt werden die Objektdetails ausgeklappt und in einer Vorschau angezeigt. Im aufgeklappten Zustand können dem Objekt dann Metadaten zugewiesen werden. Es werden bereits einige Metadaten angezeigt, die man mit Werten befüllen kann. Welche Metadaten angezeigt werden, hängt vom Objekttyp ab.

Das Open Toolkit unterscheidet zwischen Dokument, Topic und Fragment. Dokument und Topic werden automatisch vorbelegt (PDF-Dateien als Dokument, HTML- und XML-Dateien als Topics). Der Objekttyp Fragment hingegen muss vom Benutzer nachträglich in der Drop-Down-Liste „Objekttyp“ angegeben werden (Abb. 02).
Neben den bereits angezeigten Metadaten können Benutzer über das grüne Plus auch noch weitere iiRDS-Metadaten einblenden.

Menü für Metadaten.

Abb. 02 Quelle iirds.org

Für die Metadaten stehen die im iiRDS-Metadatenmodell definierten Werte zur Verfügung. Diese Werte können im Open Toolkit einfach über eine Drop-Down-Liste des entsprechenden Metadatums ausgewählt werden.

Da nicht jedes iiRDS-Metadatum Werte vorgibt, können Benutzer zusätzlich auch eigene Einträge erstellen: Dafür muss der gewünschte Wert einfach in das Feld des entsprechenden Metadatums eingetragen und die Eingabe mit der Enter-Taste bestätigt werden (Abb. 03).

Es ist nicht zwingend erforderlich, jedes Metadatenfeld zu befüllen. Benötigt ein Benutzer ein Metadatum nicht, so kann er es einfach frei lassen. Dabei gibt es jedoch drei Ausnahmen: Die Metadaten Titel, Sprache und Dokumentart (beim Objekttyp Dokument) sind Pflichtmetadaten und sollten mit Werten versehen werden.

Menü für Metadaten.

Abb. 03 Quelle iirds.org

4. Schritt: iiRDS-Paket generieren
Im letzten Workflow-Schritt wird nun das iiRDS-Paket automatisch generiert (Abb. 04). Es kann anschließend über den Download-Button heruntergeladen werden.

Durch einen Klick auf den blauen Haken gelangt der Benutzer schließlich auf die Abschlussseite des Workflows. Auf dieser kann er erneut das iiRDS-Paket oder die selbst erstellten Metadaten als RDF-Datei herunterladen und ein neues Paket erstellen. Dadurch startet ein neuer Workflow.

Menü des letzten Arbeitsschritts.

Abb. 04 Quelle iirds.org

Metadatenimport
Wurden am Ende die selbst erstellten Metadatenwerte heruntergeladen, können diese in zukünftigen Workflows wiederverwendet werden. Dafür muss die RDF-Datei in einem beliebigen Workflow-Schritt über das Menü „  “ importiert werden. Anschließend stehen die Metadatenwerte im Workflow-Schritt „Metadaten vergeben“ zur Verfügung.

ZIP für HTML-Dateien
Online-Hilfen werden häufig als Paket aus mehreren HTML-Dateien mit zugehörigen Bildern, Stylesheets und Skripten publiziert. Das iiRDS Open Toolkit ermöglicht, diese Pakete in Form eines ZIP-Archivs in das Open Toolkit zu importieren. Dabei werden die HTML-Dateien für die Metadatenvergabe aus dem ZIP-Archiv extrahiert. Bei der Generierung des iiRDS-Pakets wird die ursprüngliche Struktur des ZIP-Archivs wiederhergestellt. So sind Bilder, Links und Styles auch innerhalb des iiRDS-Containers korrekt referenziert.

 

Oberfläche des iiRDS Open Toolkit.