added docs

docs/index_de.md

@@ -0,0 +1,83 @@
+---
+title: OCR-Durchführung mit gemischten Schrifttypen
+identifier: intranda_step_mixedocr
+published: true
+description: Dies ist die technische Dokumentation für das Goobi-Plugin zur Durchführung von OCR mit gemischten Schrifttypen. Die Markierung der Bilder sollte mit dem Plugin "OCR Seitenauswahl" erfolgen.
+---
+## Einführung
+Die vorliegende Dokumentation beschreibt die Installation, Konfiguration und den Einsatz eines Plugins zur OCR-Durchführung mit gemischten Schrifttypen. Dieses Plugin ist nur in Zusammenarbeit mit dem Plugin ["OCR Seitenauswahl"](intranda_step_ocrselector.md) nützlich.
+
+
+## Installation und Konfiguration
+Zur Nutzung des Plugins müssen folgende Dateien installiert sein:
+
+```bash
+/opt/digiverso/goobi/plugins/step/plugin_intranda_step_mixedocr-base.jar
+/opt/digiverso/goobi/config/plugin_intranda_step_mixedocr.xml
+```
+
+Die erste Datei enthält das eigentliche Plugin. Die zweite Datei ist die Konfigurationsdatei des Plugins.
+
+Voraussetzung für die Verwendung des Plugins ist die korrekte Installation und Konfiguration des Plugins sowie die korrekte Einbindung des Plugins in die gewünschten Arbeitsschritte des Workflows. Zusätzlich wird noch das Plugin für die manuelle Auswahl der Seiten benötigt (`intranda_step_ocrselector`).
+
+
+## Überblick und Funktionsweise
+Nachdem das Plugin installiert und Konfiguriert wurde, muss es noch in Goobi workflow zu einem Arbeitsschritt hinzugefügt werden.
+
+![Konfiguration des Schritts in Goobi Workflow](screen1.png)
+
+Das Plugin wird üblicherweise automatisch ausgeführt, deshalb sollte der Haken bei `Automatische Aufgabe` gesetzt sein. Außerdem muss das Plugin `intranda_step_mixedocr` unter `Plugin für Arbeitsschritt` ausgewählt werden.
+
+
+# Konfiguration
+Der Inhalt de Konfigurationsdatei `plugin_intranda_step_mixedocr.xml` muss folgendermaßen aufgebaut sein:
+
+```xml
+<config_plugin>
+<!--
+        order of configuration is:
+          1.) project name and step name matches
+          2.) step name matches and project is *
+          3.) project name matches and step name is *
+          4.) project name and step name are *
+-->
+    <config>
+        <!-- which projects to use for (can be more then one, otherwise use *) -->
+        <project>*</project>
+        <step>*</step>
+
+        <template>template.xml</template>
+        <itmUrl>http://localhost:8080/itm/service</itmUrl>
+        <!--  this must be without a trailing slash -->
+        <callbackBaseUrl>http://localhost:8080/goobi</callbackBaseUrl>
+        <useOrigDir>false</useOrigDir>
+        <serverType>intranda-tesseract</serverType>
+    </config>
+
+    <config>
+        <!-- which projects to use for (can be more then one, otherwise use *) -->
+        <project>My special project</project>
+        <project>Archive_Project</project>
+        <step>OCR</step>
+
+        <template>template_pdfonly.xml</template>
+        <itmUrl>https://itm.mydomain.tld/itm/service</itmUrl>
+        <callbackBaseUrl>https://goobi.mydomain.tld/goobi</callbackBaseUrl>
+        <useOrigDir>true</useOrigDir>
+        <serverType>intranda-tesseract</serverType>
+    </config>
+```
+
+Es sind mehrere Konfigurationen für verschiedene Projekte und Schitte möglich. Diese werden per `<project>` und `<step>` festgelegt. Es ist auch die Wildcard `*` möglich, die für alle Schritte bzw. Projekte greift. Die eigentliche Konfiguration findet dann innerhalb der `<config>` Elemente statt.
+
+Das `<template>` ist das Template, das der TaskManager benutzen soll, die `<itmUrl>` ist die URL zum Endpoint des TaskManagers, der neue Jobs annimmt. Die `<callbackBaseUrl>` muss eine URL sein, die vom TaskManager aus erreicht werden kann und zur Goobi-Installation zeigt, in der das Plugin installiert ist. Sie wird benötigt, um den Schritt nach der erfolgreichen OCR wieder zu schließen. Das Element `<useOrigDir>` bestimmt, ob für die OCR die Masterbilder oder die Derivate genutzt werden sollen. Der Eintrag `<serverType>` ist der im intranda LizenzServer eingetragene Wert für den Server, über den die OCR durchgeführt werden soll. Dieser Wert kann bei intranda angefragt werden oder bei der Nutzung eines anderen OCR Providers ausgelassen werden.
+
+Zusätzlich zu dieser Plugin-spezifischen Konfiguration muss noch eine Freigabe in der Datei `/opt/digiverso/goobi/config/goobi_rest.xml` erfolgen, damit der TaskManager dem Plugin die erfolgreiche Abarbeitung der Jobs melden kann:
+
+```xml
+<endpoint path="/plugins/ocr.*">
+    <method name="post">
+        <allow netmask="127.0.0.0/8" token="mytoken"/>
+    </method>
+</endpoint>
+```

docs/index_en.md

@@ -0,0 +1,83 @@
+---
+title: OCR execution with mixed fonts
+identifier: intranda_step_mixedocr
+published: true
+description: This is the technical documentation for the Goobi plugin for performing OCR with mixed fonts. Images should be marked with the "OCR Page Selection" plugin.
+---
+## Introduction
+This documentation describes the installation, configuration and use of a plug-in for OCR with mixed fonts. This plugin is only useful in combination with the plugin "OCR Page Selection".
+
+
+## Installation
+The following files must be installed to use the plugin:
+
+```bash
+/opt/digiverso/goobi/plugins/step/plugin_intranda_step_mixedocr-base.jar
+/opt/digiverso/goobi/config/plugin_intranda_step_mixedocr.xml
+```
+
+The first file contains the actual plugin. The second file is the configuration file of the plugin.
+
+The precondition for using the plugin is the correct installation and configuration of the plugin as well as the correct integration of the plugin into the desired workflow steps. In addition, the plugin for the manual selection of the pages is required (`intranda_step_ocrselector`).
+
+
+## Overview and functionality
+After the plugin has been installed and configured, it must be added to a workflow step in Goobi workflow.
+
+![Configuration of the step in Goobi Workflow](screen1.png)
+
+The plugin is usually executed automatically, so you should check the box `Automatic task`. The plugin `intranda_step_mixedocr` must also be selected under `Plugin for step`.
+
+
+## Configuration
+The content of the configuration file `plugin_intranda_step_mixedocr.xml` must be structured as follows:
+
+```xml
+<config_plugin>
+<!--
+        order of configuration is:
+          1.) project name and step name matches
+          2.) step name matches and project is *
+          3.) project name matches and step name is *
+          4.) project name and step name are *
+-->
+    <config>
+        <!-- which projects to use for (can be more then one, otherwise use *) -->
+        <project>*</project>
+        <step>*</step>
+
+        <template>template.xml</template>
+        <itmUrl>http://localhost:8080/itm/service</itmUrl>
+        <!--  this must be without a trailing slash -->
+        <callbackBaseUrl>http://localhost:8080/goobi</callbackBaseUrl>
+        <useOrigDir>false</useOrigDir>
+        <serverType>intranda-tesseract</serverType>
+    </config>
+
+    <config>
+        <!-- which projects to use for (can be more then one, otherwise use *) -->
+        <project>My special project</project>
+        <project>Archive_Project</project>
+        <step>OCR</step>
+
+        <template>template_pdfonly.xml</template>
+        <itmUrl>https://itm.mydomain.tld/itm/service</itmUrl>
+        <callbackBaseUrl>https://goobi.mydomain.tld/goobi</callbackBaseUrl>
+        <useOrigDir>true</useOrigDir>
+        <serverType>intranda-tesseract</serverType>
+    </config>
+```
+
+Several configurations for different projects and sections are possible. These are defined by `project` and `step`. It is also possible to use the wildcard `*` for all steps and projects. The actual configuration then takes place within the `config` elements.
+
+The `template` is the template that the TaskManager should use, the `itmUrl` is the URL to the endpoint of the TaskManager that accepts new jobs. The `callbackBaseUrl` must be a URL that can be reached from the TaskManager and points to the Goobi installation where the plugin is installed. It is needed to close the step after successful OCR. The element `useOrigDir` determines whether the master images or the derivatives should be used for the OCR. The entry `serverType` is the value entered in the intranda license server for the server that is to be used for the OCR. This value can be requested from intranda or omitted when using another OCR provider.
+
+In addition to this plugin-specific configuration, the file `/opt/digiverso/goobi/config/goobi_rest.xml` must be released so that the TaskManager can report the successful processing of the jobs to the plugin:
+
+```xml
+<endpoint path="/plugins/ocr.*">
+    <method name="post">
+        <allow netmask="127.0.0.0/8" token="mytoken"/>
+    </method>
+</endpoint>
+```