added docs

docs/index_de.md

@@ -0,0 +1,83 @@
+---
+title: Elektronische Publikationen
+identifier: intranda_step_pdfUpload
+published: true
+description: Dies ist die technische Dokumentation für das Goobi-Plugin zur Integration von elektronischen Publikationen.
+---
+## Einführung
+Die vorliegende Dokumentation beschreibt die Installation, Konfiguration und den Einsatz eines Plugins zum Upload von Dokumenten in Goobi. Mit Hilfe dieses Plugins können born-digital-Dokumente wie beispielsweise PDF-Dateien direkt in Goobi hochgeladen und verwaltet werden.
+
+
+## Installation und Konfiguration
+Zur Nutzung des Plugins müssen folgende drei Dateien installiert werden:
+
+```bash
+/opt/digiverso/goobi/plugins/step/plugin_intranda_step_pdfUpload-base.jar
+/opt/digiverso/goobi/plugins/GUI/plugin_intranda_step_pdfUpload-gui.jar
+/opt/digiverso/goobi/config/plugin_PdfUploadPlugin.xml
+```
+
+Die erste Datei enthält die eigentliche Programmlogik, die zweite Datei stellt die grafische Oberfläche für die Anzeige zur Verfügung und die dritte Datei dient zur Konfiguration des Plugins.
+
+Der Inhalt der Konfigurationsdatei `plugin_PdfUploadPlugin.xml` muss folgendermaßen aufgebaut sein:
+
+```xml
+<config_plugin>
+ <!-- allowed values: master, source, derivate -->
+    <folder>derivate</folder>
+    <extensions>
+        <extension>pdf</extension>
+        <extension>PDF</extension>
+    </extensions>
+</config_plugin>
+```
+
+In `<folder>` wird festgelegt, in welchem Ordner die hochgeladenen Dateien gespeichert werden. Dabei können die Werte `master`, `source` und `derivate` verwendet werden.
+
+Anschließend müssen noch die erlaubten Dateiendungen konfiguriert werden. Hierbei muss darauf geachtet werden, dass die Überprüfung case sensitive ist. Will man Groß- und Kleinschreibung erlauben, müssen beide Schreibweisen definiert werden.
+
+
+## Überblick und Funktionsweise
+Nachdem das Plugin installiert und konfiguriert wurde, kann es innerhalb der neuen Benutzeroberfläche von Goobi genutzt werden.
+
+Dazu muss innerhalb der gewünschten Aufgabe das Plugin für den Arbeitsschritt `intranda_step_pdfUpload` eingetragen werden.
+
+![Abbildung 1: Task-Details](screen1.png)
+
+Wurde der entsprechende Arbeitsschritt durch den jeweiligen Nutzer geöffnet, innerhalb dem das Plugin konfiguriert wurde, steht ein neuer Bereich zum Hochladen von Dateien zur Verfügung.
+
+![Abbildung 2: Upload-Plugin](screen2.png)
+
+Mittels des Buttons `Datei auswählen` kann nun eine Datei gewählt werden, die anschließend mit dem Button `Datei hochladen` zum Server übertragen wird. Dabei kann optional ein Kommentar angegeben werden.
+
+Die hochgeladene Datei wird anschließend mit einigen Informationen aufgelistet. Dort gibt es auch die Möglichkeit, die Datei wieder zu löschen.
+
+![Abbildung 3: Hochgeladene Dateien](screen3.png)
+
+Es werden nur Dateien akzeptiert, deren Dateiendung zuvor in der Liste der erlaubten Endungen eingetragen wurde. Außerdem darf der Dateiname nur aus den Zeichen `A-Za-z0-9äöüß-_` bestehen. `Leerzeichen` werden automatisch durch `Unterstriche` ersetzt.
+
+Wird eine Datei hochgeladen, werden die Informationen dazu in der METS Datei gespeichert.
+
+```xml
+<mets:fileGrp USE="LOCAL">
+    <mets:file ID="FILE_0001" MIMETYPE="">
+        <mets:FLocat LOCTYPE="URL"
+ xlink:href="/opt/digiverso/goobi/metadata/6212/images/myFolder/AC03719978.pdf"
+ xmlns:xlink="http://www.w3.org/1999/xlink" />
+    </mets:file>
+</mets:fileGrp>
+
+[...]
+
+<mets:structMap TYPE="PHYSICAL">
+    <mets:div DMDID="DMDPHYS_0000" ID="PHYS_0000" TYPE="BoundBook">
+        <mets:div ID="PHYS_0001" ORDER="1" TYPE="page" ORDERLABEL="Kommentar">
+            <mets:fptr FILEID="FILE_0001" />
+        </mets:div>
+    </mets:div>
+</mets:structMap>
+```
+
+Durch das Übernehmen in die METS-Datei ist sichergestellt, dass die Reihenfolge der hochgeladenen Dateien persistent gespeichert wird.
+
+Wird die Aufgabe anschließend erneut geöffnet, werden die Informationen zu den hochgeladenen Dateien aus der METS-Datei entnommen und ebenfalls angezeigt.

docs/index_en.md

@@ -0,0 +1,84 @@
+---
+title: Electronic Publications
+identifier: intranda_step_pdfUpload
+published: true
+description: This is the technical documentation for the Goobi plugin for integrating
+  electronic publications.
+---
+## Introduction
+This documentation describes how to install, configure and use a plug-in to upload documents to Goobi. With the help of this plug-in, born-digital documents such as PDF files can be uploaded and managed directly in Goobi.
+
+
+## Installation and Configuration
+The following three files must be installed to use the plugin:
+
+```bash
+/opt/digiverso/goobi/plugins/step/plugin_intranda_step_pdfUpload-base.jar
+/opt/digiverso/goobi/plugins/GUI/plugin_intranda_step_pdfUpload-gui.jar
+/opt/digiverso/goobi/config/plugin_PdfUploadPlugin.xml
+```
+
+The first file contains the actual program logic, the second file provides the graphical user interface for the display and the third file is used to configure the plugin.
+
+The content of the configuration file `plugin_PdfUploadPlugin.xml` must be structured as follows:
+
+```xml
+<config_plugin>
+ <!-- allowed values: master, source, derivate -->
+    <folder>derivate</folder>
+    <extensions>
+        <extension>pdf</extension>
+        <extension>PDF</extension>
+    </extensions>
+</config_plugin>
+```
+
+`folder` specifies the folder in which the uploaded files are stored. The values `master`, `source` and `derivate` can be used. Afterwards the allowed file extensions have to be configured. Please make sure that the check is case sensitive. If you want to allow upper and lower case, both spellings must be defined.
+
+Then the allowed file extensions have to be configured. Here you have to make sure that the check is case sensitive. If you want to allow upper and lower case, both spellings must be defined.
+
+
+## Overview and functionality
+Once the plugin has been installed and configured, it can be used within Goobi's new user interface.
+
+To do this, the plugin for the `intranda_step_pdfUpload` step must be entered within the desired task.
+
+![Figure 1: Task-Details](screen1.png)
+
+If the corresponding step has been opened by the respective user within which the plugin was configured, a new area for uploading files is available.
+
+![Figure 2: Upload-Plugin](screen2.png)
+
+Using the `Select file` button, you can now select a file which is then transferred to the server using the `Upload file` button. You can optionally enter a comment.
+
+The uploaded file is then listed with some information. There you can also delete the file.
+
+![Figure 3: Uploaded files](screen3.png)
+
+Only files whose file extension was previously entered in the list of permitted extensions are accepted. In addition, the file name may only consist of the characters `A-Za-z0-9äöüß-_`. `Spaces` are automatically replaced by `underscores`.
+
+If a file is uploaded, the information is stored in the METS file.
+
+```xml
+<mets:fileGrp USE="LOCAL">
+    <mets:file ID="FILE_0001" MIMETYPE="">
+        <mets:FLocat LOCTYPE="URL"
+ xlink:href="/opt/digiverso/goobi/metadata/6212/images/myFolder/AC03719978.pdf"
+ xmlns:xlink="http://www.w3.org/1999/xlink" />
+    </mets:file>
+</mets:fileGrp>
+
+[...]
+
+<mets:structMap TYPE="PHYSICAL">
+    <mets:div DMDID="DMDPHYS_0000" ID="PHYS_0000" TYPE="BoundBook">
+        <mets:div ID="PHYS_0001" ORDER="1" TYPE="page" ORDERLABEL="Kommentar">
+            <mets:fptr FILEID="FILE_0001" />
+        </mets:div>
+    </mets:div>
+</mets:structMap>
+```
+
+The transfer to the METS file ensures that the order of the uploaded files is saved persistently.
+
+If the task is then opened again, the information about the uploaded files is taken from the METS file and also displayed.