XML-Dokumentation

Version 1.0 2013

Inhaltsverzeichnis Inhaltsverzeichnis...................................................................................................................................2 Einführung............................................................................................................................................. 3 Wozu dient ein XML-Feed?.............................................................................................................. 3 Allgemeine technische Anforderungen..............................................................................................3 Wohlgeformtheit............................................................................................................................ 3 DTD/Schema................................................................................................................................. 3 Namensräume............................................................................................................................... 3 Zweck dieses Dokuments.................................................................................................................. 3 Allgemeine Informationen.....................................................................................................................5 Info.................................................................................................................................................... 5 Abholen und Benennen von Dateien................................................................................................. 5 Veröffentlichungsdatum................................................................................................................ 6 Artikel- oder Seiten-IDs................................................................................................................ 6 Nach dem Abholen............................................................................................................................ 6 Vom Kunden zu liefernde Informationen.......................................................................................... 6 Seitenzahl...................................................................................................................................... 6 Abschnittsnummer oder Abschnittsidentifikator...........................................................................7 Kategorie....................................................................................................................................... 7 Artikel-ID...................................................................................................................................... 7 Titel/Schlagzeilen......................................................................................................................... 7 Verfasserzeilen............................................................................................................................. 7 Einleitende Absätze...................................................................................................................... 7 Fließtext-Absätze und Absatzüberschriften.................................................................................. 7 Infoboxen oder andere untergeordnete Artikelelemente............................................................... 7 Angaben zur Geometrie.................................................................................................................8 Informationen zu Bildern und Grafiken........................................................................................ 8 Vorhandensein, Referenzieren und Benennen von Bilddateien................................................... 8 Bildtext/Bildunterschrift............................................................................................................... 8 Bildtyp.......................................................................................................................................... 8 Bildsortierung............................................................................................................................... 9 Bildskalierung und -beschneidung............................................................................................... 9 Checkliste........................................................................................................................................... 10 Beispiele.............................................................................................................................................11 Infomaker (NewsPilot)................................................................................................................... 11 Saxotech......................................................................................................................................... 13

Einführung Dieses Dokument richtet sich an Visiolink-Kunden, die Hilfestellung beim Einrichten eines effizienten XML-Feeds für ihre Veröffentlichung benötigen.

Wozu dient ein XML-Feed? Es wird empfohlen, dass der Kunde neben PDF-Seiten, die auf e-pages.dk und in der Seitenansicht der App des Kunden angezeigt werden, auch XML-Daten an Visiolink übermittelt. Die im XMLFeed enthaltenen Informationen dienen zur Aktivierung der Volltextansicht und von Touchzonen, mit denen der App-Benutzer zwischen der Seitenansicht und der Volltextansicht wechseln kann. Außerdem können mit XML-Feeds – falls erforderlich – Rich-Media-Inhalte wie Bilder, Videooder Audio-Inhalte eingebettet werden.

Allgemeine technische Anforderungen Der vom W3C definierte XML-Standard hat ganz eigene Anforderungen und nützliche Optionen, die Sie berücksichtigen sollten, wenn Sie einen XML-Feed für Visiolink einrichten.

Wohlgeformtheit Eine XML-Struktur entspricht nur dann dem echten XML-Standard und ist somit analysierbar, wenn sie wohlgeformt ist, und zwar unabhängig davon, ob es sich dabei um ein vollständiges XML-Dokument oder um ein Fragment handelt. Die Struktur muss immer als Baum erfasst werden können. Wenn Ihr XML-Setup auch Handgeschriebenes umfasst, stellen Sie sicher, immer alle offenen XML-Elemente zu schließen, indem Sie passende Start- und Endtags in korrekter Reihenfolge setzen. Verwenden Sie statt eines Text-Editors eine spezielle XMLBearbeitungssoftware – z. B. XMLSpy, XMetaL usw. – mit integrierter Syntaxhervorhebung und automatischer Wohlgeformtheitsprüfung und -validierung.

DTD/Schema Es wird dringend empfohlen, ein DTD- oder XML-Schema für Ihren XML-Feed zu verwenden. Jede XML-Datei, die einen Verweis auf eine DTD oder ein Schema enthält, kann jederzeit damit validiert werden. Wenn sie über eine URL frei zugänglich ist, kann die Überprüfung sogar von überall durchgeführt werden. Ungültige Dateien in Ihrem Feed können frühzeitig erfasst werden, zum Beispiel durch Sie selbst bei einem letzten Überprüfungsschritt direkt vor der Übermittlung oder durch Visiolink bei einem Zwischenschritt zwischen Abholung und Verarbeitung einer Datei. Ohne diese nützlichen Überprüfungstools steigt das Risiko falscher oder unbrauchbarer Ausgaben in Ihrer App oder eines Systemabsturzes bei Visiolink.

Namensräume Kurz gesagt: Mit dem Konzept der Namensräume lassen sich Bereiche innerhalb eines XML-Baums unabhängig von anderen Bereichen desselben Baums definieren. Ein Vorteil der Namensräume ist daher, dass XML-Fragmente aus verschiedenen Quellen relativ frei miteinander zu einem neuen XML-Baum verknüpft werden können, ohne Gefahr zu laufen, dass Tagnamen mit widersprüchlichen Definitionen aus unterschiedlichen DTDs wiederholt werden.

Zweck dieses Dokuments Dieses Dokument enthält allgemeine Informationen darüber, wie XML-Feeds von Visiolink bearbeitet werden und was Visiolink von seinen Kunden im Zusammenhang mit der Dateibenennung, Dateiinhalten usw. erwartet. Außerdem enthält dieses Dokument eine

Checkliste, die Sie bei der Erstellung eines XML-Exports zu Hilfe nehmen können, um sicherzustellen, dass alles in dem bereitgestellten XML-Feed enthalten ist. Am Ende dieses Dokuments finden Sie Beispiele für XML-Feeds mit der Struktur von zwei unterschiedlichen Redaktionssystemen. Diese Beispiele sollen als Anregung für die Einrichtung eines XML-Feeds dienen. Die Verfasser dieses Dokuments hoffen, dass Ihnen diese Informationen weiterhelfen. Falls Sie Fragen zum Visiolink-Setup haben oder auf dem Weg zur endgültigen Einrichtung Probleme oder Einschränkungen feststellen, können Sie Visiolink gerne kontaktieren.

Allgemeine Informationen Dieser Abschnitt enthält allgemeine Informationen darüber, wie Visiolink XML-Dateien bearbeitet und welche Informationen die Kunden beim Benennen von XML-Dateien und/oder in den XML-Dateien angeben müssen.

Info 1. Das folgende Schaubild zeigt, welchen Verlauf die Dateien nehmen, die der Kunde an das Visiolink-System übermittelt.

Anhand des Schaubilds oben sehen Sie, welche Schritte der XML-Feed eines Kunden nach der Übermittlung durchläuft. Nach Abholen der Dateien folgt die Verarbeitung durch den VisiolinkXML-Importer. Der Importer füllt eine Veröffentlichungsdatenbank mit allen erhältlichen Informationen über Abschnitte, Artikel, Artikelelemente und Erweiterungen. Falls eine Übermittlung von Bilddateien erfolgt, werden diese beim Import automatisch auf verschiedene Ausgabegrößen skaliert. Sobald der Import abgeschlossen ist, kann die übermittelte Veröffentlichung auf allen Plattformen einschließlich Smartphones, E-Pages und Tablets mit den verarbeiteten Bildern und weiterem Zusatzmaterial angezeigt werden.

Abholen und Benennen von Dateien Da alle Kunden ihre Daten in einen bestimmten Ordner auf einem FTP-Server hochladen sollen, der mit der Zeit immer umfangreicher wird, verlangt Visiolink grundsätzlich, dass im Dateinamen erkennbar ist, zu welcher Ausgabe welcher Zeitung eine Datei gehört. Unabhängig davon, ob ein Kunde alle Dateien unkomprimiert oder pro Artikel bzw. Seite in einem ZIP-Archiv gepackt liefert, sollte gewährleistet sein, dass die Namen der zuerst abgeholten Dateien immer einer festgelegten

Benennungskonvention folgen. Als Best Practice empfiehlt Visiolink, im Dateinamen den Namen des Kunden, das Veröffentlichungsdatum sowie einen Artikel- oder Seitenidentifikator aufzuführen. Hier einige Beispiele: (1) _--_. (2) dailynews_20140115_12345.xml (3) tageszeitung_2014-06-01_page_1.zip

Veröffentlichungsdatum In Beispiel (2) erkennt Visiolinks automatischer Importer, dass er diese Datei am 15. Januar 2014 abholen muss, nicht früher und nicht später. In Beispiel (3) wird die ZIP-Datei automatisch nur am 1. Juni 2014 abgeholt. Bitte lassen Sie die übermittelten Dateien im Ordner und löschen Sie sie nach erfolgreichem Hochladen und Verarbeiten nicht. Visiolink möchte die Dateien einige Zeit im Uploadverzeichnis des Kunden behalten, falls eine manuelle erneute Verarbeitung erforderlich wird.

Artikel- oder Seiten-IDs Durch die Verwendung von Identifikatoren in Dateinamen soll sichergestellt werden, dass Dateien desselben Datums einen eindeutigen Namen haben. Gleichzeitig soll die Duplizierung von Unterlagen vermieden werden, etwa bei unterschiedlichen Versionen eines Artikels, die entstehen, wenn ein Kunde mehrfache Exporte vom eigenen Publikationssystem aus durchführt.

Nach dem Abholen Alle Dateien, die erkennbar einem bestimmten Datum zugeordnet sind, werden automatisch in ein Arbeitsverzeichnis kopiert, wo sie – im Falle von ZIP-Archiven – entpackt und verarbeitet werden. So werden im Uploadordner des Kunden keine temporären Dateien generiert. Alle Dateien im Uploadverzeichnis eines Kunden, die älter als ein festgelegtes Datum sind – in der Regel zwei Wochen –, werden automatisch gelöscht.

Vom Kunden zu liefernde Informationen Diese Liste könnte zwar umfassender sein, doch auch wenn die folgenden Informationen in den XML-Dateien enthalten sind, wird es viel einfacher, die Importfunktion von Visiolink für den XMLFeed eines Kunden einzurichten. Visiolink benötigt für jeden Artikel grundsätzlich folgende Angaben:

Seitenzahl Hier gibt es zwei Möglichkeiten: •

ein fortlaufender Seitenzähler, bei dem jede Zahl für genau eine einzelne Seite der Gesamtausgabe verwendet wird. • Ein abschnittsspezifischer Seitenzähler, der jeden neuen physischen Abschnitt mit der Zahl 1 beginnt. Die Wahl der Zählmethode liegt bei Ihnen. Bitte stellen Sie auf jeden Fall sicher, dass für die gesamte Veröffentlichung ein einheitlicher Nummerierungsmodus verwendet wird, sei es bei einer regulären Ausgabe an Wochentagen mit nur zwei Abschnitten oder bei einer Wochenendausgabe mit zahlreichen Sonderabschnitten. Übermitteln Sie keine Veröffentlichungen mit gemischter fortlaufender und abschnittsspezifischer Nummerierung!

Abschnittsnummer oder Abschnittsidentifikator Der physische Abschnitt muss unbedingt identifiziert werden können, wenn eine Veröffentlichung mehr als einen Abschnitt enthält und eine abschnittsspezifische Seitennummerierung verwendet wird oder einzelne Abschnitte eine unterschiedliche Papiergröße haben. Geben sie möglichst für jeden Artikel in der Veröffentlichung eine Abschnittsnummer an. Sowohl die angegebene Abschnittsnummer als auch der abschnittsspezifische Seitenzähler werden zur Bestimmung der endgültigen Seitenzahl verwendet. Sollten Sie keine Abschnittsnummer angeben können, verwenden Sie bitte stattdessen einen anderen Abschnittsidentifikator. Visiolink wird die Abschnittsidentifikatoren dann während der Laufzeit in Zahlform umsetzen.

Kategorie Bitte integrieren Sie diese Angabe in die XML-Datei, sofern die Veröffentlichung Kategorien beinhaltet. Bei den meisten Zeitungen entsprechen die Kategorien logischen Abschnitten – sind jedoch nicht mit den physischen Abschnitten zu verwechseln. Mögliche Kategorien bzw. logische Abschnitte wären zum Beispiel „Sport“, „Regionalnachrichten“, „Feuilleton“ usw., wobei alle aber zu ein und demselben physischen Abschnitt gehören könnten. Visiolink verwendet Kategorien zur visuellen Gruppierung von Artikeln in der Artikellisten-Ansicht der endgültigen App.

Artikel-ID Mit der Artikel-ID wird jeder Artikel eindeutig identifiziert, damit zwei unterschiedliche Artikel innerhalb einer Veröffentlichung nie dieselbe ID haben. Wenn sich ferner ein Artikel über mehrere Seiten erstreckt und in Form einer XML-Datei pro Seite geliefert wird, dient die ID dazu, die zusammengehörenden Teile im Importprozess zu erkennen.

Titel/Schlagzeilen Sie können bis zu drei Titelebenen pro Artikel festlegen: einen Übertitel, eine Schlagzeile und einen Untertitel. In der App werden die Titel in dieser Reihenfolge angezeigt, und zwar mit einem Titel pro Zeile in jeweils unterschiedlicher Schriftgröße (Haupttitel mit größter Schrift).

Verfasserzeilen Name des Autors/der Autoren, gegebenenfalls mit Kontaktdaten, z. B. E-Mail-Adresse o. Ä.

Einleitende Absätze Sofern in der Ausgabe verwendet – beispielsweise ein Vorspann.

Fließtext-Absätze und Absatzüberschriften Lauftext des Artikels. Bitte stellen Sie sicher, dass der Lauftext vollständig und so strukturiert ist, wie er in der Textansicht der App erscheinen soll. Wenn also Absatzüberschriften verwendet werden, müssen sie so aufbereitet sein, dass sie sich klar von normalen Absätzen unterscheiden lassen, z. B. durch einen eigenen, spezifischen XML-Tag oder ein Attribut. Sorgen Sie außerdem dafür, dass der Lauftext keine unerwünschten Wiederholungen oder sonstigen, nicht zum Artikel gehörenden Inhalte enthält.

Infoboxen oder andere untergeordnete Artikelelemente Sie können einem Artikel beliebig viele Infoboxen oder andere untergeordnete Artikelelemente zuordnen. Sie müssen nur sicherstellen, dass jedes Element anhand eines eigenen Knotens erkennbar ist und vom Lauftext unterschieden werden kann. Innerhalb jedes untergeordneten Elements gelten die gleichen Regeln wie beim Lauftext.

Angaben zur Geometrie Mit diesen Daten wird bestimmt, an welcher Stelle ein Artikel auf der Seite platziert wird. Damit wird also errechnet, wo die Touchzonen in der Seitenansicht der App liegen sollen. Liefern Sie zu jedem Artikel bitte mindestens ein Viereck oder Polygon. Sie haben mehrere Möglichkeiten: • vier Koordinaten x1, y1, x2, y2, um ein Viereck durch die vier Ecken des Artikelbereichs zu beschreiben, • zwei Koordinaten x und y, mit denen der obere linke Ankerpunkt des Bereichs beschrieben wird, sowie zwei Parameter für Breite und Höhe zur Beschreibung der Maße des Vierecks. • Verwendung eines Konturpfads, mit dem der Artikelbereich polygonal in folgender Syntax beschrieben wird: x1, y1, x2, y2,... xn, yn, x1, y1. Dabei gelten folgende Bedingungen: - Jedes Paar xa, xa beschreibt einen Punkt a. - Jeder Punkt a+1 soll durch eine einzige vertikale oder horizontale Linie mit Punkt a verbunden werden. - n ist eine gerade Zahl größer oder gleich 4. - Der erste und der letzte Punkt sind identisch. • Mehrere Vierecke, z. B. einen pro Absatz. Visiolink empfiehlt, die Geometriedaten so differenziert wie möglich – entweder als Konturpfad oder in Form mehrerer Vierecke, die zu einem Polygon zusammengesetzt werden können – zu liefern. Wenn Polygone statt Rechtecke verwendet werden, ist die Gefahr einer Überschneidung mit Druckbereichen angrenzender Artikel geringer. Bitte teilen Sie Visiolink auf jeden Fall mit, in welcher Einheit die Geometrieangaben erstellt wurden (Punkte, dmmm usw.)

Informationen zu Bildern und Grafiken Bei der Übermittlung von Bildern und Grafiken für einer Veröffentlichung ist Einiges zu beachten, u. a. hinsichtlich der Benennung von Dateien, dem Pfad der Bilddatei, Bildtypen und der Skalierung und Beschneidung von Bildern. Liefern Sie zu den Bildern bitte jeweils einen Pfad und einen Dateinamen mit Bezug zum Stamm des Übermittlungsordners. Dann ist das Risiko geringer, dass ein falsches Bild ausgewählt wird. Visiolink bearbeitet Bilder und Grafiken zurzeit auf dieselbe Weise. Wenn Ihr Dokument also Grafiken enthält, müssen Sie diese nach denselben Regeln einfügen wie Bilder.

Vorhandensein, Referenzieren und Benennen von Bilddateien Für die korrekte Verarbeitung von Bildern aus dem XML-Feed eines Kunden muss jede Bilddatei in der XML-Datei referenziert sein. Ebenso muss für jede Referenz einer Bilddatei, die in den XMLDateien des Kunden enthalten ist, eine entsprechende Bilddatei in der Übermittlung vorhanden sein. In den Referenzen enthaltene Dateinamen und Dateipfade müssen die tatsächliche Position und den Namen der Dateien in Ihrer Übermittlung wiedergeben. Unreferenzierte Dateien werden ebenso wie referenzierte aber nicht vorhandene Dateien ignoriert. Jedes Bild muss einem Artikel zugeordnet sein. Stellen Sie daher bitte sicher, dass Bilddateien in einem eindeutigen, artikelspezifischen Kontext des XML-Baums referenziert sind. Es wird dringend empfohlen, eindeutige Dateinamen für Bilder zu verwenden, damit in der App keine doppelten oder falschen Bilder zu verschiedenen Artikeln angezeigt werden.

Bildtext/Bildunterschrift Integrieren Sie alle Textbestandteile, die mit dem Bild angezeigt werden sollen, in Ihren XML-Feed (z. B. Bildunterschriften oder Bildmetadaten, wie den Namen der/des Eigentümer(s) oder

Copyright-Hinweise).

Bildtyp Visiolink unterstützt zurzeit JPEG-Bilder. Stellen Sie daher sicher, dass dieses Format von Ihrem internen Dateiexport unterstützt wird oder führen Sie die erforderlichen Anpassungen durch, um die Bilder als JPEG-Dateien zu liefern.

Bildsortierung Wenn die Bilder zu den Artikeln in einer bestimmten Reihenfolge in der App sortiert sein sollen, muss jedes Bild über eine im Artikel referenzierte Sortiernummer verfügen. Dies kann hilfreich sein, wenn ein Artikel zwei oder mehr Bilder enthält.

Bildskalierung und -beschneidung Die an den FTP-Server gelieferten Bilder werden automatisch skaliert, damit ihre Größe zu den verschiedenen Ausgabegeräten passt. Visiolink verwendet keine Bilder in Originalgröße, da das Laden umfangreiche Geräteressourcen und Bandbreiten beansprucht. Visiolink sorgt aber dafür, dass die Bildqualität bei der Anzeige der Bilder auf unterschiedlichen Geräten nicht beeinträchtigt wird. Visiolink beschneidet keine Bilder, die in Ihrem Redaktionssystem beschnitten werden können. Wird ein Originalbild übermittelt, wird es in der Form verwendet und skaliert. Soll nur ein Teil eines Bildes verwendet werden, liefern Sie bitte nur den entsprechenden Teil des Bildes.

Checkliste Enthalten: Element: Seitenzahl Abschnittsnummer/identifikator Kategorie Artikel-ID Schlagzeile Verfasserzeile(n) Einl. Absätze Lauftext Infobox(en) Angaben zur Geometrie Bilder Bildreferenz Bildtext/-unterschrift Bild-Copyright Bildsortierung

Zu verwendender Pfad oder Element/Attribut:

Beispiele Nachfolgend sehen Sie einige Beispiele für XML-Dateistrukturen verschiedener Redaktionssysteme. Dies soll für Sie als Anregung für den XML-Export dienen. Gerne können Sie Ihren eigenen XML-Export mit diesen Beispielen vergleichen. Wenn Sie aber der oben beschriebenen Checkliste folgen und sicherstellen, dass alle Elemente in Ihrem Export enthalten sind, können Sie diese Beispiele auch einfach überspringen.