added docs

docs/index_de.md

@@ -0,0 +1,71 @@
+---
+title: Vorgangserstellung durch Dateiupload
+identifier: intranda_workflow_fileUploadProcessCreation
+description: Dies ist ein Goobi workflow Plugin für den Upload von mehreren Dateien, um eine automatische Vorgangserstellung auf Basis der hochgeladenen Dateien zu ermöglichen. Aus Dateien mit ähnlichen Namen werd
+published: true
+---
+## Einführung
+Dieses Workflow-Plugin erlaubt einen Massenupload von Dateien, auf deren Basis automatisch Goobi-Vorgänge erzeugt werden. Die zu verwendende Produktionsvorlage kann hierbei ebenso wie der zu erzeugende Publikationstyp über eine Konfiguration festgelegt werden. Zusammengehörige Dateien werden nach dem Erzeugen des Vorgangs automatisch zugewiesen.
+
+
+## Installation
+Zur Installation des Plugins müssen folgende beiden Dateien installiert werden:
+
+```bash
+/opt/digiverso/goobi/plugins/workflow/plugin-intranda-workflow-fileUploadProcessCreation-base.jar
+/opt/digiverso/goobi/plugins/GUI/plugin-intranda-workflow-fileUploadProcessCreation-gui.jar
+```
+
+Um zu konfigurieren, wie sich das Plugin verhalten soll, können verschiedene Werte in der Konfigurationsdatei angepasst werden. Die Konfigurationsdatei befindet sich üblicherweise hier:
+
+```bash
+/opt/digiverso/goobi/config/plugin_intranda_workflow_fileUploadProcessCreation.xml
+```
+
+
+## Überblick und Funktionsweise
+Für eine Nutzung dieses Plugins muss der Nutzer über die korrekte Rollenberechtigung verfügen.
+
+![Ohne korrekte Berechtigung ist das Plugin nicht nutzbar](screen1_de.png)
+
+Bitte weisen Sie daher der Gruppe die Rolle `Plugin_Goobi_Massupload` zu.
+
+![Korrekt zugewiesene Rolle für die Nutzer](screen2_de.png)
+
+
+Wenn das Plugin korrekt installiert und konfiguriert wurde, ist es innerhalb des Menüpunkts `Workflow` zu finden.
+
+![Geöffnetes Plugin für den Upload](screen3_de.png)
+
+An dieser Stellen können nun Dateien hochgeladen werden. Nach der Analyse der Dateinamen erzeugt Goobi die entsprechenden Vorgänge automatisch.
+
+
+## Konfiguration
+Der Inhalt dieser Konfigurationsdatei sieht wie folgt aus:
+
+```xml
+<config_plugin>
+
+    <!-- which file types shall be allowed for uploading these -->
+    <allowed-file-extensions>/(\.|\/)(gif|jpe?g|png|tiff?|jp2|pdf)$/</allowed-file-extensions>
+
+    <!-- which process template shall be used to create the new processes -->
+    <processTemplateName>ImportWorkflow</processTemplateName>
+
+    <!-- which publication type shall be used inside of the created METS files -->
+    <metadataDocumentType>Monograph</metadataDocumentType>
+
+    <!-- define a naming schema for the file names to be matched for the process creation -->
+    <namingSchema>/.*(BA_\\d+[_-](\\d+)).*\\.jpg/</namingSchema>
+
+</config_plugin>
+```
+
+Die Konfiguration des Plugins gestaltet sich wie folgt:
+
+| Wert | Beschreibung |
+| :--- | :--- |
+| `allowed-file-extensions` | Mit diesem Parameter wird festgelegt, welche Datein hochgeladen werden dürfen. Hierbei handelt es sich um einen regulären Ausdruck. |
+| `processTemplateName` | Mit diesem Parameter kann definiert werden, welche Produktionsvorlage für die zu erzeugenden Vorgänge verwendet werden sollen. |
+| `metadataDocumentType` | Legen Sie hiermit fest, welcher Publikationstyp innerhalb der METS-Datei verwendet werden soll für die neu zu erzeugenden Vorgänge. |
+| `namingSchema` | Definieren Sie hier einen regulären Ausdruck, der auf das Benennungsschema der hochgeladenen Dateien zutreffen soll. Dieser ist maßgeblich für die Erzeugung der Vorgänge sowie die Zusammengehörigkeit der Bilder zu den Vorgängen. |

docs/index_en.md

@@ -0,0 +1,70 @@
+---
+title: Process creation through file upload
+identifier: intranda_workflow_fileUploadProcessCreation
+description: This is a Goobi workflow plugin for the upload of multiple files to allow an automatic process creation based on the the uploaded files. Files with similar names are used to create basic Goobi process
+published: true
+---
+## Introduction
+This workflow plugin allows a mass upload of files on the basis of which Goobi processes are automatically generated. The process template to be used as well as the publication type to be created can be defined via a configuration. Files that belong together are automatically assigned after the process has been created.
+
+
+## Installation
+To install the plugin, the following two files must be installed:
+
+```bash
+/opt/digiverso/goobi/plugins/workflow/plugin-intranda-workflow-fileUploadProcessCreation-base.jar
+/opt/digiverso/goobi/plugins/GUI/plugin-intranda-workflow-fileUploadProcessCreation-gui.jar
+```
+
+To configure how the plugin should behave, various values can be adjusted in the configuration file. The configuration file is usually located here:
+
+```bash
+/opt/digiverso/goobi/config/plugin_intranda_workflow_fileUploadProcessCreation.xml
+```
+
+
+## Overview and functionality
+To use this plugin, the user must have the correct role authorisation.
+
+![The plugin cannot be used without correct authorisation](screen1_en.png)
+
+Therefore, please assign the role `Plugin_Goobi_Massupload` to the group.
+
+![Correctly assigned role for users](screen2_en.png)
+
+If the plugin has been installed and configured correctly, it can be found within the menu item `Workflow`.
+
+![Opened plugin for the upload](screen3_en.png)
+
+Files can now be uploaded at this point. After analysing the file names, Goobi automatically creates the corresponding processes.
+
+
+## Configuration
+The content of the configuration file looks like this:
+
+```xml
+<config_plugin>
+
+    <!-- which file types shall be allowed for uploading these -->
+    <allowed-file-extensions>/(\.|\/)(gif|jpe?g|png|tiff?|jp2|pdf)$/</allowed-file-extensions>
+
+    <!-- which process template shall be used to create the new processes -->
+    <processTemplateName>ImportWorkflow</processTemplateName>
+
+    <!-- which publication type shall be used inside of the created METS files -->
+    <metadataDocumentType>Monograph</metadataDocumentType>
+
+    <!-- define a naming schema for the file names to be matched for the process creation -->
+    <namingSchema>/.*(BA_\\d+[_-](\\d+)).*\\.jpg/</namingSchema>
+
+</config_plugin>
+```
+
+The configuration of the plugin is as follows:
+
+| Value | Description |
+| :--- | :--- |
+| `allowed-file-extensions` | This parameter defines which files may be uploaded. This is a regular expression. |
+| `processTemplateName` | This parameter can be used to define which process template is to be used for the processes to be created. |
+| `metadataDocumentType` | Use this to specify which publication type is to be used within the METS file for the new processes to be created. |
+| `namingSchema` | Define a regular expression here that should apply to the naming scheme of the uploaded files. This is decisive for the creation of the processes and the association of the images to the processes. |