Added documentation

docs/index_de.md

@@ -0,0 +1,147 @@
+---
+title: Individueller Export für das DMS Imagen Media Archive Management
+identifier: intranda_export_adm_bsme
+description: Export Plugin für Goobi workflow zum Erzeugen spezieller Exportformate in die Software Imagen Media Archive Management
+published: true
+---
+
+## Einführung
+Die vorliegende Dokumentation beschreibt die Installation, Konfiguration und den Einsatz des Export-Plugins für die Erzeugung spezieller Exportpakete für die Software Imagen Media Archive Management. Innerhalb des Plugins werden hierbei derzeit 5 spezielle Publikationstypen berücksichtigt und jeweils individuell verarbeitet.
+
+## Installation
+Um das Plugin nutzen zu können, müssen folgende Dateien installiert werden:
+
+```bash
+/opt/digiverso/goobi/plugins/export/plugin-export-adm-bsme-base.jar
+/opt/digiverso/goobi/config/plugin_intranda_export_adm_bsme.xml
+```
+
+Nach der Installation des Plugins kann dieses innerhalb des Workflows für die jeweiligen Arbeitsschritte ausgewählt und somit automatisch ausgeführt werden. Ein Workflow könnte dabei beispielhaft wie folgt aussehen:
+
+![Beispielhafter Aufbau eines Workflows](screen1_de.png)
+
+Für die Verwendung des Plugins muss dieses in einem Arbeitsschritt ausgewählt sein:
+
+![Konfiguration des Arbeitsschritts für den Export](screen2_de.png)
+
+
+## Überblick und Funktionsweise
+Dieses Plugin wird innerhalb des Workflows automatisch als Export-Plugin ausgeführt und erzeugt innerhalb eines konfigurierten Verzeichnisses die jeweils benötigten Daten. Dabei handelt es sich je nach Publikationstyp um:
+
+- Bilddateien
+- Plaintext-Dateien mit OCR-Ergebnissen
+- ALTO-Dateien mit OCR-Ergebnissen
+- METS-Dateien
+- METS-Anchor-Dateien
+- XML-Export-Dateien
+
+![Beispielhafter Einblick in ein Exportverzeichnis für mehrere Publikationstypen](screen3.png)
+
+Insbesondere der Aufbau der XML-Export-Dateien ist je nach Publikationstyp sehr unterschiedlich. Hier einmal ein Beispiel für ein `Generic Print`-Publikationstyp:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<image>
+  <ImageInfo>
+    <Rights_to_Use>Yes</Rights_to_Use>
+    <Right_Details>ADMN</Right_Details>
+    <Media_Source>Goobi</Media_Source>
+    <Media_Type>Image</Media_Type>
+    <Publication_Name>الاتحاد - Al Ittihad</Publication_Name>
+    <Source_Organization>Source Organization information</Source_Organization>
+    <Barcode>123456789</Barcode>
+    <Subject>Subject information</Subject>
+    <Event_Date>2024-04-10</Event_Date>
+    <Event_Name>Event Name information</Event_Name>
+    <Photographer>Photographer information</Photographer>
+    <Format>35mm</Format>
+    <Persons_in_Image>Persons in Image information</Persons_in_Image>
+    <location>Event Locations information</location>
+    <Description>Description information</Description>
+    <Backprint>Backprint information</Backprint>
+    <Technical_Notes />
+  </ImageInfo>
+  <Files>
+    <master>
+      <Format>image/tiff</Format>
+      <ResolutionUnit>PPI</ResolutionUnit>
+      <Resolution>200.0</Resolution>
+      <BitDepth>8</BitDepth>
+      <ColorSpace>color</ColorSpace>
+      <ScanningDevice>Bookeye 5</ScanningDevice>
+      <ScanningDeviceID>- no serial number available -</ScanningDeviceID>
+      <Width>1272</Width>
+      <Height>1680</Height>
+      <file>123456789-0001.tif</file>
+    </master>
+    <master>
+      <Format>image/tiff</Format>
+      <ResolutionUnit>PPI</ResolutionUnit>
+      <Resolution>200.0</Resolution>
+      <BitDepth>8</BitDepth>
+      <ColorSpace>color</ColorSpace>
+      <ScanningDevice>Bookeye 5</ScanningDevice>
+      <ScanningDeviceID>- no serial number available -</ScanningDeviceID>
+      <Width>1272</Width>
+      <Height>1680</Height>
+      <file>123456789-0002.tif</file>
+    </master>
+    <text Format="text/plain">123456789-0002.txt</text>
+    <master>
+      <Format>image/tiff</Format>
+      <ResolutionUnit>PPI</ResolutionUnit>
+      <Resolution>200.0</Resolution>
+      <BitDepth>8</BitDepth>
+      <ColorSpace>color</ColorSpace>
+      <ScanningDevice>Bookeye 5</ScanningDevice>
+      <ScanningDeviceID>- no serial number available -</ScanningDeviceID>
+      <Width>1192</Width>
+      <Height>1608</Height>
+      <file>123456789-0003.tif</file>
+    </master>
+    <text Format="text/plain">123456789-0003.txt</text>
+  </Files>
+</image>
+```
+
+## Konfiguration
+Die Konfiguration des Plugins erfolgt in der Datei `plugin_intranda_export_adm_bsme.xml` wie hier aufgezeigt:
+
+{{CONFIG_CONTENT}}
+
+Die darin verwendeten Parameter werden hier detailliert: 
+
+Parameter                   | Erläuterung
+----------------------------|----------------------------------------
+`targetDirectoryNewspapers` | Zielverzeichnis für Zeitungen
+`targetDirectoryMagazines`  | Zielverzeichnis für Zeitschriften
+`targetDirectoryPositives`  | Zielverzeichnis für Positives
+`targetDirectoryNegatives`  | Zielverzeichnis für Negative
+`targetDirectorySlides`     | Zielverzeichnis für Slides
+`targetDirectoryGeneric`    | Zielverzeichnis für Generic Prints
+`pdfCopyNewspapers`         | Zielverzeichnis zur Generierung von PDF-Dateien für Zeitungen
+`pdfCopyMagazines`          | Zielverzeichnis zur Generierung von PDF-Dateien für Zeitschriften
+`viewerUrl`                 | URL für den Goobi viewer
+`rightsToUse`               | Angabe von Nutzungsrechten
+`rightsDetails`             | Details über die Nutzungsrechte
+`source`                    | Angabe der Quelle der Digitalisate
+`mediaType`                 | Typ der Medien
+`sourceOrganisation`        | Organisation, die für die Inhalte verantwortlich ist
+`frequency`                 | Erscheinungshäufigkeit
+`eventName`                 | Nennung des dokumentierten Ereignisses
+`eventDate`                 | Angabe des Datums, wann das Ereignis stattfand
+`eventTime`                 | Angabe des Uhrzeit, wann das Ereignis stattfand
+`subject`                   | Allgemeine Schlagworte
+`subjectArabic`             | Angabe der Schlagworte in Arabisch
+`subjectEnglish`            | Angabe der Schlagworte in Englisch
+`photographer`              | Informationen zum Fotografen des Bildes
+`personsInImage`            | Abgebildete Personen im Bild
+`locations`                 | Angabe zum Ort der Aufnahme
+`description`               | Erläuterungen und Beschreibungen zur Aufnahme
+`editorInChief`             | Verantwortlicher Herausgeber
+`format`                    | Formatinformationen
+`envelopeNumber`            | Identifier des Umschlags, in dem die Dokumente aufbewahrt werden
+`backprint`                 | Informationen über Inhalte auf der Rückseite
+
+
+Für eine einfachere Inbetriebnahme befindet sich in `install`-Ordner des Plugins einn Verzeichnis mit den zwei passende Regelsätze als Referenz, die zu der hier aufgeführte Konfigurationsdatei passen.

docs/index_en.md

@@ -0,0 +1,147 @@
+---
+title: Customised export for the DMS Imagen Media Archive Management
+identifier: intranda_export_adm_bsme
+description: Export plugin for Goobi workflow to create special export formats in the software Imagen Media Archive Management
+published: true
+---
+
+## Introduction
+This documentation describes the installation, configuration and use of the export plugin for the creation of special export packages for the Imagen Media Archive Management software. Within the plugin, 5 special publication types are currently taken into account and processed individually.
+
+## Installation
+To be able to use the plugin, the following files must be installed:
+
+```bash
+/opt/digiverso/goobi/plugins/export/plugin-export-adm-bsme-base.jar
+/opt/digiverso/goobi/config/plugin_intranda_export_adm_bsme.xml
+```
+
+Once the plugin has been installed, it can be selected within the workflow for the respective work steps and thus executed automatically. A workflow could look like the following example:
+
+![Example of a workflow structure](screen1_en.png)
+
+To use the plugin, it must be selected in one step:
+
+![Configuration of the work step for the export](screen2_en.png)
+
+
+## Overview and functionality
+This plugin is automatically executed as an export plugin within the workflow and generates the required data within a configured directory. Depending on the publication type, these are
+
+- Image files
+- Plain text files with OCR results
+- ALTO files with OCR results
+- METS files
+- METS anchor files
+- XML export files
+
+![Exemplary insight into an export directory for several publication types](screen3.png)
+
+The structure of the XML export files in particular varies greatly depending on the publication type. Here is an example of a `Generic Print` publication type:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<image>
+  <ImageInfo>
+    <Rights_to_Use>Yes</Rights_to_Use>
+    <Right_Details>ADMN</Right_Details>
+    <Media_Source>Goobi</Media_Source>
+    <Media_Type>Image</Media_Type>
+    <Publication_Name>الاتحاد - Al Ittihad</Publication_Name>
+    <Source_Organization>Source Organization information</Source_Organization>
+    <Barcode>123456789</Barcode>
+    <Subject>Subject information</Subject>
+    <Event_Date>2024-04-10</Event_Date>
+    <Event_Name>Event Name information</Event_Name>
+    <Photographer>Photographer information</Photographer>
+    <Format>35mm</Format>
+    <Persons_in_Image>Persons in Image information</Persons_in_Image>
+    <location>Event Locations information</location>
+    <Description>Description information</Description>
+    <Backprint>Backprint information</Backprint>
+    <Technical_Notes />
+  </ImageInfo>
+  <Files>
+    <master>
+      <Format>image/tiff</Format>
+      <ResolutionUnit>PPI</ResolutionUnit>
+      <Resolution>200.0</Resolution>
+      <BitDepth>8</BitDepth>
+      <ColorSpace>color</ColorSpace>
+      <ScanningDevice>Bookeye 5</ScanningDevice>
+      <ScanningDeviceID>- no serial number available -</ScanningDeviceID>
+      <Width>1272</Width>
+      <Height>1680</Height>
+      <file>123456789-0001.tif</file>
+    </master>
+    <master>
+      <Format>image/tiff</Format>
+      <ResolutionUnit>PPI</ResolutionUnit>
+      <Resolution>200.0</Resolution>
+      <BitDepth>8</BitDepth>
+      <ColorSpace>color</ColorSpace>
+      <ScanningDevice>Bookeye 5</ScanningDevice>
+      <ScanningDeviceID>- no serial number available -</ScanningDeviceID>
+      <Width>1272</Width>
+      <Height>1680</Height>
+      <file>123456789-0002.tif</file>
+    </master>
+    <text Format="text/plain">123456789-0002.txt</text>
+    <master>
+      <Format>image/tiff</Format>
+      <ResolutionUnit>PPI</ResolutionUnit>
+      <Resolution>200.0</Resolution>
+      <BitDepth>8</BitDepth>
+      <ColorSpace>color</ColorSpace>
+      <ScanningDevice>Bookeye 5</ScanningDevice>
+      <ScanningDeviceID>- no serial number available -</ScanningDeviceID>
+      <Width>1192</Width>
+      <Height>1608</Height>
+      <file>123456789-0003.tif</file>
+    </master>
+    <text Format="text/plain">123456789-0003.txt</text>
+  </Files>
+</image>
+```
+
+## Configuration
+The plugin is configured in the file `plugin_intranda_export_adm_bsme.xml` as shown here:
+
+{{CONFIG_CONTENT}}
+
+The parameters used are detailed here: 
+
+Parameter                   | Explanation
+----------------------------|----------------------------------------
+`targetDirectoryNewspapers` | Target directory for Newspapers
+`targetDirectoryMagazines`  | Target directory for Magazines
+`targetDirectoryPositives`  | Target directory for Positives
+`targetDirectoryNegatives`  | Destination directory for Negatives
+`targetDirectorySlides`     | Target directory for Slides
+`targetDirectoryGeneric`    | Target directory for Generic Prints
+`pdfCopyNewspapers`         | Target directory for generating PDF files for Newspapers
+`pdfCopyMagazines`          | Target directory for generating PDF files for Magazines
+`viewerUrl`                 | URL for the Goobi viewer
+`rightsToUse`               | Indication of rights of use
+`rightsDetails`             | Details about the rights of use
+`source`                    | Indication of the source of the digitised material
+`mediaType`                 | Type of media
+`sourceOrganisation`        | Organisation responsible for the content
+`frequency`                 | Frequency of publication
+`eventName`                 | Naming the documented event
+`eventDate`                 | Indication of the date when the event took place
+`eventTime`                 | Indication of the time when the event took place
+`subject`                   | General keywords
+`subjectArabic`             | Indication of keywords in Arabic
+`subjectEnglish`            | Specification of keywords in English
+`photographer`              | Information about the photographer of the picture
+`personsInImage`            | People shown in the picture
+`locations`                 | Information on the location of the recording
+`description`               | Explanations and descriptions of the recording
+`editorInChief`             | Responsible Editor
+`format`                    | Format information
+`envelopeNumber`            | Identifier of the envelope in which the documents are stored
+`backprint`                 | Information about contents on the back
+
+
+Für eine einfachere Inbetriebnahme befindet sich in `install`-Ordner des Plugins einn Verzeichnis mit den zwei passende Regelsätze als Referenz, die zu der hier aufgeführte Konfigurationsdatei passen.