diff --git a/README.md b/README.md index 011e2a9..fd7024d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Plugin for Goobi workflow -Step plugin for Goobi workflow to replace placeholder images with real images inside of the master folder. +This Step plugin for Goobi workflow offers a user interface that can be used to replace placeholder images within the master and the media folder. Drag and Drop are possible to be used for multiple images. This is a plugin for Goobi workflow, the open source workflow tracking software for digitisation projects. More information about Goobi workflow is available under https://goobi.io. If you want to get in touch with the user community simply go to https://community.goobi.io. @@ -10,31 +10,30 @@ This is a plugin for Goobi workflow, the open source workflow tracking software More information about the functionality of this plugin and the complete documentation can be found in the central documentation area at https://docs.goobi.io -Detail | Description ---- | --- +Detail | Description +--------------------------- | ---------------------- **Plugin identifier** | intranda_step_replace-images -**Plugin type** | Step plugin -**Licence** | GPL 2.0 or newer -**Documentation (German)** | https://docs.goobi.io/goobi-workflow-plugins-de/step/intranda_step_replace-images -**Documentation (English)** | https://docs.goobi.io/goobi-workflow-plugins-en/step/intranda_step_replace-images +**Plugin type** | step +**Licence** | GPL 2.0 or newer +**Documentation (German)** | https://docs.goobi.io/workflow-plugins/v/eng/step/goobi-plugin-step-replace-images +**Documentation (English)** | https://docs.goobi.io/workflow-plugins/v/ger/step/goobi-plugin-step-replace-images ## Goobi details Goobi workflow is an open source web application to manage small and large digitisation projects mostly in cultural heritage institutions all around the world. More information about Goobi can be found here: -Detail | Description ---- | --- -**Goobi web site** | https://www.goobi.io -**Twitter** | https://twitter.com/goobi -**Goobi community** | https://community.goobi.io +Detail | Description +--------------------------- | --------------------------- +**Goobi web site** | https://www.goobi.io +**Goobi community** | https://community.goobi.io +**Goobi documentation** | https://docs.goobi.io ## Development This plugin was developed by intranda. If you have any issues, feedback, question or if you are looking for more information about Goobi workflow, Goobi viewer and all our other developments that are used in digitisation projects please get in touch with us. -Contact | Details ---- | --- -**Company name** | intranda GmbH -**Address** | Bertha-von-Suttner-Str. 9, 37085 Göttingen, Germany -**Web site** | https://www.intranda.com -**Twitter** | https://twitter.com/intranda +Contact | Details +--------------------------- | ---------------------------------------------------- +**Company name** | intranda GmbH +**Address** | Bertha-von-Suttner-Str. 9, 37085 Göttingen, Germany +**Web site** | https://www.intranda.com diff --git a/docs/index_de.md b/docs/index_de.md new file mode 100644 index 0000000..26b332e --- /dev/null +++ b/docs/index_de.md @@ -0,0 +1,54 @@ +--- +title: Ersetzen von Bildern +identifier: intranda_step_replace-images +published: true +description: Dieses Step Plugin für Goobi workflow dient zum Ersetzen von Platzhalterbildern innerhalb des Master-Ordners. +--- +## Einführung +Dieses Plugin dient zum Ersetzen von zuvor eingespielten Platzhalterbildern innerhalb des Master-Ordners eines Vorgangs von Goobi workflow durch die tatsächlichen Master-Bilder. Die Bedienung des Plugins erfolgt über einfaches Drag & Drop der gewünschten Dateien in die Nutzeroberfläche des Plugins. + + +## Installation +Dieses Plugin wird als `tar`-Archiv ausgeliefert. Um es zu installieren, muss das Archiv `plugin-intranda-step-replace-images.tar` in den Goobi-Ordner entpackt werden: + +```bash +tar -C /opt/digiverso/goobi/ -xf plugin-intranda-step-replace-images.tar --exclude="pom.xml" +``` + +Dieses Plugin verfügt ausserdem über eine Konfigurationsdatei mit dem Namen `plugin_intranda_step_replace-images.xml`. Sie muss unter folgendem Pfad abgelegt werden: + +```bash +/opt/digiverso/goobi/config/plugin_intranda_step_replace-images.xml +``` + +Die Konfigurationsdatei hat dabei den folgenden Aufbau: + +```xml + + + * + * + + master + media + + +``` + +Der Block `` kann für verschiedene Projekte oder Arbeitsschritte wiederholt vorkommen, um innerhalb verschiedener Workflows unterschiedliche Aktionen durchführen zu können. Die weiteren Parameter innerhalb dieser Konfigurationsdatei haben folgende Bedeutungen: + +| Wert | Beschreibung | +| :--- | :--- | +| `project` | Dieser Parameter legt fest, für welches Projekt der aktuelle Block `` gelten soll. Verwendet wird hierbei der Name des Projektes. Dieser Parameter kann mehrfach pro `` Block vorkommen. | +| `step` | Dieser Parameter steuert, für welche Arbeitsschritte der Block `` gelten soll. Verwendet wird hier der Name des Arbeitsschritts. Dieser Parameter kann mehrfach pro `` Block vorkommen. | +| `imagefolder` | Mit diesem Parameter wird das Verzeichnis angegeben, für das ein Ersetzen von Bildern möglich sein soll. Dieser Parameter ist wiederholbar. Mögliche Werte hierfür sind z.B. `master`, `media` oder auch individuelle Ordner wie `photos` und `scans`. | + + +## Überblick und Funktionsweise +Dieses Plugin wird in den Workflow so integriert, dass es für eine ausgewählte Aufgabe zur Verfügung steht. Nach dem Annehmen der Aufgabe, kann der Nutzer das Plugin betreten. + +![Integration des Plugins in eine Aufgabe](screen1_de.png) + +Somit erhält der Nutzer Zugriff auf die Nutzeroberfläche des Plugins, wo ihm der derzeitige Inhalt des Master-Ordners aufgelistet wird. Hier können nun gezielt einzelne oder auch viele Bilder per Drag & Drop an diejenige Stelle kopiert werden, ab der die einzufügenden Bilder die vorhandenen Platzhalterbilder ersetzen sollen. Das Plugin stellt während des Uploads zugleich sicher, dass die neu hochgeladenen Dateien korrekt umbenannt werden. + +![Nutzeroberfläche zum Ersetzen der vorhandenen Platzhalterbilder](screen2_de.png) diff --git a/docs/index_en.md b/docs/index_en.md new file mode 100644 index 0000000..d966002 --- /dev/null +++ b/docs/index_en.md @@ -0,0 +1,54 @@ +--- +title: Replace images +identifier: intranda_step_replace-images +published: true +description: This step plugin for Goobi workflow is used to replace placeholder images within the master folder. +--- +## Introduction +This plugin is used to replace previously imported placeholder images within the master folder of a Goobi workflow process with the actual master images. The plugin is operated by simply dragging and dropping the required files into the plugin's user interface. + + +## Installation +This plugin is delivered as a `tar` archive. To install it, unpack the `plugin_intranda_step_replace-images.tar` archive into the Goobi folder: + +```bash +tar -C /opt/digiverso/goobi/ -xf plugin-intranda-step-replace-images.tar --exclude="pom.xml" +``` + +This plug-in also has a configuration file with the name `plugin_intranda_step_replace-images.xml`. It must be stored under the following path: + +```bash +/opt/digiverso/goobi/config/plugin_intranda_step_replace-images.xml +``` + +The configuration file has the following structure: + +```xml + + + * + * + + master + media + + +``` + +The block `` can occur repeatedly for different projects or work steps in order to be able to perform different actions within different workflows. The other parameters within this configuration file have the following meanings: + +| Value | Description | +| :--- | :--- | +| `project` | This parameter determines for which project the current block `` should apply. The name of the project is used here. This parameter can occur several times per `` block. | +| `step` | This parameter controls for which work steps the block `` should apply. The name of the work step is used here. This parameter can occur several times per `` block. | +| `imagefolder` | This parameter specifies the directory for which a replacement of images should be possible. This parameter is repeatable. Possible values for this are e.g. `master`, `media` or also individual folders such as `photos` and `scans`. | + + +## Overview and functionality +This plugin is integrated into the workflow so that it is available for a selected task. After accepting the task, the user can enter the plugin. + +![Integration of the plugin into a task](screen1_en.png) + +This gives the user access to the plugin's user interface, where the current content of the master folder is listed. Here, single or many images can be copied by Drag & Drop to the place where the images to be inserted should replace the existing placeholder images. The plugin also ensures during the upload that the newly uploaded files are renamed correctly. + +![User interface to replace the existing placeholder images](screen2_en.png) diff --git a/docs/screen1_de.png b/docs/screen1_de.png new file mode 100644 index 0000000..6eb4a7f Binary files /dev/null and b/docs/screen1_de.png differ diff --git a/docs/screen1_en.png b/docs/screen1_en.png new file mode 100644 index 0000000..eebda3f Binary files /dev/null and b/docs/screen1_en.png differ diff --git a/docs/screen2_de.png b/docs/screen2_de.png new file mode 100644 index 0000000..1ae51b1 Binary files /dev/null and b/docs/screen2_de.png differ diff --git a/docs/screen2_en.png b/docs/screen2_en.png new file mode 100644 index 0000000..4290856 Binary files /dev/null and b/docs/screen2_en.png differ diff --git a/module-base/pom.xml b/module-base/pom.xml index 80d2709..ba18034 100644 --- a/module-base/pom.xml +++ b/module-base/pom.xml @@ -3,7 +3,7 @@ io.goobi.workflow.plugin plugin-step-replace-images - 24.06 + 24.07 plugin-step-replace-images-base jar diff --git a/module-gui/pom.xml b/module-gui/pom.xml index 3da2bf9..5115b74 100644 --- a/module-gui/pom.xml +++ b/module-gui/pom.xml @@ -3,7 +3,7 @@ io.goobi.workflow.plugin plugin-step-replace-images - 24.06 + 24.07 plugin-step-replace-images-gui jar diff --git a/pom.xml b/pom.xml index 2708fb4..01425ab 100644 --- a/pom.xml +++ b/pom.xml @@ -3,7 +3,7 @@ io.goobi.workflow workflow-base - 24.06 + 24.07 io.goobi.workflow.plugin