-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request 'Release v24.07' (#11) from release_24.07 into master
- Loading branch information
Showing
10 changed files
with
128 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
<config_plugin> | ||
<config> | ||
<project>*</project> | ||
<step>*</step> | ||
|
||
<imageFolder>master</imageFolder> | ||
<imageFolder>media</imageFolder> | ||
</config> | ||
</config_plugin> | ||
``` | ||
|
||
Der Block `<config>` 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 `<config>` gelten soll. Verwendet wird hierbei der Name des Projektes. Dieser Parameter kann mehrfach pro `<config>` Block vorkommen. | | ||
| `step` | Dieser Parameter steuert, für welche Arbeitsschritte der Block `<config>` gelten soll. Verwendet wird hier der Name des Arbeitsschritts. Dieser Parameter kann mehrfach pro `<config>` 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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
<config_plugin> | ||
<config> | ||
<project>*</project> | ||
<step>*</step> | ||
|
||
<imageFolder>master</imageFolder> | ||
<imageFolder>media</imageFolder> | ||
</config> | ||
</config_plugin> | ||
``` | ||
|
||
The block `<config>` 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 `<config>` should apply. The name of the project is used here. This parameter can occur several times per `<config>` block. | | ||
| `step` | This parameter controls for which work steps the block `<config>` should apply. The name of the work step is used here. This parameter can occur several times per `<config>` 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) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters