An dieser Stelle entsteht die öffentliche Dokumentation für Epigraf 5. Diese Seite ist noch in Bearbeitung.

Downloadformate

Nahezu alle Seiten und Listen können in EpiWeb in drei verschiedenen Formaten abgefragt werden:

Der XML-Export umfasst alle Inhalte einer Seite und ist hierarchisch strukturiert. Beispielsweise enthalten Artikel-Elemente alle Abschnitte.
Der JSON-Export ist wie eine XML-Datei hierarchisch strukturiert, in der Regel aber kompakter und für weitere Anwendungen leichter zu verarbeiten.
Der CSV-Export erzeugt eine Tabelle, die mit einer Tabellen-Kalkulation oder einem Text-Editor weiter bearbeitet werden kann. Die hierarchische Struktur wird durch Verknüpfungen zwischen den einzelnen abgebildet.

Dazu stehen auf den Seiten Buttons bereit. Alternativ kann die im Browser angezeigte URL so abgewandelt werden, dass der Pfad mit dem Dateiformat endet (.xml, .json, .csv).

Exportmöglichkeiten

Darüber hinaus können mit Epigraf-Pipelines zum Beispiel Word-Dateien oder TEI-Dokument erstellt werden. Unter jedem einzelnen Artikel und auch unter der Artikeltabelle steht dafür die Schaltfläche Exportieren zur Verfügung. Um beispielsweise ein ganzes Projekt zu exportieren, werden in der Artikeltabelle zunächst alle benötigten Filter eingestellt - das heißt, die Liste wird auf ein bestimmtes Projekt eingegrenzt.

Anschließend wird die Pipeline ausgewählt, die für das Erstellen des Exportdokuments verwendet werden soll. Verschiedene Pipelines erzeugen verschiedene Exportdokumente. Es kann beispielsweise eine Pipeline zum Erstellen von Druckvorlagen und eine andere Pipeline zum Erstellen von XML-Dokumenten eingerichtet werden. Einige Pipelines sehen zusätzliche Optionen vor, die beim Exportieren ausgewählt werden.

Ausgangspunkt der Pipelines sind XML-Dokumente wie sie auch über den XML-Button auf den Artikelseiten abgerufen werden können. Die Daten werden zunächst zusammengestellt und dann mithilfe von XSL in das gewünschte Format transformiert. Um die ursprüngliche Datenstruktur zu sehen, kann die Rohdaten-Pipeline verwendet werden.

Die zur Transformation der Rohdaten benötigten XSL-Dateien sind im Repositorium im pipelines-Ordner abgelegt und werden beim Erstellen einer Pipeline eingebunden. Für komplexere Ausgabeformate - wie DOC- oder ODT-Dateien - können mehrere Transformationsschritte nacheinander abgearbeitet werden.

Aufbau von Pipelines

Pipelines enthalten eine Abfolge von Aufgaben, mit denen die Ausgangsdaten in das Zielformat überführt werden. Grundlegend lassen sich drei Aufgabentypen unterscheiden:

Datenabfrage: Eine Pipeline beginnt damit, Artikeldaten und weitere Daten abzufragen und in XML-Dateien abzulegen.
Datenaufbereitung: Die verschiedenen Dateien werden in einer gemeinsamen Datei oder in einem Ordner zusammengeführt.
Transformationen: Die Ausgangsdatei wird mit XSL-T-Stylesheets in das Zielformat umgeformt.
Datenausgabe: Die Dateien werden für den Download vorbereitet.

1. Datenabfrage

1.1 Aufgabe Options

to be added

1.2 Aufgabe Job parameters

to be added

1.3 Aufgabe Project data

to be added

1.4 Aufgabe Article data

Beim Exportieren werden die Parameter der ausgewählten Artikel an die Pipeline übergeben. In einem Task kann dann die Auswahl der Artikel weiter eingeschränkt werden:

Article types: Es werden in diesem Task nur bestimmte Artikeltypen ausgegeben, zum Beispiel "epi-article".
All articles in selected projects: Es werden auch Artikel ausgegeben, die nicht direkt ausgewählt wurden, aber im Projekt enthalten sind. In diesem Fall sollte unbedingt der Artikeltyp eingeschränkt werden, da sonst alle Artikel eines Projekts exportiert werden. Diese Option wird im Inschriftenprojekt für die gemeinsame Ausgabe von Bandartikeln mit Katalogartikeln verwendet.

1.5 Aufgabe Index data

to be added

2. Datenaufbereitung

2.1 Aufgabe Bundle files

to be added

2.2 Aufgabe Copy files

Copy files to the job folder. Can be used, for example, to copy a template for odt-files.

3. Transformationen

3.1 Transform with XSL

to be added

3.2 Search and replace

to be added

4. Datenausgabe

4.1 Aufgabe Zip a file or folder

to be added

4.2 Aufgabe Save to file

to be added

Datenformate

Als Kodierung wird UTF-8 verwendet, wobei nicht-sichtbare Zeichen ausgefiltert werden. Dadurch wird zum Beispiel das Steuerzeichen Unit Separator ausgefiltert.