From 27f7d00b21319bb1a129ec71df814475d2a3f030 Mon Sep 17 00:00:00 2001 From: Steffen Hankiewicz Date: Thu, 25 Jul 2024 11:56:35 +0200 Subject: [PATCH] added docs --- docs/index_de.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++ docs/index_en.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++ docs/screen1.png | Bin 0 -> 108020 bytes 3 files changed, 166 insertions(+) create mode 100644 docs/index_de.md create mode 100644 docs/index_en.md create mode 100644 docs/screen1.png diff --git a/docs/index_de.md b/docs/index_de.md new file mode 100644 index 0000000..f62093c --- /dev/null +++ b/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 + + + + + * + * + + + http://localhost:8080/itm/service + + http://localhost:8080/goobi + false + intranda-tesseract + + + + + My special project + Archive_Project + OCR + + + https://itm.mydomain.tld/itm/service + https://goobi.mydomain.tld/goobi + true + intranda-tesseract + +``` + +Es sind mehrere Konfigurationen für verschiedene Projekte und Schitte möglich. Diese werden per `` und `` festgelegt. Es ist auch die Wildcard `*` möglich, die für alle Schritte bzw. Projekte greift. Die eigentliche Konfiguration findet dann innerhalb der `` Elemente statt. + +Das `