added docs

intranda · Jul 25, 2024 · 0ca94bf · 0ca94bf
1 parent d804209
commit 0ca94bf
Show file tree

Hide file tree

Showing 15 changed files with 146 additions and 0 deletions.
diff --git a/docs/index_de.md b/docs/index_de.md
@@ -0,0 +1,73 @@
+---
+title: Regelsatzeditor
+identifier: intranda_administration_ruleset_editor
+description: Dies ist ein Administration Plugin für Goobi workflow. Es ermöglicht die Bearbeitung von Ruleset-Dateien direkt aus der Benutzeroberfläche.
+published: true
+---
+## Einführung
+Dieses Plugin dient zur direkten Bearbeitung der Regelsatzdateien von Goobi workflow direkt aus der Benutzeroberfläche innerhalb des Webbrowsers.
+
+
+## Installation
+Das Plugin besteht insgesamt aus den folgenden zu installierenden Dateien:
+
+```bash
+plugin-intranda-administration-ruleset-editor-base.jar
+plugin-intranda-administration-ruleset-editor-gui.jar
+plugin_intranda_administration_ruleset_editor.xml
+```
+
+Diese Dateien müssen in den richtigen Verzeichnissen installiert werden, so dass diese nach der Installation unter den folgenden Pfaden vorliegen:
+
+```bash
+/opt/digiverso/goobi/plugins/administration/plugin-intranda-administration-ruleset-editor-base.jar
+/opt/digiverso/goobi/plugins/GUI/plugin-intranda-administration-ruleset-editor-gui.jar
+/opt/digiverso/goobi/config/plugin_intranda_administration_ruleset_editor.xml
+```
+
+Dieses Plugin verfügt über eine eigene Berechtigungsstufe für die Verwendung. Aus diesem Grund müssen Nutzer über die erforderlichen Rechte verfügen.
+
+![Kein Zugriff ohne korrekte Rechte](screen1_de.png)
+
+Bitte weisen Sie daher der Benutzergruppe der entsprechenden Nutzer das folgende Recht zu:
+
+```
+Plugin_administration_ruleset_editor
+```
+
+![Korrekt zugewiesenes Recht für die Nutzer](screen2_de.png)
+
+
+## Überblick und Funktionsweise
+Nach der Installation ist das Plugin in einem eigenen Eintrag im Menü `Administration` zu finden, von wo es geöffnet werden kann.
+
+![Geöffnetes Plugin ohne geladene Datei](screen3_de.png)
+
+Nach dem Öffnen werden auf der linken Seite alle Regelsätze von Goobi aufgelistet. Diese kann man durch Anklicken des jeweiligen Icons öffnen, um sie zu bearbeiten.
+
+![Geöffnetes Plugin mit geladener Datei](screen4_de.png)
+
+Öffnet man eine Datei, erscheint auf der rechten Seite ein Texteditor, in dem die Datei bearbeitet werden kann. Bearbeitet und speichert man eine Datei, wird im definierten Backupverzeichnis automatisch ein Backup angelegt.
+
+![Gespeicherte Datei](screen5_de.png)
+
+Entsprechend des eingestellten Wertes in der Konfigurationsdatei bleibt hier eine gewisse Anzahl an älteren Backups erhalten, bevor diese durch neuere ersetzt werden.
+
+![Dateien innerhalb des Backup-Verzeichnisses](screen7.png)
+
+Wurde eine Datei verändert und wird ohne zuvor zu speichern ein Wechsel zu einer anderen Datei versucht, bekommt der Beareiter eine Rückfrage, wie mit den Änderungen zu verfahren ist.
+
+![Nachfrage bei ungespeicherten Daten](screen6_de.png)
+
+
+## Konfiguration
+Die Konfiguration des Plugins erfolgt über die Konfigurationsdatei `plugin_intranda_administration_ruleset_editor.xml` und kann im laufenden Betrieb angepasst werden. Im folgenden ist eine beispielhafte Konfigurationsdatei aufgeführt:
+
+{{CONFIG_CONTENT}}
+
+Die Parameter innerhalb dieser Konfigurationsdatei haben folgende Bedeutungen:
+
+Parameter           |  Erläuterung
+------------------- | -----------------------------------------------------
+`rulesetBackupDirectory`   | Hiermit wird der Pfad für die Backup-Dateien festgelegt, wo nach dem Bearbeiten die Backups der Regelsatzdateien gespeichert werden sollen.
+`numberOfBackupFiles`         | Dieser ganzzahlige Wert gibt an, wie viele Backup-Dateien pro Regelsatzdatei gespeichert bleiben, bevor sie durch neue Backups überschrieben werden.
diff --git a/docs/index_en.md b/docs/index_en.md
@@ -0,0 +1,73 @@
+---
+title: Ruleset editor
+identifier: intranda_administration_ruleset_editor
+description: This is an Administration Plugin for Goobi workflow. It allows to edit ruleset xml files directly from the user interface.
+published: true
+---
+## Introduction
+This plugin is used to directly edit the ruleset files of Goobi workflow directly from the user interface within the web browser.
+
+
+## Installation
+The plugin consists in total of the following files to be installed:
+
+```bash
+plugin_intranda_administration_ruleset_editor-base.jar
+plugin_intranda_administration_ruleset_editor-gui.jar
+plugin_intranda_administration_ruleset_editor.xml
+```
+
+These files must be installed in the correct directories so that they are available under the following paths after installation:
+
+```bash
+/opt/digiverso/goobi/plugins/administration/plugin_intranda_administration_ruleset_editor-base.jar
+/opt/digiverso/goobi/plugins/GUI/plugin_intranda_administration_ruleset_editor-gui.jar
+/opt/digiverso/goobi/config/plugin_intranda_administration_ruleset_editor.xml
+```
+
+This plugin has its own permission level for use. For this reason, users must have the necessary rights.
+
+![No access without correct rights](screen1_en.png)
+
+Therefore, please assign the following right to the user group of the corresponding users:
+
+```
+Plugin_administration_ruleset_editor
+```
+
+![Correctly assigned right for the users](screen2_en.png)
+
+
+## Overview and functionality
+After installation, the plugin can be found in its own entry in the `Administration` menu, from where it can be opened.
+
+![Open plugin without loaded file](screen3_en.png)
+
+After opening, all Goobi ruleset files are listed on the left-hand side. These can be opened by clicking on the respective icon in order to edit them.
+
+![Open plugin with loaded file](screen4_en.png)
+
+If you open a file, a text editor appears on the right-hand side in which the file can be edited. If you edit and save a file, a backup is automatically created in the defined backup directory.
+
+![Saved file](screen5_en.png)
+
+According to the value set in the configuration file, a certain number of older backups are retained here before they are replaced by newer ones.
+
+![Files within the backup directory](screen7.png)
+
+If a file has been changed and an attempt is made to change to another file without saving it, the operator is asked how to proceed with the changes.
+
+![Demand for unsaved data](screen6_en.png)
+
+
+## Configuration
+The plugin is configured via the configuration file `plugin_intranda_administration_ruleset_editor.xml` and can be adapted during operation. The following is an example configuration file:
+
+{{CONFIG_CONTENT}}
+
+The parameters within this configuration file have the following meanings:
+
+Parameter           |  Description
+------------------- | -----------------------------------------------------
+`rulesetBackupDirectory`   | This sets the path for the backup files where the backups of the ruleset files are to be saved after editing.
+`numberOfBackupFiles`         | This integer value specifies how many backup files remain stored per ruleset file before they are overwritten by new backups.
diff --git a/docs/screen1_de.png b/docs/screen1_de.png
diff --git a/docs/screen1_en.png b/docs/screen1_en.png
diff --git a/docs/screen2_de.png b/docs/screen2_de.png
diff --git a/docs/screen2_en.png b/docs/screen2_en.png
diff --git a/docs/screen3_de.png b/docs/screen3_de.png
diff --git a/docs/screen3_en.png b/docs/screen3_en.png
diff --git a/docs/screen4_de.png b/docs/screen4_de.png
diff --git a/docs/screen4_en.png b/docs/screen4_en.png
diff --git a/docs/screen5_de.png b/docs/screen5_de.png
diff --git a/docs/screen5_en.png b/docs/screen5_en.png
diff --git a/docs/screen6_de.png b/docs/screen6_de.png
diff --git a/docs/screen6_en.png b/docs/screen6_en.png
diff --git a/docs/screen7.png b/docs/screen7.png